Class Record

Index

Constructors

Properties

canonicalLength dataOffset hash kind

Methods

by contiguousBytes contiguousData dataLength dataToBytes fieldOccurrences fields links mark readAt toBytes create fromBytes linkField

Constructors

`Protected`constructor

new Record(): Record

Returns Record

Properties

`Readonly`canonicalLength

canonicalLength: number

Complete canonical length in bytes.

`Readonly`dataOffset

dataOffset: number

Where the Blob data starts in the canonical bytes.

`Readonly`hash

hash: string

`Readonly`kind

kind: RecordKind

Methods

by

by(): RecordFieldValue

Structural Seal evidence, separate from application fields; null for Blob/Plex.

Returns RecordFieldValue

contiguousBytes

contiguousBytes(): Uint8Array<ArrayBufferLike>

Independent copy of the canonical bytes where the record holds them contiguously, else null.

Returns Uint8Array<ArrayBufferLike>

contiguousData

contiguousData(): Uint8Array<ArrayBufferLike>

Independent copy of the Blob data where the record holds it contiguously, else null.

Returns Uint8Array<ArrayBufferLike>

dataLength

dataLength(): number

Returns number

dataToBytes

dataToBytes(limit: number): Uint8Array
The Blob data; RangeError when longer than limit.
Parameters
- limit: number
Returns Uint8Array

fieldOccurrences

fieldOccurrences(): RecordApplicationFieldOccurrence[]

Application fields only, in canonical name/occurrence order.

Returns RecordApplicationFieldOccurrence[]

fields

fields(name: string): RecordFieldOccurrence[]
All application occurrences for this name, or []; never a singleton getter.
Parameters
- name: string
Returns RecordFieldOccurrence[]

links

links(): RecordLink[]

Returns RecordLink[]

mark

mark(): RecordFieldValue

Returns RecordFieldValue

readAt

readAt(offset: number, length: number): Uint8Array
Up to length canonical bytes from offset, fewer only at the end; RangeError past the end.
Parameters
- offset: number
- length: number
Returns Uint8Array

toBytes

toBytes(limit: number): Uint8Array
The complete canonical bytes; RangeError when longer than limit.
Parameters
- limit: number
Returns Uint8Array

`Static`create

create(spec?: RecordCreateSpec, options?: WasmLoadOptions): Promise<Record>
Async construction/validation; accessors on the returned Record are synchronous.
Parameters
- Optionalspec: RecordCreateSpec
- Optionaloptions: WasmLoadOptions
Returns Promise<Record>

`Static`fromBytes

fromBytes(bytes: BytesLike, options?: WasmLoadOptions): Promise<Record>
Validates external bytes. Invalid records reject with ordinary Error/TypeError.
Parameters
- bytes: BytesLike
- Optionaloptions: WasmLoadOptions
Returns Promise<Record>

`Static`linkField

linkField(data: string, target: string): string
Parameters
- data: string
- target: string
Returns string