Class DataSerializerUtils

Data serializer utilities for managing the ORM mapping

Index

Constructors

Accessors

Methods

createMetadata ensureTypeDescriptor getIdentifierMemberOptions getMemberOptions getMetadata getOwnMetadata getRootMetadata mergeMemberOptions updateMemberOptions updateObjectMetadata

Constructors

constructor

new DataSerializerUtils(): DataSerializerUtils
Returns DataSerializerUtils

Accessors

`Static` META_FIELD

get META_FIELD(): string
Returns string
- Defined in src/data/DataSerializerUtils.ts:10

Methods

`Static` createMetadata

createMetadata(proto): ObjectMetadata
Parameters
- proto: IndexedObject
Returns ObjectMetadata
- Defined in src/data/DataSerializerUtils.ts:34

`Static` ensureTypeDescriptor

ensureTypeDescriptor(type): TypeDescriptor
Parameters
- type: Typelike
Returns TypeDescriptor
- Defined in src/data/DataSerializerUtils.ts:84

`Static` getIdentifierMemberOptions

getIdentifierMemberOptions<T>(dataType): SerializableMemberOptions
Get member options of an identifier property in a data type
Type Parameters
- T
Parameters
- dataType: Constructor<T>
  Data type
Returns SerializableMemberOptions
identifier member options
- Defined in src/data/DataSerializerUtils.ts:111

`Static` getMemberOptions

getMemberOptions<T>(dataType, propertyKey): SerializableMemberOptions
Get member options of a property in a data type
Type Parameters
- T
Parameters
- dataType: Constructor<T>
  Data type
- propertyKey: string
  Property key
Returns SerializableMemberOptions
member options
- Defined in src/data/DataSerializerUtils.ts:94

`Static` getMetadata

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

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

`Static` getOwnMetadata

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

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

`Static` getRootMetadata

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

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

`Static` mergeMemberOptions

mergeMemberOptions(target, propertyKey, options): any
Deep merge member options
Parameters
- target: unknown
  Target object
- propertyKey: string
  Property key in target
- options: any
  Member options
Returns any
Merged objects
- Defined in src/data/DataSerializerUtils.ts:128

`Static` updateMemberOptions

updateMemberOptions(target, propertyKey, options): void
Parameters
- target: unknown
- propertyKey: string
- options: SerializableMemberOptions | IndexedObject
Returns void
- Defined in src/data/DataSerializerUtils.ts:139

`Static` updateObjectMetadata

updateObjectMetadata<T>(target, options, ownMeta, rootMeta): ObjectMetadata
Type Parameters
- T
Parameters
- target: Serializable<T>
- options: SerializableObjectOptions<T>
- ownMeta: ObjectMetadata
- rootMeta: ObjectMetadata
Returns ObjectMetadata
- Defined in src/data/DataSerializerUtils.ts:202