@asciidoctor/core
    Preparing search index...

    Class DefaultConverterFactory

    A factory that maps backend names to converter classes or instances. Use the global Converter instance (DefaultFactory) for typical use.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _catchAll: any
    _defaultRegistry: {}
    _registry: {}

    Methods

    • Create a new converter instance for the given backend.

      Parameters

      • backend: any

        the backend name

      • Optionalopts: {}

        options passed to the converter constructor

      Returns Promise<any>

      the converter instance, or null if not registered

    • Create a new converter instance for the given backend (synchronous). Requires the converter class to already be registered; does not support template dirs.

      Parameters

      • backend: any

        the backend name

      • Optionalopts: {}

        options passed to the converter constructor

      Returns any

      the converter instance, or null if not registered

    • Retrieve the converter class registered for the given backend. Returns undefined (not null) when no match is found, mirroring the core API.

      Parameters

      • backend: any

        the backend name

      Returns any

    • Return the combined registry (built-in + user-registered entries).

      Returns object

    • Register a converter class for one or more backend names. Backends may be passed as individual strings or as a single Array.

      Parameters

      • converter: any

        the converter class or instance

      • ...backends: any[]

        backend names; use '*' as a catch-all

      Returns void