@xyo-network/module-factory-locator

Primary SDK for using XYO Protocol 2.0

Install

Using npm:

npm install {{name}}

Using yarn:

yarn add {{name}}

Using pnpm:

pnpm add {{name}}

Using bun:

bun add {{name}}

License

See the LICENSE file for license rights and limitations (LGPL-3.0-only).

Reference

packages

modules

### packages

  ### module

    ### packages

      ### locator

        ### .temp-typedoc

          ### classes

            ### <a id="ModuleFactoryLocator"></a>ModuleFactoryLocator

@xyo-network/module-factory-locator

A class which encapsulates the Service Locator Pattern for Module Factories

Implements

• ModuleFactoryLocatorInstance

Constructors

Constructor

new ModuleFactoryLocator(_registry?): ModuleFactoryLocator;

Parameters

_registry?

CreatableModuleRegistry = ...

Returns

ModuleFactoryLocator

Properties

_registry

protected readonly _registry: CreatableModuleRegistry;

Accessors

registry

Get Signature

get registry(): Readonly<CreatableModuleRegistry>;

The current registry for the module factory

Returns

Readonly<CreatableModuleRegistry>

Implementation of

ModuleFactoryLocatorInstance.registry

Methods

empty()

static empty(): ModuleFactoryLocator;

Returns

ModuleFactoryLocator

standard()

static standard(): ModuleFactoryLocator;

Returns

ModuleFactoryLocator

freeze()

freeze(): void;

Returns

void

Implementation of

ModuleFactoryLocatorInstance.freeze

locate()

locate(schema, labels?): 
  | CreatableModuleFactory<CreatableModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>
  | LabeledCreatableModuleFactory;

Locates a module factory that matches the supplied schema and labels

Parameters

schema

Schema

The config schema for the module

labels?

Labels

The labels for the module factory

Returns

| CreatableModuleFactory<CreatableModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>> | LabeledCreatableModuleFactory

A module factory that matches the supplied schema and labels or throws if one is not found

Implementation of

ModuleFactoryLocatorInstance.locate

merge()

merge(locator): ModuleFactoryLocatorInstance;

Parameters

locator

ModuleFactoryLocatorInstance

Returns

ModuleFactoryLocatorInstance

Implementation of

ModuleFactoryLocatorInstance.merge

register()

register(
   factory, 
   labels?, 
   primary?): this;

Registers a single module factory (with optional tags) with the locator

Parameters

factory

CreatableModuleFactory

The factory to register

labels?

Labels

The labels for the module factory

primary?

boolean | Schema | Schema[]

Returns

this

Implementation of

ModuleFactoryLocatorInstance.register

registerMany()

registerMany(factories): this;

Registers multiple module factories with the locator

Parameters

factories

CreatableModuleFactory<CreatableModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>[]

The factories to register

Returns

this

Implementation of

ModuleFactoryLocatorInstance.registerMany

tryLocate()

tryLocate(schema, labels?): 
  | CreatableModuleFactory<CreatableModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>
  | LabeledCreatableModuleFactory
  | undefined;

Tries to locate a module factory that matches the supplied schema and labels

Parameters

schema

Schema

The config schema for the module

labels?

Labels

The labels for the module factory

Returns

| CreatableModuleFactory<CreatableModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>> | LabeledCreatableModuleFactory | undefined

A module factory that matches the supplied schema and labels or undefined

Implementation of

ModuleFactoryLocatorInstance.tryLocate

          ### functions

            ### <a id="standardCreatableFactories"></a>standardCreatableFactories

@xyo-network/module-factory-locator

function standardCreatableFactories(): CreatableModuleRegistry;

Returns

CreatableModuleRegistry

          ### variables

            ### <a id="standardCreatableModulesList"></a>standardCreatableModulesList

@xyo-network/module-factory-locator

const standardCreatableModulesList: (CreatableModuleFactory | LabeledCreatableModuleFactory)[];