Class ModuleFactoryLocator

A class which encapsulates the Service Locator Pattern for Module Factories

Index

Constructors

Properties

Accessors

Methods

freeze locate merge register registerMany tryLocate empty standard

Constructors

constructor

new ModuleFactoryLocator(
_registry?: CreatableModuleRegistry,
): ModuleFactoryLocator
Parameters
- _registry: CreatableModuleRegistry = ...
Returns ModuleFactoryLocator
- Defined in ModuleFactoryLocator.ts:23

Properties

`Protected` `Readonly`_registry

_registry: CreatableModuleRegistry = ...

Accessors

registry

get registry(): Readonly<CreatableModuleRegistry>
The current registry for the module factory

Returns Readonly<CreatableModuleRegistry>
- Defined in ModuleFactoryLocator.ts:28

Methods

freeze

freeze(): void
Returns void
- Defined in ModuleFactoryLocator.ts:40

locate

locate(
schema: string,
labels?: Labels,
): CreatableModuleFactory | LabeledCreatableModuleFactory
Locates a module factory that matches the supplied schema and labels
Parameters
- schema: string
  The config schema for the module
- Optionallabels: Labels
  The labels for the module factory
Returns CreatableModuleFactory | LabeledCreatableModuleFactory
A module factory that matches the supplied schema and labels or throws if one is not found
- Defined in ModuleFactoryLocator.ts:50

merge

merge(locator: ModuleFactoryLocator): ModuleFactoryLocator
Parameters
- locator: ModuleFactoryLocator
Returns ModuleFactoryLocator
- Defined in ModuleFactoryLocator.ts:57

register

register(
    factory: CreatableModuleFactory,
    labels?: Labels,
    primary?: string | boolean | string[],
): this
Registers a single module factory (with optional tags) with the locator
Parameters
- factory: CreatableModuleFactory
  The factory to register
- Optionallabels: Labels
  The labels for the module factory
- primary: string | boolean | string[] = false
Returns this
- Defined in ModuleFactoryLocator.ts:74

registerMany

registerMany(factories: CreatableModuleFactory[]): this
Registers multiple module factories with the locator
Parameters
- factories: CreatableModuleFactory[]
  The factories to register
Returns this
- Defined in ModuleFactoryLocator.ts:84

tryLocate

tryLocate(
schema: string,
labels?: Labels,
): undefined | CreatableModuleFactory | LabeledCreatableModuleFactory
Tries to locate a module factory that matches the supplied schema and labels
Parameters
- schema: string
  The config schema for the module
- Optionallabels: Labels
  The labels for the module factory
Returns undefined | CreatableModuleFactory | LabeledCreatableModuleFactory
A module factory that matches the supplied schema and labels or undefined
- Defined in ModuleFactoryLocator.ts:97

`Static`empty

empty(): ModuleFactoryLocator
Returns ModuleFactoryLocator
- Defined in ModuleFactoryLocator.ts:32

`Static`standard

standard(): ModuleFactoryLocator
Returns ModuleFactoryLocator
- Defined in ModuleFactoryLocator.ts:36