Class PalmDocMetadata

Metadata stored in the first record of a PalmDOC database.

Hierarchy

Serializable
- PalmDocMetadata

Index

Constructors

Properties

isCompressed numRecords position textLength

Methods

deserialize getSerializedLength serialize from

Constructors

constructor

new PalmDocMetadata(): PalmDocMetadata
Returns PalmDocMetadata
Inherited from Serializable.constructor

Properties

isCompressed

isCompressed: boolean = true

Whether the text is compressed.

numRecords

numRecords: number = 0

Number of records used for storing text.

position

position: number = 0

Current reading position, as an offset into the uncompressed text.

textLength

textLength: number = 0

Uncompressed length of the text.

Methods

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 Serializable.deserialize
- Defined in src/palmdoc-database.ts:280

getSerializedLength

getSerializedLength(_opts?: SerializeOptions): number
Computes the serialized length of this value.
Parameters
- Optional_opts: SerializeOptions
Returns number
Overrides Serializable.getSerializedLength
- Defined in src/palmdoc-database.ts:320

serialize

serialize(opts?: SerializeOptions): Buffer<ArrayBufferLike>
Serializes this value into a buffer.
Parameters
- Optionalopts: SerializeOptions
Returns Buffer<ArrayBufferLike>
Overrides Serializable.serialize
- Defined in src/palmdoc-database.ts:309

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