Interface BreakscapeOptions

Options for the breakscapeText and unbreakscapeText functions.

interface BreakscapeOptions {
    format?: TextFormat;
    location?: TextLocation;
    subLocation?: TextSubLocation;
}

Properties

Text format (default: "bitmark++").

Text location (default: "body").

Sub-location within location (default: "text").

Ignored by unbreakscapeText — for bitmark++ one inverse undoes every breakscape mode.