Class NodeRef

Reference to all or part of another logical node instead of inline bytes.

Index

Constructors

Properties

id length offset

Accessors

Methods

toMsgpack validate create fromMsgpack

Constructors

constructor

new NodeRef(options: NodeRefOptions): NodeRef
Parameters
- options: NodeRefOptions
Returns NodeRef
- Defined in src/data.ts:469

Properties

id

id: string

Referenced node id.

length

length: number | null

Number of fragments, or null for the remaining node.

offset

offset: number

First referenced fragment offset.

Accessors

approxBytes

get approxBytes(): number
Approximate encoded field size.

Returns number
- Defined in src/data.ts:490

Methods

toMsgpack

toMsgpack(): StatusOr<Uint8Array<ArrayBufferLike>>
Encode the concatenated MessagePack node-reference record.

Returns StatusOr<Uint8Array<ArrayBufferLike>>
- Defined in src/data.ts:518

validate

validate(): Status
Validate the id and uint32 window.

Returns Status
- Defined in src/data.ts:495

`Static`create

create(options: NodeRefOptions): StatusOr<NodeRef>
Construct and validate a node reference.
Parameters
- options: NodeRefOptions
Returns StatusOr<NodeRef>
- Defined in src/data.ts:476

`Static`fromMsgpack

fromMsgpack(bytes: Uint8Array): StatusOr<NodeRef>
Decode a concatenated MessagePack node-reference record.
Parameters
- bytes: Uint8Array
Returns StatusOr<NodeRef>
- Defined in src/data.ts:526