Base

Exports related to media.

Classes

ClientMediaClass

Extends MediaClass. Extended by ClientVisibleMediaClass and ClientRawMediaClass. Implements ClientAsset.

new ClientMediaClass(object): ClientMediaClass

Parameter	Type	Description
`object`	`StorableMedia`

Returns ClientMediaClass. Inherited from MediaClass.constructor.

Property	Modifier	Type
`asData`	`public readonly`	`StorableMedia`
`decodings`	`public readonly`	`Decoding`[]
`hasIntrinsicSizing`	`public`	`undefined` \| `boolean`
`hasIntrinsicTiming`	`public`	`undefined` \| `boolean`
`id`	`public`	`string`
`mediaIds`	`public readonly`	`string`[]
`projectId`	`public`	`undefined` \| `string`
`properties`	`public`	`Property`[]
`resources`	`public`	`Resource`[]
`saveNeeded`	`public readonly`	`boolean`
`source`	`public`	`string`
`targetId`	`public`	`string`
`type`	`public`	`MediaType`
`unsavedResources`	`public readonly`	`Resource`[]

Methods

addResource(resource): void

Parameter	Type	Description
`resource`	`Resource`

Returns void. Implementation of ClientAsset.addResource.

assetCachePromise(args): Promise<DataOrError<number>>

Parameter	Type	Description
`args`	`AssetCacheArgs`

Returns Promise<DataOrError<number>>. Implementation of ClientAsset.assetCachePromise, Inherited from MediaClass.assetCachePromise.

assetFiles(args): AssetFile[]

Parameter	Type	Description
`args`	`CacheArgs`

Returns AssetFile[]. Implementation of ClientAsset.assetFiles, Inherited from MediaClass.assetFiles.

assetIcon(size, cover?, patch?): Promise<DataOrError<SVGSVGElement>>

Parameter	Type	Description
`size`	`Size`<`number`>
`cover`?	`boolean`
`patch`?	`Element`

Returns Promise<DataOrError<SVGSVGElement>>. Implementation of ClientAsset.assetIcon.

assetIconPromise(resource, options, cover?, patch?): Promise<DataOrError<SVGImageElement>>

Parameter	Type	Description
`resource`	`Resource`
`options`	`Size`<`number`> \| `Rect`<`number`>
`cover`?	`boolean`
`patch`?	`Element`

Returns Promise<DataOrError<SVGImageElement>>. Implementation of ClientAsset.assetIconPromise.

boolean(key): boolean

Parameter	Type	Description
`key`	`string`

Returns boolean. Implementation of ClientAsset.boolean, Inherited from MediaClass.boolean.

changeObject(signalId, scalar?): ChangeEditObject

Parameter	Type	Description
`signalId`	`${string}.${string}`
`scalar`?	`Scalar`

Returns ChangeEditObject. Implementation of ClientAsset.changeObject, Inherited from MediaClass.changeObject.

changeScalars(scalars): void

Parameter	Type	Description
`scalars`	`Partial`<`SignalScalarRecord`>

Returns void. Implementation of ClientAsset.changeScalars, Inherited from MediaClass.changeScalars.

changesObject(scalars): ChangePropertiesEditObject

Parameter	Type	Description
`scalars`	`Partial`<`SignalScalarRecord`>

Returns ChangePropertiesEditObject. Implementation of ClientAsset.changesObject, Inherited from MediaClass.changesObject.

clipObject(object?): ClipObject

Parameter	Type	Description
`object`?	`InstanceObject`

Returns ClipObject. Implementation of ClientAsset.clipObject, Inherited from MediaClass.clipObject.

commandFilePromise(args, commandFile): Promise<DataOrError<number>>

Parameter	Type	Description
`args`	`ServerPromiseArgs`
`commandFile`	`CommandFile`

Returns Promise<DataOrError<number>>. Implementation of ClientAsset.commandFilePromise, Inherited from MediaClass.commandFilePromise.

constrainedValue(property, value?): undefined | Scalar

Parameter	Type	Description
`property`	`Property`
`value`?	`Scalar`

Returns undefined | Scalar. Implementation of ClientAsset.constrainedValue, Inherited from MediaClass.constrainedValue.

decodingOfType(…types): undefined | Decoding

Parameter	Type	Description
…`types`	`string`[]

Returns undefined | Decoding. Inherited from MediaClass.decodingOfType.

findResource(…typesOrSources): undefined | Resource

Parameter	Type	Description
…`typesOrSources`	`string`[]

Returns undefined | Resource. Implementation of ClientAsset.findResource, Inherited from MediaClass.findResource.

imagePromise(resource): Promise<DataOrError<ClientImage>>

Parameter	Type	Description
`resource`	`Resource`

Returns Promise<DataOrError<ClientImage>>. Implementation of ClientAsset.imagePromise.

instanceArgs(object?): InstanceArgs

Parameter	Type	Description
`object`?	`InstanceObject`

Returns InstanceArgs. Implementation of ClientAsset.instanceArgs, Inherited from MediaClass.instanceArgs.

instanceFromObject(object?): Instance

Parameter	Type	Description
`object`?	`InstanceObject`

Returns Instance. Implementation of ClientAsset.instanceFromObject, Inherited from MediaClass.instanceFromObject.

number(id): number

Parameter	Type	Description
`id`	`string`

Returns number. Implementation of ClientAsset.number, Inherited from MediaClass.number.

propertiesOfTarget(targetId): Property[]

Parameter	Type	Description
`targetId`	`string`

Returns Property[]. Implementation of ClientAsset.propertiesOfTarget, Inherited from MediaClass.propertiesOfTarget.

propertyFind(name): undefined | Property

Parameter	Type	Description
`name`	`string`

Returns undefined | Property. Implementation of ClientAsset.propertyFind, Inherited from MediaClass.propertyFind.

propertyIds(targetId): `${string}.${string}`[]

Parameter	Type	Description
`targetId`	`string`

Returns `${string}.${string}`[]. Implementation of ClientAsset.propertyIds, Inherited from MediaClass.propertyIds.

savePromise(progress?): Promise<DataOrError<string>>

Parameter	Type	Description
`progress`?	`ServerProgress`

Returns Promise<DataOrError<string>>. Implementation of ClientAsset.savePromise.

scalarsRecord(idOrNames): ScalarRecord

Parameter	Type	Description
`idOrNames`	`string`[]

Returns ScalarRecord. Implementation of ClientAsset.scalarsRecord, Inherited from MediaClass.scalarsRecord.

setValue(id, value?, dontConstrain?): void

Parameter	Type	Description
`id`	`string`
`value`?	`Scalar`
`dontConstrain`?	`boolean`

Returns void. Implementation of ClientAsset.setValue, Inherited from MediaClass.setValue.

shouldSelectProperty(property): boolean

Parameter	Type	Description
`property`	`Property`

Returns boolean. Implementation of ClientAsset.shouldSelectProperty, Inherited from MediaClass.shouldSelectProperty.

string(id): string

Parameter	Type	Description
`id`	`string`

Returns string if the value is a string, otherwise throws an assertion error. Implementation of ClientAsset.string, Inherited from MediaClass.string.

toJSON(): UnknownRecord

Returns UnknownRecord. Implementation of ClientAsset.toJSON, Inherited from MediaClass.toJSON.

tweenValues(key, time, range): Scalar[]

Parameter	Type	Description
`key`	`string`
`time`	`Time`
`range`	`TimeRange`

Returns Scalar[]. Implementation of ClientAsset.tweenValues, Inherited from MediaClass.tweenValues.

tweens(key): boolean

Parameter	Type	Description
`key`	`string`

Returns boolean. Implementation of ClientAsset.tweens, Inherited from MediaClass.tweens.

tweensProperty(key): boolean

Parameter	Type	Description
`key`	`string`

Returns boolean. Inherited from MediaClass.tweensProperty.

unload(): void

Returns void. Implementation of ClientAsset.unload.

value(id): undefined | Scalar

Parameter	Type	Description
`id`	`string`

Returns undefined | Scalar. Implementation of ClientAsset.value, Inherited from MediaClass.value.

MediaClass

Extends PropertiedClass. Extended by ClientMediaClass and RawMediaClass. Implements Media.

new MediaClass(object): MediaClass

Parameter	Type	Description
`object`	`StorableMedia`

Returns MediaClass. Overrides PropertiedClass.constructor.

Property	Modifier	Type
`asData`	`public readonly`	`StorableMedia`
`decodings`	`public readonly`	`Decoding`[]
`hasIntrinsicSizing`	`public`	`undefined` \| `boolean`
`hasIntrinsicTiming`	`public`	`undefined` \| `boolean`
`id`	`public`	`string`
`mediaIds`	`public readonly`	`string`[]
`projectId`	`public`	`undefined` \| `string`
`properties`	`public`	`Property`[]
`resources`	`public`	`Resource`[]
`source`	`public`	`string`
`targetId`	`public`	`string`
`type`	`public`	`MediaType`

Methods

assetCachePromise(args): Promise<DataOrError<number>>

Parameter	Type	Description
`args`	`AssetCacheArgs`

Returns Promise<DataOrError<number>>. Implementation of Media.assetCachePromise.

assetFiles(args): AssetFile[]

Parameter	Type	Description
`args`	`CacheArgs`

Returns AssetFile[]. Implementation of Media.assetFiles.

boolean(key): boolean

Parameter	Type	Description
`key`	`string`

Returns boolean. Implementation of Media.boolean, Inherited from PropertiedClass.boolean.

changeObject(signalId, scalar?): ChangeEditObject

Parameter	Type	Description
`signalId`	`${string}.${string}`
`scalar`?	`Scalar`

Returns ChangeEditObject. Implementation of Media.changeObject, Inherited from PropertiedClass.changeObject.

changeScalars(scalars): void

Parameter	Type	Description
`scalars`	`Partial`<`SignalScalarRecord`>

Returns void. Implementation of Media.changeScalars, Inherited from PropertiedClass.changeScalars.

changesObject(scalars): ChangePropertiesEditObject

Parameter	Type	Description
`scalars`	`Partial`<`SignalScalarRecord`>

Returns ChangePropertiesEditObject. Implementation of Media.changesObject, Inherited from PropertiedClass.changesObject.

clipObject(object?): ClipObject

Parameter	Type	Description
`object`?	`InstanceObject`

Returns ClipObject. Implementation of Media.clipObject.

commandFilePromise(args, commandFile): Promise<DataOrError<number>>

Parameter	Type	Description
`args`	`ServerPromiseArgs`
`commandFile`	`CommandFile`

Returns Promise<DataOrError<number>>. Implementation of Media.commandFilePromise.

constrainedValue(property, value?): undefined | Scalar

Parameter	Type	Description
`property`	`Property`
`value`?	`Scalar`

Returns undefined | Scalar. Implementation of Media.constrainedValue, Inherited from PropertiedClass.constrainedValue.

decodingOfType(…types): undefined | Decoding

Parameter	Type	Description
…`types`	`string`[]

Returns undefined | Decoding.

findResource(…typesOrSources): undefined | Resource

Parameter	Type	Description
…`typesOrSources`	`string`[]

Returns undefined | Resource. Implementation of Media.findResource.

instanceArgs(object?): InstanceArgs

Parameter	Type	Description
`object`?	`InstanceObject`

Returns InstanceArgs. Implementation of Media.instanceArgs.

instanceFromObject(object?): Instance

Parameter	Type	Description
`object`?	`InstanceObject`

Returns Instance. Implementation of Media.instanceFromObject.

number(id): number

Parameter	Type	Description
`id`	`string`

Returns number. Implementation of Media.number, Inherited from PropertiedClass.number.

propertiesOfTarget(targetId): Property[]

Parameter	Type	Description
`targetId`	`string`

Returns Property[]. Implementation of Media.propertiesOfTarget, Inherited from PropertiedClass.propertiesOfTarget.

propertyFind(name): undefined | Property

Parameter	Type	Description
`name`	`string`

Returns undefined | Property. Implementation of Media.propertyFind, Inherited from PropertiedClass.propertyFind.

propertyIds(targetId): `${string}.${string}`[]

Parameter	Type	Description
`targetId`	`string`

Returns `${string}.${string}`[]. Implementation of Media.propertyIds, Inherited from PropertiedClass.propertyIds.

scalarsRecord(idOrNames): ScalarRecord

Parameter	Type	Description
`idOrNames`	`string`[]

Returns ScalarRecord. Implementation of Media.scalarsRecord, Inherited from PropertiedClass.scalarsRecord.

setValue(id, value?, dontConstrain?): void

Parameter	Type	Description
`id`	`string`
`value`?	`Scalar`
`dontConstrain`?	`boolean`

Returns void. Implementation of Media.setValue, Inherited from PropertiedClass.setValue.

shouldSelectProperty(property): boolean

Parameter	Type	Description
`property`	`Property`

Returns boolean. Implementation of Media.shouldSelectProperty, Inherited from PropertiedClass.shouldSelectProperty.

string(id): string

Parameter	Type	Description
`id`	`string`

Returns string if the value is a string, otherwise throws an assertion error. Implementation of Media.string, Inherited from PropertiedClass.string.

toJSON(): UnknownRecord

Returns UnknownRecord. Implementation of Media.toJSON, Inherited from PropertiedClass.toJSON.

tweenValues(key, time, range): Scalar[]

Parameter	Type	Description
`key`	`string`
`time`	`Time`
`range`	`TimeRange`

Returns Scalar[]. Implementation of Media.tweenValues, Inherited from PropertiedClass.tweenValues.

tweens(key): boolean

Parameter	Type	Description
`key`	`string`

Returns boolean. Implementation of Media.tweens, Inherited from PropertiedClass.tweens.

tweensProperty(key): boolean

Parameter	Type	Description
`key`	`string`

Returns boolean. Inherited from PropertiedClass.tweensProperty.

value(id): undefined | Scalar

Parameter	Type	Description
`id`	`string`

Returns undefined | Scalar. Implementation of Media.value, Inherited from PropertiedClass.value.

PropertiedClass

Extended by MediaClass, InstanceClass, ClipClass, and TrackClass. Implements Propertied.

new PropertiedClass(object): PropertiedClass

Parameter	Type	Description
`object`	`object`

Returns PropertiedClass.

Property	Modifier	Type
`id`	`public`	`string`
`properties`	`public`	`Property`[]
`targetId`	`public`	`string`

Methods

boolean(key): boolean

Parameter	Type	Description
`key`	`string`

Returns boolean. Implementation of Propertied.boolean.

changeObject(signalId, scalar?): ChangeEditObject

Parameter	Type	Description
`signalId`	`${string}.${string}`
`scalar`?	`Scalar`

Returns ChangeEditObject. Implementation of Propertied.changeObject.

changeScalars(scalars): void

Parameter	Type	Description
`scalars`	`Partial`<`SignalScalarRecord`>

Returns void. Implementation of Propertied.changeScalars.

changesObject(scalars): ChangePropertiesEditObject

Parameter	Type	Description
`scalars`	`Partial`<`SignalScalarRecord`>

Returns ChangePropertiesEditObject. Implementation of Propertied.changesObject.

constrainedValue(property, value?): undefined | Scalar

Parameter	Type	Description
`property`	`Property`
`value`?	`Scalar`

Returns undefined | Scalar. Implementation of Propertied.constrainedValue.

number(id): number

Parameter	Type	Description
`id`	`string`

Returns number. Implementation of Propertied.number.

propertiesOfTarget(targetId): Property[]

Parameter	Type	Description
`targetId`	`string`

Returns Property[]. Implementation of Propertied.propertiesOfTarget.

propertyFind(name): undefined | Property

Parameter	Type	Description
`name`	`string`

Returns undefined | Property. Implementation of Propertied.propertyFind.

propertyIds(targetId): `${string}.${string}`[]

Parameter	Type	Description
`targetId`	`string`

Returns `${string}.${string}`[]. Implementation of Propertied.propertyIds.

scalarsRecord(idOrNames): ScalarRecord

Parameter	Type	Description
`idOrNames`	`string`[]

Returns ScalarRecord. Implementation of Propertied.scalarsRecord.

setValue(id, value?, dontConstrain?): void

Parameter	Type	Description
`id`	`string`
`value`?	`Scalar`
`dontConstrain`?	`boolean`

Returns void. Implementation of Propertied.setValue.

shouldSelectProperty(property): boolean

Parameter	Type	Description
`property`	`Property`

Returns boolean. Implementation of Propertied.shouldSelectProperty.

string(id): string

Parameter	Type	Description
`id`	`string`

Returns string if the value is a string, otherwise throws an assertion error. Implementation of Propertied.string.

toJSON(): UnknownRecord

Returns UnknownRecord. Implementation of Propertied.toJSON.

tweenValues(key, time, range): Scalar[]

Parameter	Type	Description
`key`	`string`
`time`	`Time`
`range`	`TimeRange`

Returns Scalar[]. Implementation of Propertied.tweenValues.

tweens(key): boolean

Parameter	Type	Description
`key`	`string`

Returns boolean. Implementation of Propertied.tweens.

tweensProperty(key): boolean

Parameter	Type	Description
`key`	`string`

Returns boolean.

value(id): undefined | Scalar

Parameter	Type	Description
`id`	`string`

Returns undefined | Scalar. Implementation of Propertied.value.

Interfaces

Propertied

Extended by Media, Instance, Clip, and Track.

Property	Type
`id`	`string`
`properties`	`Property`[]
`targetId`	`string`

Methods

boolean(key): boolean

Parameter	Type
`key`	`string`

Returns boolean.

changeObject(propertyId, scalar?): ChangeEditObject

Parameter	Type
`propertyId`	`${string}.${string}`
`scalar`?	`Scalar`

Returns ChangeEditObject.

changeScalars(scalars): void

Parameter	Type
`scalars`	`Partial`<`SignalScalarRecord`>

Returns void.

changesObject(scalars): ChangePropertiesEditObject

Parameter	Type
`scalars`	`Partial`<`SignalScalarRecord`>

Returns ChangePropertiesEditObject.

constrainedValue(found, value?): undefined | Scalar

Parameter	Type
`found`	`Property`
`value`?	`Scalar`

Returns undefined | Scalar.

number(key): number

Parameter	Type
`key`	`string`

Returns number.

propertiesOfTarget(targetId): Property[]

Parameter	Type
`targetId`	`string`

Returns Property[].

propertyFind(name): undefined | Property

Parameter	Type
`name`	`string`

Returns undefined | Property.

propertyIds(targetId): `${string}.${string}`[]

Parameter	Type
`targetId`	`string`

Returns `${string}.${string}`[].

scalarsRecord(idOrNames): ScalarRecord

Parameter	Type
`idOrNames`	`string`[]

Returns ScalarRecord.

setValue(nameOrId, scalar?, dontConstrain?): void

Parameter	Type
`nameOrId`	`string`
`scalar`?	`Scalar`
`dontConstrain`?	`boolean`

Returns void.

shouldSelectProperty(property): boolean

Parameter	Type
`property`	`Property`

Returns boolean.

string(key): string

Parameter	Type
`key`	`string`

Returns string.

toJSON(): UnknownRecord

Returns UnknownRecord.

tweenValues(key, time, range): Scalar[]

Parameter	Type
`key`	`string`
`time`	`Time`
`range`	`TimeRange`

Returns Scalar[].

tweens(key): boolean

Parameter	Type
`key`	`string`

Returns boolean.

value(key): undefined | Scalar

Parameter	Type
`key`	`string`

Returns undefined | Scalar.

PropertiedChangeHandler

PropertiedChangeHandler(property, value?): void

Parameter	Type
`property`	`string`
`value`?	`Scalar`

Returns void.

Property

Extends PropertyObject. Extended by ScalarProperty and Control.

Property	Type
`fallback?`	`Scalar`
`frame?`	`number`
`icon?`	`string`
`max?`	`number`
`min?`	`number`
`name`	`string`
`options?`	`ScalarRecord` \| `Scalar`[]
`order?`	`number`
`step?`	`number`
`target`	`string`
`tweens?`	`boolean`
`type`	`string`
`undoable?`	`boolean`

PropertyObject

Extended by Property.

Property	Type
`fallback?`	`Scalar`
`frame?`	`number`
`icon?`	`string`
`max?`	`number`
`min?`	`number`
`name?`	`string`
`options?`	`ScalarRecord` \| `Scalar`[]
`order?`	`number`
`step?`	`number`
`target?`	`string`
`tweens?`	`boolean`
`type?`	`string`
`undoable?`	`boolean`

ScalarProperty

Extends Property.

Property	Type
`fallback?`	`Scalar`
`frame?`	`number`
`icon?`	`string`
`max?`	`number`
`min?`	`number`
`name`	`string`
`options?`	`ScalarRecord` \| `Scalar`[]
`order?`	`number`
`scalar?`	`Scalar`
`step?`	`number`
`target`	`string`
`tweens?`	`boolean`
`type`	`string`
`undoable?`	`boolean`

Storable

Extended by Media and Resource

Extends Typed.Sourced.Labeled.Partial<Identified>. Extended by StorableMedia, Stored, and StorableResource.

Property	Type
`createdAt?`	`string`
`id?`	`string`
`label?`	`string`
`projectId?`	`string`
`source`	`string`
`type`	`string`
`updatedAt?`	`string`

StorableMash

A plain object representation of MashMedia.

Extends StorableMedia.MashProperties. Extended by StorableMashVideo, StorableMashAudio, and StorableMashImage.

Property	Type
`assets?`	`StorableMedia`[]
`buffer?`	`number`
`createdAt?`	`string`
`id?`	`string`
`label?`	`string`
`projectId?`	`string`
`resources?`	`StorableResource`[]
`source`	`string`
`tracks?`	`TrackObject`[]
`type`	`MediaType`
`updatedAt?`	`string`

StorableMedia

Extends Storable.StringIndexable. Extended by StorableColorImage, MashVideoArgs, StorableMash, MashArgs, StorableRawAudio, StoredRawVideo, StorableRawVideo, StorableRawImage, StorableShapeImage, and StorableTextImage.

Property	Type
`createdAt?`	`string`
`id?`	`string`
`label?`	`string`
`projectId?`	`string`
`resources?`	`StorableResource`[]
`source`	`string`
`type`	`MediaType`
`updatedAt?`	`string`

Stored

Extends Storable. Extended by Media and StoredMedia.

Property	Type
`createdAt?`	`string`
`id`	`string`
`label?`	`string`
`projectId?`	`string`
`source`	`string`
`type`	`string`
`updatedAt?`	`string`

StoredMash

Extends StoredMedia.MashProperties.

Property	Type
`assets?`	`StoredMedia`[]
`buffer?`	`number`
`createdAt?`	`string`
`id`	`string`
`label?`	`string`
`projectId?`	`string`
`resources?`	`StoredResource`[]
`source`	`string`
`tracks?`	`TrackObject`[]
`type`	`MediaType`
`updatedAt?`	`string`

StoredMedia

Extends Stored. Extended by StoredColorImage, StoredMashVideo, StoredMashAudio, StoredMashImage, StoredMash, StoredAudio, VideoData, StoredRawImage, StoredShapeImage, and StoredTextImage.

Property	Type
`createdAt?`	`string`
`id`	`string`
`label?`	`string`
`projectId?`	`string`
`resources?`	`StoredResource`[]
`source`	`string`
`type`	`MediaType`
`updatedAt?`	`string`

Type Aliases

MathProperty

MathProperty: string & keyof Math

ResourceProperty

ResourceProperty: "uploadedAt"

StorableMediaResult<TYPE, SRC>

StorableMediaResult<TYPE, SRC>: SRC extends _raw ? TYPE extends _audio ? StorableRawAudio : TYPE extends _image ? StorableRawImage : TYPE extends _video ? StorableRawVideo : StorableMedia : SRC extends _text ? TYPE extends _image ? StorableTextImage : StorableMedia : SRC extends _color ? TYPE extends _image ? StorableColorImage : StorableMedia : SRC extends _shape ? TYPE extends _image ? StorableShapeImage : StorableMedia : SRC extends _mash ? TYPE extends _video ? StorableMashVideo : TYPE extends _image ? StorableMashImage : TYPE extends _audio ? StorableMashAudio : StorableMedia : StorableMedia

Type Parameter	Default type
`TYPE`	`string`
`SRC`	`string`

StoredMediaResult<TYPE, SRC>

StoredMediaResult<TYPE, SRC>: SRC extends _raw ? TYPE extends _audio ? StoredRawAudio : TYPE extends _image ? StoredRawImage : TYPE extends _video ? StoredRawVideo : StoredMedia : SRC extends _text ? TYPE extends _image ? StoredTextImage : StoredMedia : SRC extends _color ? TYPE extends _image ? StoredColorImage : StoredMedia : SRC extends _shape ? TYPE extends _image ? StoredShapeImage : StoredMedia : SRC extends _mash ? TYPE extends _video ? StoredMashVideo : TYPE extends _image ? StoredMashImage : TYPE extends _audio ? StoredMashAudio : StoredMedia : StoredMedia

Type Parameter	Default type
`TYPE`	`string`
`SRC`	`string`

Functions

isPropertied

isPropertied(value?): value is Propertied

Parameter	Type	Description
`value`?	`any`

Returns value is Propertied.

isStorable

isStorable(value): value is Storable

Parameter	Type
`value`	`any`

Returns value is Storable.

isStorableMash

isStorableMash(value): value is StorableMash

Parameter	Type
`value`	`any`

Returns value is StorableMash.

isStorableMedia

isStorableMedia<RAW, SRC>(value, type?, source?): value is StorableMediaResult<RAW, SRC>

Type Parameter
`RAW` extends `string`
`SRC` extends `string`

Parameter	Type
`value`	`any`
`type`?	`RAW`
`source`?	`SRC`

Returns value is StorableMediaResult<RAW, SRC>.

isStored

isStored(value): value is Stored

Parameter	Type
`value`	`any`

Returns value is Stored.

isStoredMash

isStoredMash(value): value is StoredMash

Parameter	Type
`value`	`any`

Returns value is StoredMash.

isStoredMedia

isStoredMedia<RAW, SRC>(value, type?, source?): value is StoredMediaResult<RAW, SRC>

Type Parameter
`RAW` extends `string`
`SRC` extends `string`

Parameter	Type
`value`	`any`
`type`?	`RAW`
`source`?	`SRC`

Returns value is StoredMediaResult<RAW, SRC>.

parsePropertyObject

parsePropertyObject(arg, owner?): PropertyObject

Parameter	Type
`arg`	`string` \| `PropertyObject`
`owner`?	`string`

Returns PropertyObject.

propertyInstance

propertyInstance(arg, owner?, typeDefault?): Property

Parameter	Type
`arg`	`string` \| `PropertyObject`
`owner`?	`string`
`typeDefault`?	`string`

Returns Property.

propertyScalar

propertyScalar<T>(property, scalar?, forCss?): T extends true ? string : Scalar | undefined

Type Parameter
`T` extends `boolean`

Parameter	Type
`property`	`Property`
`scalar`?	`Scalar`
`forCss`?	`T`

Returns T extends true ? string : Scalar | undefined.

propertyTypeCoerce

propertyTypeCoerce<T>(value, type, forCss?): T extends true ? string : Scalar | undefined

Type Parameter
`T` extends `boolean`

Parameter	Type
`value`	`Scalar`
`type`	`string`
`forCss`?	`T`

Returns T extends true ? string : Scalar | undefined.

propertyTypeValid

propertyTypeValid(value, dataType): boolean

Parameter	Type
`value`	`Scalar`
`dataType`	`string`

Returns boolean.

signalPropertyId

signalPropertyId(arg, nameOrTarget?, type?): SignalId

Parameter	Type
`arg`	`string` \| `PropertyObject`
`nameOrTarget`?	`string`
`type`?	`string`

Returns SignalId.