Documentation for Simbo's Packages
    Preparing search index...

    Interface Options

    Options for injecting content between HTML comments.

    interface Options {
        inline?: boolean;
        name?: string;
        text?: TextOption;
        trim?: boolean;
    }
    Index

    Properties

    inline? name? text? trim?

    Properties

    inline?: boolean

    If inline is true, the injected content will be added without wrapping it in double line breaks to create a separate markdown block.

    false
    name?: string

    The name partial of the injection comment text. Ignored if text is set. If undefined the default base text will be used.

    undefined

    Optionaltext

    text?: TextOption

    The injection comment text to search for. Either a string or a function that returns a string. The function gets an optional name argument.

    INJECT:${name} | 'INJECT'

    trim?: boolean

    Whether the injection content should be trimmed.

    true

    Settings

    Member Visibility

    On This Page

    Properties