Class SerializableWrapper<ValueT>`Abstract`

Serializable implementation that simply wraps another value.

Type Parameters

ValueT

Hierarchy (view full)

Serializable
- SerializableWrapper

Index

Constructors

Properties

Methods

assignJSON deserialize getSerializedLength serialize toJSON from of

Constructors

constructor

new SerializableWrapper<ValueT>(): SerializableWrapper<ValueT>
Type Parameters
- ValueT
Returns SerializableWrapper<ValueT>
Inherited from Serializable.constructor

Properties

`Abstract` value

value: ValueT

Methods

assignJSON

assignJSON<JsonValueT>(jsonValue): void
Type Parameters
- JsonValueT
Parameters
- jsonValue: JsonValueT
Returns void
- Defined in src/serializable-wrapper.ts:12

`Abstract` deserialize

deserialize(buffer, opts?): number
Deserializes a buffer into this value.
Parameters
- buffer: Buffer
- Optional opts: DeserializeOptions
Returns number
Number of bytes read.
Inherited from Serializable.deserialize
- Defined in src/serializable.ts:30

`Abstract` getSerializedLength

getSerializedLength(opts?): number
Computes the serialized length of this value.
Parameters
- Optional opts: SerializeOptions
Returns number
Inherited from Serializable.getSerializedLength
- Defined in src/serializable.ts:34

`Abstract` serialize

serialize(opts?): Buffer
Serializes this value into a buffer.
Parameters
- Optional opts: SerializeOptions
Returns Buffer
Inherited from Serializable.serialize
- Defined in src/serializable.ts:32

toJSON

toJSON(): any
Returns any
- Defined in src/serializable-wrapper.ts:8

`Static` from

from<T>(this, buffer, opts?): T
Creates a new instance of this value by deserializing from a buffer.
Type Parameters
- T extends Serializable
Parameters
- this: (new () => T)
  - - new (): T
    - Returns T
- buffer: Buffer
- Optional opts: DeserializeOptions
Returns T
Inherited from Serializable.from
- Defined in src/serializable.ts:37

`Static` of

of<ValueT, WrapperT>(this, value): WrapperT
Create a new instance of this wrapper class from a raw value.
Type Parameters
- ValueT
- WrapperT extends SerializableWrapper<ValueT>
Parameters
- this: (new () => WrapperT)
  - - new (): WrapperT
    - Returns WrapperT
- value: ValueT
Returns WrapperT
- Defined in src/serializable-wrapper.ts:17