Class SArrayWithWrapper<ValueT>`Abstract`

SArray variant that wraps each element for serialization / deserialization.

Type Parameters

ValueT

Hierarchy (view full)

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.

`Readonly` `Abstract` wrapperType

wrapperType: (new () => SerializableWrapper<ValueT>)

Wrapper type constructor.

Type declaration

- new (): SerializableWrapper<ValueT>
- Returns SerializableWrapper<ValueT>

Methods

assignJSON

assignJSON(jsonValues): 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:246

deserialize

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

getSerializedLength

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

serialize

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

toJSON

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

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:264

`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 SerializableWrapper.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
Inherited from SerializableWrapper.of
- Defined in src/serializable-wrapper.ts:17

`Static` ofJSON

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