JsType | @m-ld/m-ld

Runtime representation of a Javascript type that can be cast from a subject property object (a JSON-LD value).

see: JsAtomType
see: JsContainerType

Type parameters

Hierarchy

JsType
- JsAtomType
- JsContainerType

Index

Properties

Static statics

statics: Map<PropertyType<any>, Map<undefined | (StringConstructor & {}) | (BooleanConstructor & {}) | (NumberConstructor & {}) | (DateConstructor & {}) | (Uint8ArrayConstructor & {}) | (ReferenceConstructor & {}) | (VocabReferenceConstructor & {}) | (SubjectConstructor & {}), JsType<any, unknown>>> = new Map<PropertyType<any>, Map<AtomType<any> | undefined, JsType<any>>>

Accessors

type

get type(): [PropertyType<T>, undefined | (StringConstructor & {}) | (BooleanConstructor & {}) | (NumberConstructor & {}) | (DateConstructor & {}) | (Uint8ArrayConstructor & {}) | (ReferenceConstructor & {}) | (VocabReferenceConstructor & {}) | (SubjectConstructor & {})]

Returns [PropertyType<T>, undefined | (StringConstructor & {}) | (BooleanConstructor & {}) | (NumberConstructor & {}) | (DateConstructor & {}) | (Uint8ArrayConstructor & {}) | (ReferenceConstructor & {}) | (VocabReferenceConstructor & {}) | (SubjectConstructor & {})]

Raw Javascript type information

Methods

Abstract cast

cast(value: SubjectPropertyObject): ValueConstructed<T, S>

Casts a property value to this JavaScript type.

throws

TypeError if the given value does not have the correct type

Parameters
- value: SubjectPropertyObject
  
  the value to cast (as from a subject property)
Returns ValueConstructed<T, S>

Static for

for<T, S>(type: PropertyType<T>, subType?: AtomType<S>): JsType<T, S>

Obtains a static, shared type representation for the given parameters.

Type parameters
- T
- S
Parameters
- type: PropertyType<T>
  
  the atom type or container type
- Optional subType: AtomType<S>
  
  the atom type, if type is a container (else ignored)
Returns JsType<T, S>

Generated using TypeDoc. Delivered by Vercel. @m-ld/m-ld - v0.10.0 Source code licensed MIT. Privacy policy

Type parameters

T

S

Hierarchy

Index

Properties

Accessors

Methods

Properties

Static statics

Accessors

type

Returns [PropertyType<T>, undefined | (StringConstructor & {}) | (BooleanConstructor & {}) | (NumberConstructor & {}) | (DateConstructor & {}) | (Uint8ArrayConstructor & {}) | (ReferenceConstructor & {}) | (VocabReferenceConstructor & {}) | (SubjectConstructor & {})]

Methods

Abstract cast

Parameters

value: SubjectPropertyObject

Returns ValueConstructed<T, S>

Static for

Type parameters

T

S

Parameters

type: PropertyType<T>

Optional subType: AtomType<S>

Returns JsType<T, S>