Class ApeItem

A single APE tag item.

Binary layout: valueLength(4 LE) + flags(4 LE) + key(null-terminated ASCII) + value

Index

Constructors

Properties

binaryData key readOnly type values

Methods

render toString parse

Constructors

constructor

new ApeItem(): ApeItem
Returns ApeItem

Properties

binaryData

binaryData: ByteVector = ...

Raw binary payload (for Binary items).

key

key: string = ""

Case-sensitive ASCII key identifying this item.

readOnly

readOnly: boolean = false

Whether this item is marked read-only in the tag.

type

type: ApeItemType = ApeItemType.Text

Data type of this item's value.

values

values: string[] = []

Decoded text values (for Text/Locator items).

Methods

render

render(): ByteVector
Render this item to bytes.

Returns ByteVector
- Defined in ape/apeTag.ts:91

toString

toString(): string
Returns a human-readable representation of this item's value.

Returns string
- Defined in ape/apeTag.ts:115

`Static`parse

parse(
data: ByteVector,
offset: number,
): { bytesUsed: number; item: ApeItem } | null
Parse one APE item starting at offset in data. Returns the parsed item and how many bytes were consumed, or null on error.
Parameters
- data: ByteVector
- offset: number
Returns { bytesUsed: number; item: ApeItem } | null
- Defined in ape/apeTag.ts:50