Class SArrayWithWrapper<ValueT>`Abstract`

SArray variant that wraps each element for serialization / deserialization.

Type Parameters

ValueT

Hierarchy (View Summary)

SerializableWrapper<ValueT[]>
- SArrayWithWrapper

Index

Constructors

Properties

length? value wrapperType

Methods

assignJSON deserialize getSerializedLength serialize toJSON toSArray from of ofJSON

Constructors

constructor

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

Properties

`Optional` `Readonly`length

length?: number

Fixed size, or undefined if dynamically sized.

value

value: ValueT[] = []

Array of unwrapped values.

`Abstract` `Readonly`wrapperType

wrapperType: new () => SerializableWrapper<ValueT>

Wrapper type constructor.

Type declaration

- new (): SerializableWrapper<ValueT>
- Wrapper type constructor.
  
  Returns SerializableWrapper<ValueT>

Methods

assignJSON

assignJSON(jsonValues: unknown[]): void
Assigns elements from a JSON array.

JSON values are processed with wrapperType.assignJSON().
Parameters
- jsonValues: unknown[]
Returns void
Overrides SerializableWrapper.assignJSON
- Defined in src/serializable-arrays.ts:248

deserialize

deserialize(buffer: Buffer, opts?: DeserializeOptions): number
Deserializes a buffer into this value.
Parameters
- buffer: Buffer
- Optionalopts: DeserializeOptions
Returns number
Number of bytes read.
Overrides SerializableWrapper.deserialize
- Defined in src/serializable-arrays.ts:220

getSerializedLength

getSerializedLength(opts?: SerializeOptions): number
Computes the serialized length of this value.
Parameters
- Optionalopts: SerializeOptions
Returns number
Overrides SerializableWrapper.getSerializedLength
- Defined in src/serializable-arrays.ts:235

serialize

serialize(opts?: SerializeOptions): Buffer
Serializes this value into a buffer.
Parameters
- Optionalopts: SerializeOptions
Returns Buffer
Overrides SerializableWrapper.serialize
- Defined in src/serializable-arrays.ts:231

toJSON

toJSON(): any
Returns any
Overrides SerializableWrapper.toJSON
- Defined in src/serializable-arrays.ts:240

toSArray

toSArray(): SArray<SerializableWrapper<ValueT>>
Constructs an SArray of wrappers around the current array of elements.

Returns SArray<SerializableWrapper<ValueT>>
- Defined in src/serializable-arrays.ts:266

`Static`from

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

`Static`of

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

`Static`ofJSON

ofJSON<ValueT, SArrayT extends SArrayWithWrapper<ValueT>>(
this: new () => SArrayT,
jsonValues: unknown[],
): SArrayT
Create a new instance of this wrapper class from a raw value.
Type Parameters
- ValueT
- SArrayT extends SArrayWithWrapper<ValueT>
Parameters
- this: new () => SArrayT
- jsonValues: unknown[]
Returns SArrayT
- Defined in src/serializable-arrays.ts:281