@xyo-network/module-resolver 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,1726 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/module-resolver
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
+
+```sh
+npm install {{name}}
+```
+
+Using yarn:
 
-Version: 5.0.2
+```sh
+yarn add {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using pnpm:
 
-## Documentation
+```sh
+pnpm add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__module-resolver)
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
+## Reference
+
+### packages
+
+  ### modules
+
+    ### packages
+
+      ### module
+
+        ### packages
+
+          ### resolver
+
+            ### .temp-typedoc
+
+              ### classes
+
+                ### <a id="AbstractModuleResolver"></a>AbstractModuleResolver
+
+[**@xyo-network/module-resolver**](#../README)
+
+***
+
+## Extends
+
+- `Base`\<`TParams`\>
+
+## Extended by
+
+- [`CompositeModuleResolver`](#CompositeModuleResolver)
+- [`SimpleModuleResolver`](#SimpleModuleResolver)
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`ModuleResolverParams`](#../interfaces/ModuleResolverParams) = [`ModuleResolverParams`](#../interfaces/ModuleResolverParams)
+
+## Implements
+
+- `ModuleResolverInstance`
+
+## Constructors
+
+### Constructor
+
+```ts
+new AbstractModuleResolver<TParams>(params): AbstractModuleResolver<TParams>;
+```
+
+### Parameters
+
+#### params
+
+`BaseParams`\<`TParams`\>
+
+### Returns
+
+`AbstractModuleResolver`\<`TParams`\>
+
+### Inherited from
+
+```ts
+Base<TParams>.constructor
+```
+
+## Accessors
+
+### priority
+
+### Get Signature
+
+```ts
+get priority(): ObjectResolverPriority;
+```
+
+#### Returns
+
+`ObjectResolverPriority`
+
+### Set Signature
+
+```ts
+set priority(value): void;
+```
+
+#### Parameters
+
+##### value
+
+`ObjectResolverPriority`
+
+#### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+ModuleResolverInstance.priority
+```
+
+***
+
+### root
+
+### Get Signature
+
+```ts
+get root(): ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>;
+```
+
+#### Returns
+
+`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+### Implementation of
+
+```ts
+ModuleResolverInstance.root
+```
+
+## Methods
+
+### resolve()
+
+### Call Signature
+
+```ts
+resolve<T>(): Promise<T[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Returns
+
+`Promise`\<`T`[]\>
+
+#### Implementation of
+
+```ts
+ModuleResolverInstance.resolve
+```
+
+### Call Signature
+
+```ts
+resolve<T>(all, options?): Promise<T[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### all
+
+`"*"`
+
+##### options?
+
+`ModuleFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T`[]\>
+
+#### Implementation of
+
+```ts
+ModuleResolverInstance.resolve
+```
+
+### Call Signature
+
+```ts
+resolve<T>(id, options?): Promise<T | undefined>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### id
+
+`ModuleIdentifier`
+
+##### options?
+
+`ModuleFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+#### Implementation of
+
+```ts
+ModuleResolverInstance.resolve
+```
+
+***
+
+### resolvePrivate()
+
+### Call Signature
+
+```ts
+resolvePrivate<T>(all, options?): Promise<T[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### all
+
+`"*"`
+
+##### options?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T`[]\>
+
+#### Implementation of
+
+```ts
+ModuleResolverInstance.resolvePrivate
+```
+
+### Call Signature
+
+```ts
+resolvePrivate<T>(id, options?): Promise<T | undefined>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### id
+
+`ModuleIdentifier`
+
+##### options?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+#### Implementation of
+
+```ts
+ModuleResolverInstance.resolvePrivate
+```
+
+***
+
+### addResolver()
+
+```ts
+abstract addResolver(resolver): this;
+```
+
+### Parameters
+
+#### resolver
+
+`ModuleResolverInstance`
+
+### Returns
+
+`this`
+
+### Implementation of
+
+```ts
+ModuleResolverInstance.addResolver
+```
+
+***
+
+### removeResolver()
+
+```ts
+abstract removeResolver(resolver): this;
+```
+
+### Parameters
+
+#### resolver
+
+`ModuleResolverInstance`
+
+### Returns
+
+`this`
+
+### Implementation of
+
+```ts
+ModuleResolverInstance.removeResolver
+```
+
+***
+
+### resolveHandler()
+
+```ts
+abstract resolveHandler<T>(id, options?): Promisable<T[]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### options?
+
+`ModuleFilterOptions`\<`T`\>
+
+### Returns
+
+`Promisable`\<`T`[]\>
+
+***
+
+### resolveIdentifier()
+
+```ts
+abstract resolveIdentifier(id, options?): Promisable<BrandedAddress | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### options?
+
+`ObjectFilterOptions`\<`AnyObject`\>
+
+### Returns
+
+`Promisable`\<`BrandedAddress` \| `undefined`\>
+
+### Implementation of
+
+```ts
+ModuleResolverInstance.resolveIdentifier
+```
+
+                ### <a id="CompositeModuleResolver"></a>CompositeModuleResolver
+
+[**@xyo-network/module-resolver**](#../README)
+
+***
+
+## Extends
+
+- [`AbstractModuleResolver`](#AbstractModuleResolver)\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`CompositeModuleResolverParams`](#../interfaces/CompositeModuleResolverParams) = [`CompositeModuleResolverParams`](#../interfaces/CompositeModuleResolverParams)
+
+## Implements
+
+- `ModuleRepository`
+- `ModuleResolverInstance`
+
+## Constructors
+
+### Constructor
+
+```ts
+new CompositeModuleResolver<T>(params): CompositeModuleResolver<T>;
+```
+
+### Parameters
+
+#### params
+
+`T`
+
+### Returns
+
+`CompositeModuleResolver`\<`T`\>
+
+### Overrides
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`constructor`](AbstractModuleResolver.md#constructor)
+
+## Properties
+
+### defaultMaxDepth
+
+```ts
+readonly static defaultMaxDepth: 3 = 3;
+```
+
+***
+
+### \_cache
+
+```ts
+protected _cache: LRUCache<ModuleIdentifier, ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>;
+```
+
+***
+
+### resolvers
+
+```ts
+protected resolvers: ModuleResolverInstance<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>[] = [];
+```
+
+## Accessors
+
+### priority
+
+### Get Signature
+
+```ts
+get priority(): ObjectResolverPriority;
+```
+
+#### Returns
+
+`ObjectResolverPriority`
+
+### Set Signature
+
+```ts
+set priority(value): void;
+```
+
+#### Parameters
+
+##### value
+
+`ObjectResolverPriority`
+
+#### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+ModuleRepository.priority
+```
+
+### Inherited from
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`priority`](AbstractModuleResolver.md#priority)
+
+***
+
+### root
+
+### Get Signature
+
+```ts
+get root(): ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>;
+```
+
+#### Returns
+
+`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+### Implementation of
+
+```ts
+ModuleRepository.root
+```
+
+### Inherited from
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`root`](AbstractModuleResolver.md#root)
+
+***
+
+### allowAddResolver
+
+### Get Signature
+
+```ts
+get allowAddResolver(): boolean;
+```
+
+#### Returns
+
+`boolean`
+
+### Set Signature
+
+```ts
+set allowAddResolver(value): void;
+```
+
+#### Parameters
+
+##### value
+
+`boolean`
+
+#### Returns
+
+`void`
+
+***
+
+### allowNameResolution
+
+### Get Signature
+
+```ts
+get allowNameResolution(): boolean;
+```
+
+#### Returns
+
+`boolean`
+
+## Methods
+
+### resolve()
+
+### Call Signature
+
+```ts
+resolve<T>(): Promise<T[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Returns
+
+`Promise`\<`T`[]\>
+
+#### Implementation of
+
+```ts
+ModuleRepository.resolve
+```
+
+#### Inherited from
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`resolve`](AbstractModuleResolver.md#resolve)
+
+### Call Signature
+
+```ts
+resolve<T>(all, options?): Promise<T[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### all
+
+`"*"`
+
+##### options?
+
+`ModuleFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T`[]\>
+
+#### Implementation of
+
+```ts
+ModuleRepository.resolve
+```
+
+#### Inherited from
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`resolve`](AbstractModuleResolver.md#resolve)
+
+### Call Signature
+
+```ts
+resolve<T>(id, options?): Promise<T | undefined>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### id
+
+`ModuleIdentifier`
+
+##### options?
+
+`ModuleFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+#### Implementation of
+
+```ts
+ModuleRepository.resolve
+```
+
+#### Inherited from
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`resolve`](AbstractModuleResolver.md#resolve)
+
+***
+
+### resolvePrivate()
+
+### Call Signature
+
+```ts
+resolvePrivate<T>(all, options?): Promise<T[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### all
+
+`"*"`
+
+##### options?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T`[]\>
+
+#### Implementation of
+
+```ts
+ModuleRepository.resolvePrivate
+```
+
+#### Inherited from
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`resolvePrivate`](AbstractModuleResolver.md#resolveprivate)
+
+### Call Signature
+
+```ts
+resolvePrivate<T>(id, options?): Promise<T | undefined>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### id
+
+`ModuleIdentifier`
+
+##### options?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+#### Implementation of
+
+```ts
+ModuleRepository.resolvePrivate
+```
+
+#### Inherited from
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`resolvePrivate`](AbstractModuleResolver.md#resolveprivate)
+
+***
+
+### add()
+
+### Call Signature
+
+```ts
+add(mod): this;
+```
+
+#### Parameters
+
+##### mod
+
+`ModuleInstance`
+
+#### Returns
+
+`this`
+
+#### Implementation of
+
+```ts
+ModuleRepository.add
+```
+
+### Call Signature
+
+```ts
+add(mod): this;
+```
+
+#### Parameters
+
+##### mod
+
+`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]
+
+#### Returns
+
+`this`
+
+#### Implementation of
+
+```ts
+ModuleRepository.add
+```
+
+***
+
+### addResolver()
+
+```ts
+addResolver(resolver): this;
+```
+
+### Parameters
+
+#### resolver
+
+`ModuleResolverInstance`
+
+### Returns
+
+`this`
+
+### Implementation of
+
+```ts
+ModuleRepository.addResolver
+```
+
+### Overrides
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`addResolver`](AbstractModuleResolver.md#addresolver)
+
+***
+
+### remove()
+
+```ts
+remove(addresses): this;
+```
+
+### Parameters
+
+#### addresses
+
+`BrandedAddress` \| `BrandedAddress`[]
+
+### Returns
+
+`this`
+
+### Implementation of
+
+```ts
+ModuleRepository.remove
+```
+
+***
+
+### removeResolver()
+
+```ts
+removeResolver(resolver): this;
+```
+
+### Parameters
+
+#### resolver
+
+`ModuleResolverInstance`
+
+### Returns
+
+`this`
+
+### Implementation of
+
+```ts
+ModuleRepository.removeResolver
+```
+
+### Overrides
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`removeResolver`](AbstractModuleResolver.md#removeresolver)
+
+***
+
+### resolveHandler()
+
+```ts
+resolveHandler<T>(id?, options?): Promise<T[]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+### Parameters
+
+#### id?
+
+`ModuleIdentifier` = `'*'`
+
+#### options?
+
+`ModuleFilterOptions`\<`T`\> = `{}`
+
+### Returns
+
+`Promise`\<`T`[]\>
+
+### Overrides
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`resolveHandler`](AbstractModuleResolver.md#resolvehandler)
+
+***
+
+### resolveIdentifier()
+
+```ts
+resolveIdentifier(id, _options?): Promise<BrandedAddress | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### \_options?
+
+`ObjectFilterOptions`\<`AnyObject`\>
+
+### Returns
+
+`Promise`\<`BrandedAddress` \| `undefined`\>
+
+### Implementation of
+
+```ts
+ModuleRepository.resolveIdentifier
+```
+
+### Overrides
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`resolveIdentifier`](AbstractModuleResolver.md#resolveidentifier)
+
+***
+
+### resolveComplexIdentifier()
+
+```ts
+protected resolveComplexIdentifier(_id, _options?): Promisable<BrandedAddress | undefined>;
+```
+
+### Parameters
+
+#### \_id
+
+`ModuleIdentifier`
+
+#### \_options?
+
+`ObjectFilterOptions`\<`AnyObject`\>
+
+### Returns
+
+`Promisable`\<`BrandedAddress` \| `undefined`\>
+
+                ### <a id="NameRegistrarTransformer"></a>NameRegistrarTransformer
+
+[**@xyo-network/module-resolver**](#../README)
+
+***
+
+## Implements
+
+- `ModuleIdentifierTransformer`
+
+## Constructors
+
+### Constructor
+
+```ts
+new NameRegistrarTransformer(registrarDiviner, root): NameRegistrarTransformer;
+```
+
+### Parameters
+
+#### registrarDiviner
+
+`DivinerInstance`
+
+#### root
+
+`string`
+
+### Returns
+
+`NameRegistrarTransformer`
+
+## Methods
+
+### transform()
+
+```ts
+transform(identifier): Promise<ModuleIdentifier>;
+```
+
+### Parameters
+
+#### identifier
+
+`ModuleIdentifier`
+
+### Returns
+
+`Promise`\<`ModuleIdentifier`\>
+
+### Implementation of
+
+```ts
+ModuleIdentifierTransformer.transform
+```
+
+                ### <a id="SimpleModuleResolver"></a>SimpleModuleResolver
+
+[**@xyo-network/module-resolver**](#../README)
+
+***
+
+## Extends
+
+- [`AbstractModuleResolver`](#AbstractModuleResolver)\<[`SimpleModuleResolverParams`](#../type-aliases/SimpleModuleResolverParams)\>
+
+## Implements
+
+- `ModuleRepository`
+
+## Constructors
+
+### Constructor
+
+```ts
+new SimpleModuleResolver(params): SimpleModuleResolver;
+```
+
+### Parameters
+
+#### params
+
+[`SimpleModuleResolverParams`](#../type-aliases/SimpleModuleResolverParams)
+
+### Returns
+
+`SimpleModuleResolver`
+
+### Overrides
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`constructor`](AbstractModuleResolver.md#constructor)
+
+## Accessors
+
+### priority
+
+### Get Signature
+
+```ts
+get priority(): ObjectResolverPriority;
+```
+
+#### Returns
+
+`ObjectResolverPriority`
+
+### Set Signature
+
+```ts
+set priority(value): void;
+```
+
+#### Parameters
+
+##### value
+
+`ObjectResolverPriority`
+
+#### Returns
+
+`void`
+
+### Implementation of
+
+```ts
+ModuleRepository.priority
+```
+
+### Inherited from
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`priority`](AbstractModuleResolver.md#priority)
+
+***
+
+### root
+
+### Get Signature
+
+```ts
+get root(): ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>;
+```
+
+#### Returns
+
+`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+### Implementation of
+
+```ts
+ModuleRepository.root
+```
+
+### Inherited from
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`root`](AbstractModuleResolver.md#root)
+
+***
+
+### allowNameResolution
+
+### Get Signature
+
+```ts
+get allowNameResolution(): boolean;
+```
+
+#### Returns
+
+`boolean`
+
+## Methods
+
+### resolve()
+
+### Call Signature
+
+```ts
+resolve<T>(): Promise<T[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Returns
+
+`Promise`\<`T`[]\>
+
+#### Implementation of
+
+```ts
+ModuleRepository.resolve
+```
+
+#### Inherited from
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`resolve`](AbstractModuleResolver.md#resolve)
+
+### Call Signature
+
+```ts
+resolve<T>(all, options?): Promise<T[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### all
+
+`"*"`
+
+##### options?
+
+`ModuleFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T`[]\>
+
+#### Implementation of
+
+```ts
+ModuleRepository.resolve
+```
+
+#### Inherited from
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`resolve`](AbstractModuleResolver.md#resolve)
+
+### Call Signature
+
+```ts
+resolve<T>(id, options?): Promise<T | undefined>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### id
+
+`ModuleIdentifier`
+
+##### options?
+
+`ModuleFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+#### Implementation of
+
+```ts
+ModuleRepository.resolve
+```
+
+#### Inherited from
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`resolve`](AbstractModuleResolver.md#resolve)
+
+***
+
+### resolvePrivate()
+
+### Call Signature
+
+```ts
+resolvePrivate<T>(all, options?): Promise<T[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### all
+
+`"*"`
+
+##### options?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T`[]\>
+
+#### Implementation of
+
+```ts
+ModuleRepository.resolvePrivate
+```
+
+#### Inherited from
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`resolvePrivate`](AbstractModuleResolver.md#resolveprivate)
+
+### Call Signature
+
+```ts
+resolvePrivate<T>(id, options?): Promise<T | undefined>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### id
+
+`ModuleIdentifier`
+
+##### options?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+#### Implementation of
+
+```ts
+ModuleRepository.resolvePrivate
+```
+
+#### Inherited from
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`resolvePrivate`](AbstractModuleResolver.md#resolveprivate)
+
+***
+
+### add()
+
+### Call Signature
+
+```ts
+add(mods): this;
+```
+
+#### Parameters
+
+##### mods
+
+`ModuleInstance`
+
+#### Returns
+
+`this`
+
+#### Implementation of
+
+```ts
+ModuleRepository.add
+```
+
+### Call Signature
+
+```ts
+add(mods): this;
+```
+
+#### Parameters
+
+##### mods
+
+`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]
+
+#### Returns
+
+`this`
+
+#### Implementation of
+
+```ts
+ModuleRepository.add
+```
+
+***
+
+### addResolver()
+
+```ts
+addResolver(_resolver): this;
+```
+
+### Parameters
+
+#### \_resolver
+
+`ModuleResolverInstance`
+
+### Returns
+
+`this`
+
+### Implementation of
+
+```ts
+ModuleRepository.addResolver
+```
+
+### Overrides
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`addResolver`](AbstractModuleResolver.md#addresolver)
+
+***
+
+### remove()
+
+```ts
+remove(address): this;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress` \| `BrandedAddress`[]
+
+### Returns
+
+`this`
+
+### Implementation of
+
+```ts
+ModuleRepository.remove
+```
+
+***
+
+### removeResolver()
+
+```ts
+removeResolver(_resolver): this;
+```
+
+### Parameters
+
+#### \_resolver
+
+`ModuleResolverInstance`
+
+### Returns
+
+`this`
+
+### Implementation of
+
+```ts
+ModuleRepository.removeResolver
+```
+
+### Overrides
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`removeResolver`](AbstractModuleResolver.md#removeresolver)
+
+***
+
+### resolveHandler()
+
+```ts
+resolveHandler<T>(id?, options?): Promisable<T[]>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+### Parameters
+
+#### id?
+
+`ModuleIdentifier` = `'*'`
+
+#### options?
+
+`ModuleFilterOptions`\<`T`\>
+
+### Returns
+
+`Promisable`\<`T`[]\>
+
+### Overrides
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`resolveHandler`](AbstractModuleResolver.md#resolvehandler)
+
+***
+
+### resolveIdentifier()
+
+```ts
+resolveIdentifier(id, _options?): Promisable<BrandedAddress | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### \_options?
+
+`ObjectFilterOptions`\<`AnyObject`\>
+
+### Returns
+
+`Promisable`\<`BrandedAddress` \| `undefined`\>
+
+### Implementation of
+
+```ts
+ModuleRepository.resolveIdentifier
+```
+
+### Overrides
+
+[`AbstractModuleResolver`](#AbstractModuleResolver).[`resolveIdentifier`](AbstractModuleResolver.md#resolveidentifier)
+
+              ### functions
+
+                ### <a id="mixinResolverEventEmitter"></a>mixinResolverEventEmitter
+
+[**@xyo-network/module-resolver**](#../README)
+
+***
+
+```ts
+function mixinResolverEventEmitter<T>(resolver): T & ResolverEventEmitter;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `ModuleResolver`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\> = `ModuleResolver`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>
+
+## Parameters
+
+### resolver
+
+`T`
+
+## Returns
+
+`T` & [`ResolverEventEmitter`](#../interfaces/ResolverEventEmitter)
+
+              ### interfaces
+
+                ### <a id="CompositeModuleResolverParams"></a>CompositeModuleResolverParams
+
+[**@xyo-network/module-resolver**](#../README)
+
+***
+
+## Extends
+
+- [`ModuleResolverParams`](#ModuleResolverParams)
+
+## Properties
+
+### priority?
+
+```ts
+optional priority?: ObjectResolverPriority;
+```
+
+### Inherited from
+
+[`ModuleResolverParams`](#ModuleResolverParams).[`priority`](ModuleResolverParams.md#priority)
+
+***
+
+### root
+
+```ts
+root: ModuleInstance;
+```
+
+### Inherited from
+
+[`ModuleResolverParams`](#ModuleResolverParams).[`root`](ModuleResolverParams.md#root)
+
+***
+
+### allowNameResolution?
+
+```ts
+optional allowNameResolution?: boolean;
+```
+
+***
+
+### cache?
+
+```ts
+optional cache?: CacheConfig;
+```
+
+***
+
+### moduleIdentifierTransformers?
+
+```ts
+optional moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
+```
+
+                ### <a id="ModuleResolvedEventArgs"></a>ModuleResolvedEventArgs
+
+[**@xyo-network/module-resolver**](#../README)
+
+***
+
+## Properties
+
+### id?
+
+```ts
+optional id?: ModuleIdentifier;
+```
+
+***
+
+### mod
+
+```ts
+mod: QueryableModule;
+```
+
+                ### <a id="ModuleResolverParams"></a>ModuleResolverParams
+
+[**@xyo-network/module-resolver**](#../README)
+
+***
+
+## Extends
+
+- `BaseParams`
+
+## Extended by
+
+- [`CompositeModuleResolverParams`](#CompositeModuleResolverParams)
+
+## Properties
+
+### priority?
+
+```ts
+optional priority?: ObjectResolverPriority;
+```
+
+***
+
+### root
+
+```ts
+root: ModuleInstance;
+```
+
+                ### <a id="ResolverEventEmitter"></a>ResolverEventEmitter
+
+[**@xyo-network/module-resolver**](#../README)
+
+***
+
+## Methods
+
+### on()
+
+```ts
+on(event, listener): void;
+```
+
+### Parameters
+
+#### event
+
+`"moduleResolved"`
+
+#### listener
+
+(`args`) => `void`
+
+### Returns
+
+`void`
+
+              ### type-aliases
+
+                ### <a id="SimpleModuleResolverParams"></a>SimpleModuleResolverParams
+
+[**@xyo-network/module-resolver**](#../README)
+
+***
+
+```ts
+type SimpleModuleResolverParams = ModuleResolverParams & object;
+```
+
+## Type Declaration
+
+### allowNameResolution?
 
-## Credits
+```ts
+optional allowNameResolution?: boolean;
+```
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/module-resolver.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/module-resolver
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/module-resolver.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE