Class DataSerializerUtils

Data serializer utilities for managing the ORM mapping

Hierarchy

DataSerializerUtils

Index

Constructors

Accessors

Methods

ensureTypeDescriptor getIdentifierMemberOptions getMemberOptions getMetadata getOwnMetadata getRootMetadata

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` ensureTypeDescriptor

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

`Static` getIdentifierMemberOptions

getIdentifierMemberOptions<T>(dataType: Constructor<T>): SerializableMemberOptions
Get member options of an identifier property in a data type

Returns
identifier member options
Type Parameters
- T
Parameters
- dataType: Constructor<T>
  
  Data type
Returns SerializableMemberOptions
- Defined in src/data/DataSerializerUtils.ts:80

`Static` getMemberOptions

getMemberOptions<T>(dataType: Constructor<T>, propertyKey: string): SerializableMemberOptions
Get member options of a property in a data type

Returns
member options
Type Parameters
- T
Parameters
- dataType: Constructor<T>
  
  Data type
- propertyKey: string
  
  Property key
Returns SerializableMemberOptions
- Defined in src/data/DataSerializerUtils.ts:62

`Static` getMetadata

getMetadata(proto: any): ObjectMetadata
Get the TypedJSON metadata

See
https://gist.github.com/krizka/c83fb1966dd57997a1fc02625719387d

Returns
Root object metadata
Parameters
- proto: any
  
  Prototype of target
Returns ObjectMetadata
- Defined in src/data/DataSerializerUtils.ts:32

`Static` getOwnMetadata

getOwnMetadata(proto: any): ObjectMetadata
Get the own TypedJSON metadata of the prototype

See
https://gist.github.com/krizka/c83fb1966dd57997a1fc02625719387d

Returns
Root object metadata
Parameters
- proto: any
  
  Prototype of target
Returns ObjectMetadata
- Defined in src/data/DataSerializerUtils.ts:21

`Static` getRootMetadata

getRootMetadata(proto: any): ObjectMetadata
Get the root TypedJSON metadata

See
https://gist.github.com/krizka/c83fb1966dd57997a1fc02625719387d

Returns
Root object metadata
Parameters
- proto: any
  
  Prototype of target
Returns ObjectMetadata
- Defined in src/data/DataSerializerUtils.ts:43