serialization-generator

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

InsteadArrayBuffer

InsteadArrayBuffer<Structure, Keys>: {}

Type parameters

Structure: object
Keys: StringKeys<Structure>

Type declaration

SerializerType

SerializerType<V>: V extends ValueSerializer<any> ? V["TYPE_PINPOINT"] : never

Type parameters

Variables

Const ARRAY_BUFFER_SERIALIZER

ARRAY_BUFFER_SERIALIZER: ArrayBufferSerializer = new ArrayBufferSerializer()

Const FLOAT32_SERIALIZER

FLOAT32_SERIALIZER: FloatSerializer = new FloatSerializer(4)

Const FLOAT64_SERIALIZER

FLOAT64_SERIALIZER: FloatSerializer = new FloatSerializer(8)

Const INT16_SERIALIZER

INT16_SERIALIZER: IntSerializer = new IntSerializer(2, false)

Const INT32_SERIALIZER

INT32_SERIALIZER: IntSerializer = new IntSerializer(4, false)

Const INT8_SERIALIZER

INT8_SERIALIZER: IntSerializer = new IntSerializer(1, false)

Const STRING_SERIALIZER

STRING_SERIALIZER: StringSerializer<object> = new StringSerializer()

Const UINT16_SERIALIZER

UINT16_SERIALIZER: IntSerializer = new IntSerializer(2, true)

Const UINT32_SERIALIZER

UINT32_SERIALIZER: IntSerializer = new IntSerializer(4, true)

Const UINT8_SERIALIZER

UINT8_SERIALIZER: IntSerializer = new IntSerializer(1, true)

Functions

Const DEFAULT_INSTANCE_CREATOR

DEFAULT_INSTANCE_CREATOR<S>(): S

- Defined in serializer/object-partial-serializer.ts:10
Type parameters
- S: object
Returns S

Const combineObjectSerializer

combineObjectSerializer<K>(...os: ObjectSerializer<K>[]): ObjectSerializer<K>

- Defined in serializer/object-serializer.ts:32
Can be used to combine multiple object serializers to one.

Type parameters
- K: object
Parameters
- Rest ...os: ObjectSerializer<K>[]
Returns ObjectSerializer<K>

createTransformSerializer

createTransformSerializer<Origin, Base>(fromOriginToBase: (val: Origin) => Base, fromBaseToOrigin: (val: Base) => Origin, baseSerializer: ValueSerializer<Base>, typeCheck?: undefined | ((val: Origin, name: string) => never | void)): TransformSerializer<Origin, Base>

- Defined in create-transform-serializer.ts:13
This function create a TransformSerializer with the provided mapper. Please have a look at the respective methods and their documentation there.

Type parameters
- Origin
- Base
Parameters
- fromOriginToBase: (val: Origin) => Base
  
  A function which works the same as TransformSerializer.fromOriginToBase.
  - - (val: Origin): Base
    - Parameters
      - val: Origin
      Returns Base
- fromBaseToOrigin: (val: Base) => Origin
  
  A function which works the same as TransformSerializer.fromBaseToOrigin.
  - - (val: Base): Origin
    - Parameters
      - val: Base
      Returns Origin
- baseSerializer: ValueSerializer<Base>
  
  A serializer which can serialize the Base type.
- Optional typeCheck: undefined | ((val: Origin, name: string) => never | void)
  
  A function which works the same as TransformSerializer.originTypeCheck.
Returns TransformSerializer<Origin, Base>

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

InsteadArrayBuffer

Type parameters

Structure: object

Keys: StringKeys<Structure>

Type declaration

SerializerType

Type parameters

V

Variables

Const ARRAY_BUFFER_SERIALIZER

Const FLOAT32_SERIALIZER

Const FLOAT64_SERIALIZER

Const INT16_SERIALIZER

Const INT32_SERIALIZER

Const INT8_SERIALIZER

Const STRING_SERIALIZER

Const UINT16_SERIALIZER

Const UINT32_SERIALIZER

Const UINT8_SERIALIZER

Functions

Const DEFAULT_INSTANCE_CREATOR

Type parameters

S: object

Returns S

Const combineObjectSerializer

Type parameters

K: object

Parameters

Rest ...os: ObjectSerializer<K>[]

Returns ObjectSerializer<K>

createTransformSerializer

Type parameters

Origin

Base

Parameters

fromOriginToBase: (val: Origin) => Base

Parameters

val: Origin

Returns Base

fromBaseToOrigin: (val: Base) => Origin

Parameters

val: Base

Returns Origin

baseSerializer: ValueSerializer<Base>

Optional typeCheck: undefined | ((val: Origin, name: string) => never | void)

Returns TransformSerializer<Origin, Base>