Class Serializable`Abstract`

A value that can be serialized / deserialized.

This is the base class that all serializable types should extend.

Hierarchy (View Summary)

Serializable
- SerializableWrapper
- SObject

Index

Constructors

Methods

deserialize getSerializedLength serialize from

Constructors

constructor

new Serializable(): Serializable
Returns Serializable

Methods

`Abstract`deserialize

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

`Abstract`getSerializedLength

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

`Abstract`serialize

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

`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
- Defined in src/serializable.ts:37