Class RecordId

Unique ID of records in PDB databases.

Each unique ID is encoded as a 24-bit big endian unsigned integer. Valid records should have a non-zero unique ID.

Hierarchy

SerializableWrapper<number>
- RecordId

Index

Constructors

Properties

Methods

assignJSON deserialize getSerializedLength serialize toJSON from of

Constructors

constructor

new RecordId(): RecordId
Returns RecordId
Inherited from SerializableWrapper<number>.constructor

Properties

value

value: number = 0

Methods

assignJSON

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

deserialize

deserialize(buffer: Buffer, _opts?: DeserializeOptions): 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/util.ts:117

getSerializedLength

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

serialize

serialize(_opts?: SerializeOptions): Buffer<ArrayBuffer>
Serializes this value into a buffer.
Parameters
- Optional_opts: SerializeOptions
Returns Buffer<ArrayBuffer>
Overrides SerializableWrapper.serialize
- Defined in src/util.ts:125

toJSON

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

`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 node_modules/serio/dist/serializable.d.ts:34

`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 node_modules/serio/dist/serializable-wrapper.d.ts:8