@asciidoctor/core - v4.0.10
    Preparing search index...

    Type Alias ProcessorDslInterface

    DSL interface for configuring a Processor instance. Applied to a processor instance via Object.assign(instance, DslMixin).

    The process property behaves as a setter when called with a single Function argument (stores the process block), or as a passthrough caller otherwise.

    Every processor type (Preprocessor, TreeProcessor, Postprocessor, IncludeProcessor, DocinfoProcessor, BlockProcessor, BlockMacroProcessor, InlineMacroProcessor) extends the Processor base class, so the node-builder helpers below (and their createBlock/createInline shorthands) are available on this inside the registration function and the bound process callback for all of them, not just block processors.

    type ProcessorDslInterface = {
        createAnchor: (
            parent: AbstractBlock,
            text: string,
            opts?: object,
        ) => Inline;
        createBlock: (
            parent: AbstractBlock,
            context: string,
            source?: string | string[] | null,
            attrs?: object,
            opts?: object,
        ) => Block;
        createExampleBlock: (
            parent: AbstractBlock,
            source?: string | string[] | null,
            attrs?: object,
            opts?: object,
        ) => Block;
        createImageBlock: (
            parent: AbstractBlock,
            attrs: object,
            opts?: object,
        ) => Block;
        createInline: (
            parent: AbstractBlock,
            context: string,
            text: string,
            opts?: object,
        ) => Inline;
        createInlinePass: (
            parent: AbstractBlock,
            text: string,
            opts?: object,
        ) => Inline;
        createList: (
            parent: AbstractBlock,
            context: string,
            attrs?: object | null,
        ) => List;
        createListingBlock: (
            parent: AbstractBlock,
            source?: string | string[] | null,
            attrs?: object,
            opts?: object,
        ) => Block;
        createListItem: (parent: List, text?: string | null) => ListItem;
        createLiteralBlock: (
            parent: AbstractBlock,
            source?: string | string[] | null,
            attrs?: object,
            opts?: object,
        ) => Block;
        createOpenBlock: (
            parent: AbstractBlock,
            source?: string | string[] | null,
            attrs?: object,
            opts?: object,
        ) => Block;
        createParagraph: (
            parent: AbstractBlock,
            source?: string | string[] | null,
            attrs?: object,
            opts?: object,
        ) => Block;
        createPassBlock: (
            parent: AbstractBlock,
            source?: string | string[] | null,
            attrs?: object,
            opts?: object,
        ) => Block;
        createSection: (
            parent: AbstractBlock,
            title: string,
            attrs: object,
            opts?: object,
        ) => Section;
        option: (key: string, value: unknown) => void;
        parseAttributes: (
            block: AbstractBlock,
            attrlist: string,
            opts?: object,
        ) => Promise<Record<string, unknown>>;
        parseContent: (
            parent: AbstractBlock,
            content: string[] | Reader,
            attributes?: object | null,
        ) => Promise<AbstractBlock>;
        process: (fn: (...args: unknown[]) => unknown) => void;
        processBlockGiven: () => boolean;
    }
    Index

    Properties

    createAnchor createBlock createExampleBlock createImageBlock createInline createInlinePass createList createListingBlock createListItem createLiteralBlock createOpenBlock createParagraph createPassBlock createSection option parseAttributes parseContent process processBlockGiven

    Properties

    createAnchor: (parent: AbstractBlock, text: string, opts?: object) => Inline
    createBlock: (
        parent: AbstractBlock,
        context: string,
        source?: string | string[] | null,
        attrs?: object,
        opts?: object,
    ) => Block
    createExampleBlock: (
        parent: AbstractBlock,
        source?: string | string[] | null,
        attrs?: object,
        opts?: object,
    ) => Block
    createImageBlock: (parent: AbstractBlock, attrs: object, opts?: object) => Block
    createInline: (
        parent: AbstractBlock,
        context: string,
        text: string,
        opts?: object,
    ) => Inline
    createInlinePass: (parent: AbstractBlock, text: string, opts?: object) => Inline
    createList: (
        parent: AbstractBlock,
        context: string,
        attrs?: object | null,
    ) => List
    createListingBlock: (
        parent: AbstractBlock,
        source?: string | string[] | null,
        attrs?: object,
        opts?: object,
    ) => Block
    createListItem: (parent: List, text?: string | null) => ListItem
    createLiteralBlock: (
        parent: AbstractBlock,
        source?: string | string[] | null,
        attrs?: object,
        opts?: object,
    ) => Block
    createOpenBlock: (
        parent: AbstractBlock,
        source?: string | string[] | null,
        attrs?: object,
        opts?: object,
    ) => Block
    createParagraph: (
        parent: AbstractBlock,
        source?: string | string[] | null,
        attrs?: object,
        opts?: object,
    ) => Block
    createPassBlock: (
        parent: AbstractBlock,
        source?: string | string[] | null,
        attrs?: object,
        opts?: object,
    ) => Block
    createSection: (
        parent: AbstractBlock,
        title: string,
        attrs: object,
        opts?: object,
    ) => Section
    option: (key: string, value: unknown) => void
    • Set a config option.
    parseAttributes: (
        block: AbstractBlock,
        attrlist: string,
        opts?: object,
    ) => Promise<Record<string, unknown>>
    parseContent: (
        parent: AbstractBlock,
        content: string[] | Reader,
        attributes?: object | null,
    ) => Promise<AbstractBlock>
    process: (fn: (...args: unknown[]) => unknown) => void
    • Register the process function.
    processBlockGiven: () => boolean
    • Returns true if a process function has been registered.

    Settings

    Member Visibility

    On This Page

    Properties