Class SDynamicArray<LengthT, ValueT>`Abstract`

An array encoded as a number N followed by N elements.

Type Parameters

LengthT extends SerializableWrapper<number>
ValueT extends Serializable

Hierarchy

SerializableWrapper<ValueT[]>
- SDynamicArray

Index

Constructors

Properties

lengthType value valueType

Methods

assignJSON deserialize getSerializedLength serialize toJSON from of

Constructors

constructor

new SDynamicArray<LengthT, ValueT>(): SDynamicArray<LengthT, ValueT>
Type Parameters
- LengthT extends SerializableWrapper<number>
- ValueT extends Serializable
Returns SDynamicArray<LengthT, ValueT>
Inherited from SerializableWrapper<Array<ValueT>>.constructor

Properties

`Protected` `Abstract` `Readonly`lengthType

lengthType: (new () => LengthT)

Length type, to be provided by child classes.

Type declaration

- new (): LengthT
- Length type, to be provided by child classes.
  
  Returns LengthT

value

value: ValueT[] = []

Array of Serializables.

`Protected` `Abstract` `Readonly`valueType

valueType: (new () => ValueT)

Element type, to be provided by child classes.

Type declaration

- new (): ValueT
- Element type, to be provided by child classes.
  
  Returns ValueT

Methods

assignJSON

assignJSON<JsonValueT>(jsonValue): void
Type Parameters
- JsonValueT extends ValueT[]
Parameters
- jsonValue: JsonValueT
Returns void
Inherited from SerializableWrapper.assignJSON
- Defined in node_modules/serio/dist/serializable-wrapper.d.ts:6

deserialize

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

getSerializedLength

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

serialize

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

toJSON

toJSON(): any
Returns any
Inherited from SerializableWrapper.toJSON
- Defined in node_modules/serio/dist/serializable-wrapper.d.ts:5

`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
- Optionalopts: DeserializeOptions
Returns T
Inherited from SerializableWrapper.from
- Defined in node_modules/serio/dist/serializable.d.ts:35

`Static`of

of<ValueT, SDynamicArrayT>(this, value): SDynamicArrayT
Create a new instance of this wrapper class from a raw value.
Type Parameters
- ValueT extends Serializable
- SDynamicArrayT extends SArray<ValueT>
Parameters
- this: (new () => SDynamicArrayT)
  - - new (): SDynamicArrayT
    - Returns SDynamicArrayT
- value: ValueT[]
Returns SDynamicArrayT
Overrides SerializableWrapper.of
- Defined in src/util.ts:54
of<LengthT, ValueT>(lengthType, valueType): typeof __class
Returns an SDynamicArray class with the given length and value types.
Type Parameters
- LengthT extends SerializableWrapper<number>
- ValueT extends Serializable
Parameters
- lengthType: (new () => LengthT)
  - - new (): LengthT
    - Returns LengthT
- valueType: (new () => ValueT)
  - - new (): ValueT
    - Returns ValueT
Returns typeof __class
Overrides SerializableWrapper.of
- Defined in src/util.ts:59