serialization | @tokilabs/lang

Index

Enumerations

TransformationType

Interfaces

Type aliases

TransformFn

Functions

Type aliases

TransformFn

TransformFn: (value: any, obj: any, transformationType: CT.TransformationType) => any

Type declaration

- (value: any, obj: any, transformationType: CT.TransformationType): any
- Parameters
  - value: any
  - obj: any
  - transformationType: CT.TransformationType
  Returns any

Functions

Class

Class(typeFunction?: (type?: CT.TypeOptions) => Function): (target: any, key: string | symbol, parameterIndex?: number) => void

- Defined in src/serialization/decorators.ts:20
Class Decorator

Specifies the class of a property.

decorator

Parameters
- Optional typeFunction: (type?: CT.TypeOptions) => Function
  - - (type?: CT.TypeOptions): Function
    - Parameters
      - Optional type: CT.TypeOptions
      Returns Function
Returns (target: any, key: string | symbol, parameterIndex?: number) => void
- - (target: any, key: string | symbol, parameterIndex?: number): void
  - Parameters
    - target: any
    - key: string | symbol
    - Optional parameterIndex: number
    Returns void

Classify

Classify(transformFn: TransformFn, options?: ITransformOptions): (target: any, key: string) => void

- Defined in src/serialization/decorators.ts:38
Defines custom transformation logic when converting from a primitive to a class

Parameters
- transformFn: TransformFn
  
  The function used to perform the transformation
- Optional options: ITransformOptions
  
  Transformation options
Returns (target: any, key: string) => void
- - (target: any, key: string): void
  - Parameters
    - target: any
    - key: string
    Returns void

Exclude

Exclude(options?: IExcludeOptions): (object: Object | Function, propertyName?: string) => void

- Defined in src/serialization/decorators.ts:78
Marks property as excluded from the process of transformation. By default it excludes the property for both constructorToPlain and plainToConstructor transformations, however you can specify on which of transformation types you want to skip this property.

Parameters
- Optional options: IExcludeOptions
Returns (object: Object | Function, propertyName?: string) => void
- - (object: Object | Function, propertyName?: string): void
  - Parameters
    - object: Object | Function
    - Optional propertyName: string
    Returns void

Expose

Expose(options?: IExposeOptions): (object: Object | Function, propertyName?: string) => void

- Defined in src/serialization/decorators.ts:67
Marks property as included in the process of transformation. By default it includes the property for both constructorToPlain and plainToConstructor transformations, however you can specify on which of transformation types you want to skip this property.

Parameters
- Optional options: IExposeOptions
Returns (object: Object | Function, propertyName?: string) => void
- - (object: Object | Function, propertyName?: string): void
  - Parameters
    - object: Object | Function
    - Optional propertyName: string
    Returns void

Primitify

Primitify(transformFn: TransformFn, options?: ITransformOptions): (target: any, key: string) => void

- Defined in src/serialization/decorators.ts:53
Defines custom transformation logic when converting from a primitive to a class

Parameters
- transformFn: TransformFn
  
  The function used to perform the transformation
- Optional options: ITransformOptions
  
  Transformation options
Returns (target: any, key: string) => void
- - (target: any, key: string): void
  - Parameters
    - target: any
    - key: string
    Returns void

SerializeOptions

SerializeOptions(options?: ITransformationOptions): Function

- Defined in src/serialization/decorators.ts:7
Transform the object from class to plain object and return only with the exposed properties.

Parameters
- Optional options: ITransformationOptions
Returns Function

TransformClassToPlain

TransformClassToPlain(params?: ITransformationOptions): Function

- Defined in src/serialization/decorators.ts:87
Transform the object from class to plain object and return only with the exposed properties.

Parameters
- Optional params: ITransformationOptions
Returns Function

classify

classify<TClass>(cls: Constructor<TClass>, plain: Object, options?: ITransformationOptions): TClass
classify<TClass>(cls: Constructor<TClass>, plain: Object[], options?: ITransformationOptions): TClass[]

- Defined in src/serialization/functions.ts:105
Converts an ordinary object and it's properties to instances of their respective classes

Type parameters
- TClass
Parameters
- cls: Constructor<TClass>
- plain: Object
- Optional options: ITransformationOptions
  
  Transformation options
Returns TClass
- Defined in src/serialization/functions.ts:110
Type parameters
- TClass
Parameters
- cls: Constructor<TClass>
- plain: Object[]
- Optional options: ITransformationOptions
Returns TClass[]

deserialize

deserialize<TClass>(cls: Constructor<TClass>, json: string, options?: ITransformationOptions): TClass
deserialize<TClass>(cls: Constructor<TClass>, json: object[], options?: ITransformationOptions): TClass[]
deserialize<TClass>(cls: Constructor<TClass>, json: object, options?: ITransformationOptions): TClass

- Defined in src/serialization/functions.ts:55
Deserializes given JSON string or primitive object to an object or an array of objects of the given class.

Type parameters
- TClass
Parameters
- cls: Constructor<TClass>
- json: string
- Optional options: ITransformationOptions
Returns TClass
- Defined in src/serialization/functions.ts:60
Type parameters
- TClass
Parameters
- cls: Constructor<TClass>
- json: object[]
- Optional options: ITransformationOptions
Returns TClass[]
- Defined in src/serialization/functions.ts:65
Type parameters
- TClass
Parameters
- cls: Constructor<TClass>
- json: object
- Optional options: ITransformationOptions
Returns TClass

deserializeArray

deserializeArray<TClass>(cls: Constructor<TClass>, json: string, options?: ITransformationOptions): TClass[]

- Defined in src/serialization/functions.ts:44
Deserializes given JSON string to an array of objects of the given class.

Type parameters
- TClass
Parameters
- cls: Constructor<TClass>
- json: string
- Optional options: ITransformationOptions
Returns TClass[]

hydrate

hydrate<TClass>(instance: TClass, objects: Object, options?: ITransformationOptions): TClass
hydrate<TClass>(instances: TClass[], objects: Object[], options?: ITransformationOptions): TClass[]

- Defined in src/serialization/functions.ts:130
Hydrates an existing class instance with data from a plain object

Type parameters
- TClass
Parameters
- instance: TClass
  
  An instance to fill
- objects: Object
  
  An object to get the data from
- Optional options: ITransformationOptions
  
  Transformation options
Returns TClass
- Defined in src/serialization/functions.ts:143
Hydrates many existing instances with data from plain objects

Type parameters
- TClass
Parameters
- instances: TClass[]
  
  An array of instances to fill
- objects: Object[]
  
  An array of plain objects to get the data from
- Optional options: ITransformationOptions
  
  Transformation options
Returns TClass[]

hydratePrimitive

hydratePrimitive<TClass>(instance: TClass, object: Object, options?: ITransformationOptions): Object
hydratePrimitive<TClass>(instances: TClass[], objects: Object[], options?: ITransformationOptions): Object[]

- Defined in src/serialization/functions.ts:163
Hydrates an existing plain object with data from a class instance

Type parameters
- TClass
Parameters
- instance: TClass
  
  An instance to get the data from
- object: Object
  
  An object to fill
- Optional options: ITransformationOptions
  
  Transformation options
Returns Object
- Defined in src/serialization/functions.ts:176
Hydrates an existing plain object with data from a class instance

Type parameters
- TClass
Parameters
- instances: TClass[]
  
  An array of instances to get the data from
- objects: Object[]
  
  An array of objects to fill
- Optional options: ITransformationOptions
  
  Transformation options
Returns Object[]

primitify

primitify<TClass>(instance: TClass, options?: ITransformationOptions): Object

- Defined in src/serialization/functions.ts:92
Converts a class instance to a plain javascript object

Type parameters
- TClass
Parameters
- instance: TClass
  
  An instance of T
- Optional options: ITransformationOptions
  
  Transformation options
Returns Object

serialize

serialize<TClass>(instance: TClass, options?: ITransformationOptions): string
serialize<TClass>(instances: TClass[], options?: ITransformationOptions): string

- Defined in src/serialization/functions.ts:19
Serializes given instance to a JSON string.

Type parameters
- TClass
Parameters
- instance: TClass
  
  The instance to be serialized
- Optional options: ITransformationOptions
  
  Transformation options
Returns string
- Defined in src/serialization/functions.ts:30
Serializes an array of instances to a JSON string.

Type parameters
- TClass
Parameters
- instances: TClass[]
  
  The instances to be serialized
- Optional options: ITransformationOptions
  
  Transformation options
Returns string

Generated using TypeDoc

Index

Enumerations

Interfaces

Type aliases

Functions

Type aliases

TransformFn

Type declaration

Parameters

value: any

obj: any

transformationType: CT.TransformationType

Returns any

Functions

Class

Class Decorator

Parameters

Optional typeFunction: (type?: CT.TypeOptions) => Function

Parameters

Optional type: CT.TypeOptions

Returns Function

Returns (target: any, key: string | symbol, parameterIndex?: number) => void

Parameters

target: any

key: string | symbol

Optional parameterIndex: number

Returns void

Classify

Parameters

transformFn: TransformFn

Optional options: ITransformOptions

Returns (target: any, key: string) => void

Parameters

target: any

key: string

Returns void

Exclude

Parameters

Optional options: IExcludeOptions

Returns (object: Object | Function, propertyName?: string) => void

Parameters

object: Object | Function

Optional propertyName: string

Returns void

Expose

Parameters

Optional options: IExposeOptions

Returns (object: Object | Function, propertyName?: string) => void

Parameters

object: Object | Function

Optional propertyName: string

Returns void

Primitify

Parameters

transformFn: TransformFn

Optional options: ITransformOptions

Returns (target: any, key: string) => void

Parameters

target: any

key: string

Returns void

SerializeOptions

Parameters

Optional options: ITransformationOptions

Returns Function

TransformClassToPlain

Parameters

Optional params: ITransformationOptions

Returns Function

classify

Type parameters

TClass

Parameters

cls: Constructor<TClass>

plain: Object

Optional options: ITransformationOptions

Returns TClass

Type parameters

TClass

Parameters