Class DataSerializer

Allows the serialization and deserialization of objects using the SerializableObject decorator.

Usage

Registration

Objects are registered upon loading with the SerializableObject decorator. Manual registration is possible using:

DataSerializer.registerType(MyObjectClass);

Index

Constructors

constructor

new DataSerializer(): DataSerializer
Returns DataSerializer

Properties

`Static` `Protected` `Readonly` deserializer

deserializer: Deserializer = ...

`Static` `Protected` eventEmitter

eventEmitter: EventEmitter<DefaultEventMap> = ...

`Static` `Protected` `Readonly` knownTypes

knownTypes: Map<string, Serializable<any>> = ...

`Static` `Protected` `Readonly` serializer

serializer: Serializer = ...

Methods

`Static` clone

clone<T, D>(object, dataType?): D
Clone a serializable object
Type Parameters
- T
- D = T
Parameters
- object: T
  Serializable object
- Optional dataType: Constructor<D>
  Data type to clone to
Returns D
Cloned object
- Defined in src/data/DataSerializer.ts:221

`Static` deserialize

deserialize<T>(serializedData, dataType?, config?): T
Deserialize data
Type Parameters
- T
Parameters
- serializedData: any
  Data to deserialze
- Optional dataType: Constructor<T>
  Optional data type to specify deserialization type
- Optional config: DataSerializerConfig
  Data serializer configuration
Returns T
- Defined in src/data/DataSerializer.ts:260
deserialize<T>(serializedData, dataType?, config?): T[]
Type Parameters
- T
Parameters
- serializedData: any[]
- Optional dataType: Constructor<T>
- Optional config: DataSerializerConfig
Returns T[]
- Defined in src/data/DataSerializer.ts:261

`Static` findRootMetaInfo

findRootMetaInfo(proto): ObjectMetadata
Find the root TypedJSON metadata
Parameters
- proto: any
  Prototype of target
Returns ObjectMetadata
Root object metadata

Deprecated
use DataSerializerUtils.getRootMetadata
- Defined in src/data/DataSerializer.ts:198

`Static` findTypeByName

findTypeByName(name): Serializable<any>
Parameters
- name: string
Returns Serializable<any>
- Defined in src/data/DataSerializer.ts:211

`Static` getMetadata

getMetadata(proto): ObjectMetadata
Get the TypedJSON metadata
Parameters
- proto: any
  Prototype of target
Returns ObjectMetadata
Root object metadata

Deprecated
use DataSerializerUtils.getMetadata

See
https://gist.github.com/krizka/c83fb1966dd57997a1fc02625719387d
- Defined in src/data/DataSerializer.ts:177

`Static` getRootMetadata

getRootMetadata(proto): ObjectMetadata
Get the root TypedJSON metadata
Parameters
- proto: any
  Prototype of target
Returns ObjectMetadata
Root object metadata

Deprecated
use DataSerializerUtils.getRootMetadata

See
https://gist.github.com/krizka/c83fb1966dd57997a1fc02625719387d
- Defined in src/data/DataSerializer.ts:188

`Static` registerType

registerType<T>(type, converters?): void
Manually register a new type
Type Parameters
- T
Parameters
- type: Serializable<T>
  Type to register
- Optional converters: MappedTypeConverters<T>
  Optional converters
Returns void
- Defined in src/data/DataSerializer.ts:87

`Static` serialize

serialize<T>(data, config?): any
Serialize data
Type Parameters
- T
Parameters
- data: T
  Data to serialize
- Optional config: DataSerializerConfig = {}
  Data serializer configuration
Returns any
Serialized data
- Defined in src/data/DataSerializer.ts:231

`Static` unregisterType

unregisterType(type): void
Unregister a type
Parameters
- type: Serializable<any>
  Type to unregister
Returns void
- Defined in src/data/DataSerializer.ts:206

Class DataSerializer

Usage

Registration

Index

Constructors

Properties

Methods

Constructors

constructor

Returns DataSerializer

Properties

Static Protected Readonly deserializer

Static Protected eventEmitter

Static Protected Readonly knownTypes

Static Protected Readonly serializer

Methods

Static clone

Type Parameters

Parameters

Returns D

Static deserialize

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T[]

Static findRootMetaInfo

Parameters

Returns ObjectMetadata

Deprecated

Static findTypeByName

Parameters

Returns Serializable<any>

Static getMetadata

Parameters

Returns ObjectMetadata

Deprecated

See

Static getRootMetadata

Parameters

Returns ObjectMetadata

Deprecated

See

Static registerType

Type Parameters

Parameters

Returns void

Static serialize

Type Parameters

Parameters

Returns any

Static unregisterType

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Static` `Protected` `Readonly` deserializer

`Static` `Protected` eventEmitter

`Static` `Protected` `Readonly` knownTypes

`Static` `Protected` `Readonly` serializer

`Static` clone

`Static` deserialize

`Static` findRootMetaInfo

`Static` findTypeByName

`Static` getMetadata

`Static` getRootMetadata

`Static` registerType

`Static` serialize

`Static` unregisterType