Interface PreHookResult

What a PreHook may return for a bit. All fields are optional; an empty result (or void) makes the hook a pure observer.

interface PreHookResult {
    drop?: boolean;
    outputFormat?: OutputFormat;
    patches?: PatchEntry[];
}

Index

Properties

drop? outputFormat? patches?

Properties

`Optional`drop

drop?: boolean

Drop the bit from the output entirely.

`Optional`outputFormat

outputFormat?: OutputFormat

Override the output format for this bit only.

`Optional`patches

patches?: PatchEntry[]

Patches to apply to this bit, after the patch document's entries for it.