Class TypeEncoderMap

Contain a set of mappings from an object constructor to a matching TypeEncoder.

Index

Constructors

Methods

clear delete get registerEncoder

Constructors

constructor

new TypeEncoderMap(): TypeEncoderMap
Returns TypeEncoderMap

Methods

clear

clear(): void
Remove all classes from the map.

Returns void
- Defined in typeEncoderMap.ts:79

delete

delete<T extends AbstractClassType<T>>(typ: T): boolean
Delete the encoder for a given class.
Type Parameters
- T extends AbstractClassType<T>
Parameters
- typ: T
  Constructor function.
Returns boolean
true if class found and deleted, otherwise false.
- Defined in typeEncoderMap.ts:72

get

get<T extends AbstractClassType<T>>(
typ: T,
): undefined | TypeEncoder<InstanceType<T>>
Get the encoder for a given class.
Type Parameters
- T extends AbstractClassType<T>
Parameters
- typ: T
  Constructor function.
Returns undefined | TypeEncoder<InstanceType<T>>
Encoder, or undefined if none specified.
- Defined in typeEncoderMap.ts:60

registerEncoder

registerEncoder<T extends AbstractClassType<T>>(
typ: T,
encoder: TypeEncoder<InstanceType<T>>,
): undefined | TypeEncoder<T>
Register an encoder for a given type.
Type Parameters
- T extends AbstractClassType<T>
Parameters
- typ: T
  The class to encode. This is the function for the constructor of objects of this type. For example, Uint8Array the value of the constructor property of a Uint8Array instance.
- encoder: TypeEncoder<InstanceType<T>>
  The function to use for encoding this type.
Returns undefined | TypeEncoder<T>
Previous registration, or undefined if none.
- Defined in typeEncoderMap.ts:45