Class ConverterCustomFactory

constructor

• new ConverterCustomFactory(seedRegistry?: any): ConverterCustomFactory

  Parameters

  • OptionalseedRegistry: any

  Returns ConverterCustomFactory

_catchAll

_registry

converters

• converters(): object

  Get the registered converters map.

  Returns object

  a shallow copy of the registry

create

• create(backend: string, opts?: object): Promise<object>

  Create a new converter instance for the given backend.

  Parameters

  • backend: string

    the backend name

  • Optionalopts: object

    options passed to the converter constructor

  Returns Promise<object>

  the converter instance, or null if not registered

createSync

• createSync(backend: string, opts?: object): object

  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: string

    the backend name

  • Optionalopts: object

    options passed to the converter constructor

  Returns object

  the converter instance, or null if not registered

for

• for(backend: string): object | Function

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

  Parameters

  • backend: string

    the backend name

  Returns object | Function

register

• register(converter: object | Function, ...backends: string[]): void

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

  Parameters

  • converter: object | Function

    the converter class or instance

  • ...backends: string[]

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

  Returns void

unregisterAll

• unregisterAll(): void

  Unregister all converters.

  Returns void