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

    Class Registry

    The primary entry point into the extension system.

    Registry holds the extensions which have been registered and activated, has methods for registering or defining a processor and looks up extensions stored in the registry during parsing.

    A registry can be reused across multiple conversions. Extensions registered via a group block (passed to Extensions.create or Extensions.register) are re-executed on every activation. Extensions registered directly on the registry instance (e.g. registry.preprocessor(fn)) are preserved across activations.

    const registry = Extensions.create('my-ext', function () {
      this.preprocessor(function () { ... })
    })
    // registry can be passed to multiple conversions safely
    Index

    Constructors

    constructor

    Properties

    document groups

    Methods

    activate block block_macro blockMacro blockMacros blocks docinfo_processor docinfoProcessor docinfoProcessors findBlockExtension findBlockMacroExtension findInlineMacroExtension getBlockFor getBlockMacroFor getBlockMacros getBlocks getDocinfoProcessors getGroups getIncludeProcessors getInlineMacroFor getInlineMacros getPostprocessors getPreprocessors getTreeProcessors hasBlockMacros hasBlocks hasDocinfoProcessors hasIncludeProcessors hasInlineMacros hasPostprocessors hasPreprocessors hasTeeProcessors hasTreeProcessors include_processor includeProcessor includeProcessors inline_macro inlineMacro inlineMacros postprocessor postprocessors prefer preprocessor preprocessors registeredForBlock registeredForBlockMacro registeredForInlineMacro tree_processor treeprocessor treeProcessor treeprocessors treeProcessors

    Constructors

    Properties

    document: Document
    groups: {}

    Methods

    • Activate all global extension Groups and the Groups associated with this registry.

      Parameters

      • document: Document

        The Document on which the extensions are to be used.

      Returns Registry

      this Registry.

    • Register a BlockProcessor with the extension registry.

      Parameters

      • processor: typeof BlockProcessor

        A BlockProcessor subclass.

      • Optionalname: string

        Optional explicit block name.

      Returns ProcessorExtension

      an Extension proxy object.

      // class style
      block(ShoutBlock)
      // class style with explicit name
      block(ShoutBlock, 'shout')
      // block style
      block(function () {
        this.named('shout')
        this.process(function (parent, reader, attrs) { ... })
      })
      // block style with explicit name
      block('shout', function () {
        this.process(function (parent, reader, attrs) { ... })
      })

      @overload

    • Register a BlockProcessor with the extension registry.

      Parameters

      • processor: BlockProcessor

        A BlockProcessor subclass.

      • Optionalname: string

        Optional explicit block name.

      Returns ProcessorExtension

      an Extension proxy object.

      // class style
      block(ShoutBlock)
      // class style with explicit name
      block(ShoutBlock, 'shout')
      // block style
      block(function () {
        this.named('shout')
        this.process(function (parent, reader, attrs) { ... })
      })
      // block style with explicit name
      block('shout', function () {
        this.process(function (parent, reader, attrs) { ... })
      })

      @overload

    • Register a BlockProcessor with the extension registry.

      Parameters

      • name: string

        Optional explicit block name.

      • fn: (this: BlockProcessorDslInterface) => void

        Registration function bound to the block DSL.

      Returns ProcessorExtension

      an Extension proxy object.

      // class style
      block(ShoutBlock)
      // class style with explicit name
      block(ShoutBlock, 'shout')
      // block style
      block(function () {
        this.named('shout')
        this.process(function (parent, reader, attrs) { ... })
      })
      // block style with explicit name
      block('shout', function () {
        this.process(function (parent, reader, attrs) { ... })
      })

      @overload

    • Register a BlockProcessor with the extension registry.

      Parameters

      Returns ProcessorExtension

      an Extension proxy object.

      // class style
      block(ShoutBlock)
      // class style with explicit name
      block(ShoutBlock, 'shout')
      // block style
      block(function () {
        this.named('shout')
        this.process(function (parent, reader, attrs) { ... })
      })
      // block style with explicit name
      block('shout', function () {
        this.process(function (parent, reader, attrs) { ... })
      })

      @overload

    • Retrieve Extension proxy objects for DocinfoProcessor instances.

      Parameters

      • Optionallocation: string

        Optional location ('head' or 'footer') to filter by.

      Returns ProcessorExtension[]

      array of Extension proxy objects.

    • Returns object

      the plain Object that maps names to groups for this registry.

    • Check whether any BlockMacroProcessor extensions have been registered.

      Returns boolean

    • Check whether any BlockProcessor extensions have been registered.

      Returns boolean

    • Check whether any DocinfoProcessor extensions have been registered.

      Parameters

      • Optionallocation: string

        Optional location ('head' or 'footer') to filter by.

      Returns boolean

    • Check whether any IncludeProcessor extensions have been registered.

      Returns boolean

    • Check whether any InlineMacroProcessor extensions have been registered.

      Returns boolean

    • Check whether any Postprocessor extensions have been registered.

      Returns boolean

    • Check whether any Preprocessor extensions have been registered.

      Returns boolean

    • Check whether any TreeProcessor extensions have been registered.

      Returns boolean

    • Insert the document-processor Extension as the first of its kind in the extension registry.

      Parameters

      • ...args: any[]

        A ProcessorExtension, or a method name followed by processor args.

      Returns ProcessorExtension

      the Extension stored in the registry.

      registry.prefer('includeProcessor', function () {
        this.process(function (document, reader, target, attrs) { ... })
      })

    • Register a Preprocessor with the extension registry.

      The processor may be:

      • A Preprocessor subclass (constructor function)
      • An instance of a Preprocessor subclass
      • A Function that configures the processor via the DSL (block style)

      Parameters

      Returns ProcessorExtension

      the Extension stored in the registry.

      // class style
      preprocessor(FrontMatterPreprocessor)
      // instance style
      preprocessor(new FrontMatterPreprocessor())
      // block style
      preprocessor(function () {
        this.process(function (doc, reader) { ... })
      })

      @overload

    • Register a Preprocessor with the extension registry.

      The processor may be:

      • A Preprocessor subclass (constructor function)
      • An instance of a Preprocessor subclass
      • A Function that configures the processor via the DSL (block style)

      Parameters

      Returns ProcessorExtension

      the Extension stored in the registry.

      // class style
      preprocessor(FrontMatterPreprocessor)
      // instance style
      preprocessor(new FrontMatterPreprocessor())
      // block style
      preprocessor(function () {
        this.process(function (doc, reader) { ... })
      })

      @overload

    • Register a Preprocessor with the extension registry.

      The processor may be:

      • A Preprocessor subclass (constructor function)
      • An instance of a Preprocessor subclass
      • A Function that configures the processor via the DSL (block style)

      Parameters

      Returns ProcessorExtension

      the Extension stored in the registry.

      // class style
      preprocessor(FrontMatterPreprocessor)
      // instance style
      preprocessor(new FrontMatterPreprocessor())
      // block style
      preprocessor(function () {
        this.process(function (doc, reader) { ... })
      })

      @overload

    • Check whether a BlockProcessor is registered for the given name and context.

      Parameters

      • name: string

        The block name.

      • context: string

        The block context.

      Returns false | ProcessorExtension

      the Extension proxy or false.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods