Interface SequenceTagOptions<Carrier, Result>

interface SequenceTagOptions<Carrier, Result = Carrier> {
    matchByTagPrefix?: boolean;
    create: (tagName: string) => Carrier;
    addItem: (carrier: Carrier, item: unknown, index: number) => string | void;
    finalize?: (carrier: Carrier) => Result;
    identify: (data: any) => boolean;
    represent?: (data: any) => ArrayLike<unknown>;
    representTagName?: (data: any) => string;
}

Properties

matchByTagPrefix?: boolean

Whether explicit tag names are matched by prefix instead of exact equality. Default: false.

create: (tagName: string) => Carrier

Create the carrier used while constructing a sequence.

addItem: (carrier: Carrier, item: unknown, index: number) => string | void

Add an item to the carrier. Return a non-empty error message to reject it.

finalize?: (carrier: Carrier) => Result

Convert the completed carrier to the result. Defaults to the identity function.

identify: (data: any) => boolean

Selects this tag for a JavaScript value when dumping. Use () => false for load-only tags.

represent?: (data: any) => ArrayLike<unknown>

Return the array-like contents to dump. Defaults to the identity function.

representTagName?: (data: any) => string

Return the tag name to emit for a prefix-matching tag. Defaults to tagName.