@xyo-network/diviner-model 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,2632 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/diviner-model
 
-[![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__diviner-model)
+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
+
+      ### diviner
+
+        ### packages
+
+          ### model
+
+            ### .temp-typedoc
+
+              ### classes
+
+                ### <a id="IsAttachableDivinerInstanceFactory"></a>IsAttachableDivinerInstanceFactory
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+## Extends
+
+- `IsObjectFactory`\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`AttachableDivinerInstance`](#../interfaces/AttachableDivinerInstance) = [`AttachableDivinerInstance`](#../interfaces/AttachableDivinerInstance)
+
+## Constructors
+
+### Constructor
+
+```ts
+new IsAttachableDivinerInstanceFactory<T>(): IsAttachableDivinerInstanceFactory<T>;
+```
+
+### Returns
+
+`IsAttachableDivinerInstanceFactory`\<`T`\>
+
+### Inherited from
+
+```ts
+IsObjectFactory<T>.constructor
+```
+
+              ### interfaces
+
+                ### <a id="AttachableDivinerInstance"></a>AttachableDivinerInstance
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+## Extends
+
+- [`DivinerInstance`](#DivinerInstance)\<`TParams`, `TIn`, `TOut`, `TEventData`\>.`AttachableModuleInstance`\<`TParams`, `TEventData`\>
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`DivinerParams`](#DivinerParams) = [`DivinerParams`](#DivinerParams)
+
+### TIn
+
+`TIn` *extends* `Payload` = `Payload`
+
+### TOut
+
+`TOut` *extends* `Payload` = `Payload`
+
+### TEventData
+
+`TEventData` *extends* [`DivinerModuleEventData`](#../type-aliases/DivinerModuleEventData) = [`DivinerModuleEventData`](#../type-aliases/DivinerModuleEventData)
+
+## Properties
+
+### divine
+
+```ts
+divine: (payloads?, retry?) => Promise<DivinerDivineResult<TOut>[]>;
+```
+
+### Parameters
+
+#### payloads?
+
+`TIn`[]
+
+#### retry?
+
+`RetryConfig`
+
+### Returns
+
+`Promise`\<[`DivinerDivineResult`](#../type-aliases/DivinerDivineResult)\<`TOut`\>[]\>
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`divine`](DivinerInstance.md#divine)
+
+***
+
+### divineQuery
+
+```ts
+divineQuery: (payloads?, account?, retry?) => Promise<ModuleQueryResult<TOut>>;
+```
+
+### Parameters
+
+#### payloads?
+
+`TIn`[]
+
+#### account?
+
+`AccountInstance`
+
+#### retry?
+
+`RetryConfig`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`TOut`\>\>
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`divineQuery`](DivinerInstance.md#divinequery)
+
+***
+
+### address
+
+```ts
+address: BrandedAddress;
+```
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`address`](DivinerInstance.md#address)
+
+***
+
+### config
+
+```ts
+config: TParams["config"];
+```
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`config`](DivinerInstance.md#config)
+
+***
+
+### id
+
+```ts
+id: string;
+```
+
+The name (if specified) or address of the module
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`id`](DivinerInstance.md#id)
+
+***
+
+### modName?
+
+```ts
+optional modName?: string;
+```
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`modName`](DivinerInstance.md#modname)
+
+***
+
+### params
+
+```ts
+params: TParams;
+```
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`params`](DivinerInstance.md#params)
+
+***
+
+### previousHash
+
+```ts
+previousHash: () => Promisable<string | undefined>;
+```
+
+### Returns
+
+`Promisable`\<`string` \| `undefined`\>
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`previousHash`](DivinerInstance.md#previoushash)
+
+***
+
+### queries
+
+```ts
+queries: string[];
+```
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`queries`](DivinerInstance.md#queries)
+
+***
+
+### query
+
+```ts
+query: <T, TConf>(query, payloads?, queryConfig?) => Promisable<ModuleQueryResult>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
+
+#### TConf
+
+`TConf` *extends* `ModuleConfig` = `ModuleConfig`
+
+### Parameters
+
+#### query
+
+`T`
+
+#### payloads?
+
+`Payload`[]
+
+#### queryConfig?
+
+`TConf`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`query`](DivinerInstance.md#query)
+
+***
+
+### queryable
+
+```ts
+queryable: <T, TConf>(query, payloads?, queryConfig?) => Promisable<boolean>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
+
+#### TConf
+
+`TConf` *extends* `ModuleConfig` = `ModuleConfig`
+
+### Parameters
+
+#### query
+
+`T`
+
+#### payloads?
+
+`Payload`[]
+
+#### queryConfig?
+
+`TConf`
+
+### Returns
+
+`Promisable`\<`boolean`\>
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`queryable`](DivinerInstance.md#queryable)
+
+***
+
+### manifest
+
+```ts
+manifest: (maxDepth?, ignoreAddresses?) => Promisable<ModuleManifestPayload>;
+```
+
+### Parameters
+
+#### maxDepth?
+
+`number`
+
+#### ignoreAddresses?
+
+`BrandedAddress`[]
+
+### Returns
+
+`Promisable`\<`ModuleManifestPayload`\>
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`manifest`](DivinerInstance.md#manifest)
+
+***
+
+### manifestQuery
+
+```ts
+manifestQuery: (account, maxDepth?, ignoreAddresses?) => Promisable<ModuleQueryResult<ModuleManifestPayload>>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+#### maxDepth?
+
+`number`
+
+#### ignoreAddresses?
+
+`BrandedAddress`[]
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`manifestQuery`](DivinerInstance.md#manifestquery)
+
+***
+
+### moduleAddress
+
+```ts
+moduleAddress: () => Promisable<(AddressPreviousHashPayload | AddressPayload)[]>;
+```
+
+### Returns
+
+`Promisable`\<(`AddressPreviousHashPayload` \| `AddressPayload`)[]\>
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`moduleAddress`](DivinerInstance.md#moduleaddress)
+
+***
+
+### state
+
+```ts
+state: () => Promisable<Payload[]>;
+```
+
+### Returns
+
+`Promisable`\<`Payload`[]\>
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`state`](DivinerInstance.md#state)
+
+***
+
+### stateQuery
+
+```ts
+stateQuery: (account) => Promisable<ModuleQueryResult>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`stateQuery`](DivinerInstance.md#statequery)
+
+***
+
+### account?
+
+```ts
+optional account?: AccountInstance;
+```
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`account`](DivinerInstance.md#account)
+
+***
+
+### addParent
+
+```ts
+addParent: (mod) => void;
+```
+
+### Parameters
+
+#### mod
+
+`ModuleInstance`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`addParent`](DivinerInstance.md#addparent)
+
+***
+
+### addressCache?
+
+```ts
+optional addressCache?: (direction, includePrivate) => AddressToWeakInstanceCache | undefined;
+```
+
+### Parameters
+
+#### direction
+
+`Direction`
+
+#### includePrivate
+
+`boolean`
+
+### Returns
+
+`AddressToWeakInstanceCache` \| `undefined`
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`addressCache`](DivinerInstance.md#addresscache)
+
+***
+
+### parents
+
+```ts
+parents: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`parents`](DivinerInstance.md#parents)
+
+***
+
+### privateChildren
+
+```ts
+privateChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`privateChildren`](DivinerInstance.md#privatechildren)
+
+***
+
+### publicChildren
+
+```ts
+publicChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`publicChildren`](DivinerInstance.md#publicchildren)
+
+***
+
+### removeParent
+
+```ts
+removeParent: (address) => void;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`removeParent`](DivinerInstance.md#removeparent)
+
+***
+
+### siblings
+
+```ts
+siblings: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`siblings`](DivinerInstance.md#siblings)
+
+***
+
+### pipeline?
+
+```ts
+readonly optional pipeline?: "one-to-one" | "one-to-many" | "many-to-one" | "many-to-many";
+```
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`pipeline`](DivinerInstance.md#pipeline)
+
+***
+
+### status
+
+```ts
+readonly status: ModuleStatus | null;
+```
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`status`](DivinerInstance.md#status)
+
+***
+
+### priority
+
+```ts
+priority: ObjectResolverPriority;
+```
+
+### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`priority`](DivinerInstance.md#priority)
+
+***
+
+### downResolver
+
+```ts
+readonly downResolver: ModuleResolverInstance;
+```
+
+### Inherited from
+
+```ts
+AttachableModuleInstance.downResolver
+```
+
+***
+
+### privateResolver
+
+```ts
+readonly privateResolver: ModuleResolverInstance;
+```
+
+### Inherited from
+
+```ts
+AttachableModuleInstance.privateResolver
+```
+
+***
+
+### upResolver
+
+```ts
+readonly upResolver: ModuleResolverInstance;
+```
+
+### Inherited from
+
+```ts
+AttachableModuleInstance.upResolver
+```
+
+## Methods
+
+### resolve()
+
+### Call Signature
+
+```ts
+resolve<T>(all, options?): Promisable<T[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### all
+
+`"*"`
+
+##### options?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promisable`\<`T`[]\>
+
+#### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`resolve`](DivinerInstance.md#resolve)
+
+### Call Signature
+
+```ts
+resolve<T>(id, options?): Promisable<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
+
+`Promisable`\<`T` \| `undefined`\>
+
+#### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`resolve`](DivinerInstance.md#resolve)
+
+### Call Signature
+
+```ts
+resolve<T>(id?, options?): Promisable<T | 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
+
+`Promisable`\<`T` \| `T`[] \| `undefined`\>
+
+#### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`resolve`](DivinerInstance.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`[]\>
+
+#### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`resolvePrivate`](DivinerInstance.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`\>
+
+#### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`resolvePrivate`](DivinerInstance.md#resolveprivate)
+
+### Call Signature
+
+```ts
+resolvePrivate<T>(id, options?): Promise<T | 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` \| `T`[] \| `undefined`\>
+
+#### Inherited from
+
+[`DivinerInstance`](#DivinerInstance).[`resolvePrivate`](DivinerInstance.md#resolveprivate)
+
+                ### <a id="DivineEndEventData"></a>DivineEndEventData
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+### TIn
+
+`TIn` *extends* `Payload` = `Payload`
+
+### TOut
+
+`TOut` *extends* `Payload` = `Payload`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### divineEnd
+
+```ts
+divineEnd: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### errors
+
+```ts
+errors: Error[];
+```
+
+#### inPayloads
+
+```ts
+inPayloads: TIn[];
+```
+
+#### outPayloads
+
+```ts
+outPayloads: TOut[];
+```
+
+                ### <a id="DivineStartEventData"></a>DivineStartEventData
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+### TIn
+
+`TIn` *extends* `Payload` = `Payload`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### divineStart
+
+```ts
+divineStart: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### inPayloads
+
+```ts
+inPayloads: TIn[];
+```
+
+                ### <a id="DivinerInstance"></a>DivinerInstance
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+## Extends
+
+- [`DivinerModule`](#DivinerModule)\<`TParams`, `TEvents`\>.[`DivinerQueryFunctions`](#DivinerQueryFunctions)\<`TIn`, `TOut`\>.`ModuleInstance`\<`TParams`, `TEvents`\>
+
+## Extended by
+
+- [`AttachableDivinerInstance`](#AttachableDivinerInstance)
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`DivinerParams`](#DivinerParams) = [`DivinerParams`](#DivinerParams)
+
+### TIn
+
+`TIn` *extends* `Payload` = `Payload`
+
+### TOut
+
+`TOut` *extends* `Payload` = `Payload`
+
+### TEvents
+
+`TEvents` *extends* [`DivinerModuleEventData`](#../type-aliases/DivinerModuleEventData) = [`DivinerModuleEventData`](#../type-aliases/DivinerModuleEventData)
+
+## Properties
+
+### divine
+
+```ts
+divine: (payloads?, retry?) => Promise<DivinerDivineResult<TOut>[]>;
+```
+
+### Parameters
+
+#### payloads?
+
+`TIn`[]
+
+#### retry?
+
+`RetryConfig`
+
+### Returns
+
+`Promise`\<[`DivinerDivineResult`](#../type-aliases/DivinerDivineResult)\<`TOut`\>[]\>
+
+### Inherited from
+
+[`DivinerQueryFunctions`](#DivinerQueryFunctions).[`divine`](DivinerQueryFunctions.md#divine)
+
+***
+
+### divineQuery
+
+```ts
+divineQuery: (payloads?, account?, retry?) => Promise<ModuleQueryResult<TOut>>;
+```
+
+### Parameters
+
+#### payloads?
+
+`TIn`[]
+
+#### account?
+
+`AccountInstance`
+
+#### retry?
+
+`RetryConfig`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`TOut`\>\>
+
+### Inherited from
+
+[`DivinerQueryFunctions`](#DivinerQueryFunctions).[`divineQuery`](DivinerQueryFunctions.md#divinequery)
+
+***
+
+### address
+
+```ts
+address: BrandedAddress;
+```
+
+### Inherited from
+
+[`DivinerModule`](#DivinerModule).[`address`](DivinerModule.md#address)
+
+***
+
+### config
+
+```ts
+config: TParams["config"];
+```
+
+### Inherited from
+
+[`DivinerModule`](#DivinerModule).[`config`](DivinerModule.md#config)
+
+***
+
+### id
+
+```ts
+id: string;
+```
+
+The name (if specified) or address of the module
+
+### Inherited from
+
+[`DivinerModule`](#DivinerModule).[`id`](DivinerModule.md#id)
+
+***
+
+### modName?
+
+```ts
+optional modName?: string;
+```
+
+### Inherited from
+
+[`DivinerModule`](#DivinerModule).[`modName`](DivinerModule.md#modname)
+
+***
+
+### params
+
+```ts
+params: TParams;
+```
+
+### Inherited from
+
+[`DivinerModule`](#DivinerModule).[`params`](DivinerModule.md#params)
+
+***
+
+### previousHash
+
+```ts
+previousHash: () => Promisable<string | undefined>;
+```
+
+### Returns
+
+`Promisable`\<`string` \| `undefined`\>
+
+### Inherited from
+
+[`DivinerModule`](#DivinerModule).[`previousHash`](DivinerModule.md#previoushash)
+
+***
+
+### queries
+
+```ts
+queries: string[];
+```
+
+### Inherited from
+
+[`DivinerModule`](#DivinerModule).[`queries`](DivinerModule.md#queries)
+
+***
+
+### query
+
+```ts
+query: <T, TConf>(query, payloads?, queryConfig?) => Promisable<ModuleQueryResult>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
+
+#### TConf
+
+`TConf` *extends* `ModuleConfig` = `ModuleConfig`
+
+### Parameters
+
+#### query
+
+`T`
+
+#### payloads?
+
+`Payload`[]
+
+#### queryConfig?
+
+`TConf`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+### Inherited from
+
+[`DivinerModule`](#DivinerModule).[`query`](DivinerModule.md#query)
+
+***
+
+### queryable
+
+```ts
+queryable: <T, TConf>(query, payloads?, queryConfig?) => Promisable<boolean>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
+
+#### TConf
+
+`TConf` *extends* `ModuleConfig` = `ModuleConfig`
+
+### Parameters
+
+#### query
+
+`T`
+
+#### payloads?
+
+`Payload`[]
+
+#### queryConfig?
+
+`TConf`
+
+### Returns
+
+`Promisable`\<`boolean`\>
+
+### Inherited from
+
+[`DivinerModule`](#DivinerModule).[`queryable`](DivinerModule.md#queryable)
+
+***
+
+### manifest
+
+```ts
+manifest: (maxDepth?, ignoreAddresses?) => Promisable<ModuleManifestPayload>;
+```
+
+### Parameters
+
+#### maxDepth?
+
+`number`
+
+#### ignoreAddresses?
+
+`BrandedAddress`[]
+
+### Returns
+
+`Promisable`\<`ModuleManifestPayload`\>
+
+### Inherited from
+
+```ts
+ModuleInstance.manifest
+```
+
+***
+
+### manifestQuery
+
+```ts
+manifestQuery: (account, maxDepth?, ignoreAddresses?) => Promisable<ModuleQueryResult<ModuleManifestPayload>>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+#### maxDepth?
+
+`number`
+
+#### ignoreAddresses?
+
+`BrandedAddress`[]
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
+
+### Inherited from
+
+```ts
+ModuleInstance.manifestQuery
+```
+
+***
+
+### moduleAddress
+
+```ts
+moduleAddress: () => Promisable<(AddressPreviousHashPayload | AddressPayload)[]>;
+```
+
+### Returns
+
+`Promisable`\<(`AddressPreviousHashPayload` \| `AddressPayload`)[]\>
+
+### Inherited from
+
+```ts
+ModuleInstance.moduleAddress
+```
+
+***
+
+### state
+
+```ts
+state: () => Promisable<Payload[]>;
+```
+
+### Returns
+
+`Promisable`\<`Payload`[]\>
+
+### Inherited from
+
+```ts
+ModuleInstance.state
+```
+
+***
+
+### stateQuery
+
+```ts
+stateQuery: (account) => Promisable<ModuleQueryResult>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+### Inherited from
+
+```ts
+ModuleInstance.stateQuery
+```
+
+***
+
+### account?
+
+```ts
+optional account?: AccountInstance;
+```
+
+### Inherited from
+
+```ts
+ModuleInstance.account
+```
+
+***
+
+### addParent
+
+```ts
+addParent: (mod) => void;
+```
+
+### Parameters
+
+#### mod
+
+`ModuleInstance`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+```ts
+ModuleInstance.addParent
+```
+
+***
+
+### addressCache?
+
+```ts
+optional addressCache?: (direction, includePrivate) => AddressToWeakInstanceCache | undefined;
+```
+
+### Parameters
+
+#### direction
+
+`Direction`
+
+#### includePrivate
+
+`boolean`
+
+### Returns
+
+`AddressToWeakInstanceCache` \| `undefined`
+
+### Inherited from
+
+```ts
+ModuleInstance.addressCache
+```
+
+***
+
+### parents
+
+```ts
+parents: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+```ts
+ModuleInstance.parents
+```
+
+***
+
+### privateChildren
+
+```ts
+privateChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+```ts
+ModuleInstance.privateChildren
+```
+
+***
+
+### publicChildren
+
+```ts
+publicChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+```ts
+ModuleInstance.publicChildren
+```
+
+***
+
+### removeParent
+
+```ts
+removeParent: (address) => void;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+```ts
+ModuleInstance.removeParent
+```
+
+***
+
+### siblings
+
+```ts
+siblings: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+```ts
+ModuleInstance.siblings
+```
+
+***
+
+### pipeline?
+
+```ts
+readonly optional pipeline?: "one-to-one" | "one-to-many" | "many-to-one" | "many-to-many";
+```
+
+### Inherited from
+
+```ts
+ModuleInstance.pipeline
+```
+
+***
+
+### status
+
+```ts
+readonly status: ModuleStatus | null;
+```
+
+### Inherited from
+
+```ts
+ModuleInstance.status
+```
+
+***
+
+### priority
+
+```ts
+priority: ObjectResolverPriority;
+```
+
+### Inherited from
+
+```ts
+ModuleInstance.priority
+```
+
+## Methods
+
+### resolve()
+
+### Call Signature
+
+```ts
+resolve<T>(all, options?): Promisable<T[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### all
+
+`"*"`
+
+##### options?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promisable`\<`T`[]\>
+
+#### Inherited from
+
+```ts
+ModuleInstance.resolve
+```
+
+### Call Signature
+
+```ts
+resolve<T>(id, options?): Promisable<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
+
+`Promisable`\<`T` \| `undefined`\>
+
+#### Inherited from
+
+```ts
+ModuleInstance.resolve
+```
+
+### Call Signature
+
+```ts
+resolve<T>(id?, options?): Promisable<T | 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
+
+`Promisable`\<`T` \| `T`[] \| `undefined`\>
+
+#### Inherited from
+
+```ts
+ModuleInstance.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`[]\>
+
+#### Inherited from
+
+```ts
+ModuleInstance.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`\>
+
+#### Inherited from
+
+```ts
+ModuleInstance.resolvePrivate
+```
+
+### Call Signature
+
+```ts
+resolvePrivate<T>(id, options?): Promise<T | 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` \| `T`[] \| `undefined`\>
+
+#### Inherited from
+
+```ts
+ModuleInstance.resolvePrivate
+```
+
+                ### <a id="DivinerModule"></a>DivinerModule
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+## Extends
+
+- `QueryableModule`\<`TParams`, `TEvents`\>
+
+## Extended by
+
+- [`DivinerInstance`](#DivinerInstance)
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`DivinerParams`](#DivinerParams) = [`DivinerParams`](#DivinerParams)
+
+### TEvents
+
+`TEvents` *extends* [`DivinerModuleEventData`](#../type-aliases/DivinerModuleEventData) = [`DivinerModuleEventData`](#../type-aliases/DivinerModuleEventData)
+
+## Properties
+
+### address
+
+```ts
+address: BrandedAddress;
+```
+
+### Inherited from
+
+```ts
+QueryableModule.address
+```
+
+***
+
+### config
+
+```ts
+config: TParams["config"];
+```
+
+### Inherited from
+
+```ts
+QueryableModule.config
+```
+
+***
+
+### id
+
+```ts
+id: string;
+```
+
+The name (if specified) or address of the module
+
+### Inherited from
+
+```ts
+QueryableModule.id
+```
+
+***
+
+### modName?
+
+```ts
+optional modName?: string;
+```
+
+### Inherited from
+
+```ts
+QueryableModule.modName
+```
+
+***
+
+### params
+
+```ts
+params: TParams;
+```
+
+### Inherited from
+
+```ts
+QueryableModule.params
+```
+
+***
+
+### previousHash
+
+```ts
+previousHash: () => Promisable<string | undefined>;
+```
+
+### Returns
+
+`Promisable`\<`string` \| `undefined`\>
+
+### Inherited from
+
+```ts
+QueryableModule.previousHash
+```
+
+***
+
+### queries
+
+```ts
+queries: string[];
+```
+
+### Inherited from
+
+```ts
+QueryableModule.queries
+```
+
+***
+
+### query
+
+```ts
+query: <T, TConf>(query, payloads?, queryConfig?) => Promisable<ModuleQueryResult>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
+
+#### TConf
+
+`TConf` *extends* `ModuleConfig` = `ModuleConfig`
+
+### Parameters
+
+#### query
+
+`T`
+
+#### payloads?
+
+`Payload`[]
+
+#### queryConfig?
+
+`TConf`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+### Inherited from
+
+```ts
+QueryableModule.query
+```
+
+***
+
+### queryable
+
+```ts
+queryable: <T, TConf>(query, payloads?, queryConfig?) => Promisable<boolean>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
+
+#### TConf
+
+`TConf` *extends* `ModuleConfig` = `ModuleConfig`
+
+### Parameters
+
+#### query
+
+`T`
+
+#### payloads?
+
+`Payload`[]
+
+#### queryConfig?
+
+`TConf`
+
+### Returns
+
+`Promisable`\<`boolean`\>
+
+### Inherited from
+
+```ts
+QueryableModule.queryable
+```
+
+                ### <a id="DivinerParams"></a>DivinerParams
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+## Extends
+
+- `QueryableModuleParams`\<`TConfig`\>
+
+## Type Parameters
+
+### TConfig
+
+`TConfig` *extends* `AnyConfigSchema`\<[`DivinerConfig`](#../type-aliases/DivinerConfig)\> = `AnyConfigSchema`\<[`DivinerConfig`](#../type-aliases/DivinerConfig)\>
+
+## Properties
+
+### account?
+
+```ts
+optional account?: AccountInstance | "random";
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.account
+```
+
+***
+
+### addToResolvers?
+
+```ts
+optional addToResolvers?: boolean;
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.addToResolvers
+```
+
+***
+
+### additionalSigners?
+
+```ts
+optional additionalSigners?: AccountInstance[];
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.additionalSigners
+```
+
+***
+
+### allowNameResolution?
+
+```ts
+optional allowNameResolution?: boolean;
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.allowNameResolution
+```
+
+***
+
+### config
+
+```ts
+config: Partial<TConfig>;
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.config
+```
+
+***
+
+### ephemeralQueryAccountEnabled?
+
+```ts
+optional ephemeralQueryAccountEnabled?: boolean;
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.ephemeralQueryAccountEnabled
+```
+
+***
+
+### moduleIdentifierTransformers?
+
+```ts
+optional moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.moduleIdentifierTransformers
+```
+
+***
+
+### statusReporter?
+
+```ts
+optional statusReporter?: ModuleStatusReporter;
+```
+
+Optional reporter for broadcasting status changes.
+
+### Inherited from
+
+```ts
+QueryableModuleParams.statusReporter
+```
+
+                ### <a id="DivinerQueryFunctions"></a>DivinerQueryFunctions
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+## Extended by
+
+- [`DivinerInstance`](#DivinerInstance)
+
+## Type Parameters
+
+### TIn
+
+`TIn` *extends* `Payload` = `Payload`
+
+### TOut
+
+`TOut` *extends* `Payload` = `Payload`
+
+## Properties
+
+### divine
+
+```ts
+divine: (payloads?, retry?) => Promise<DivinerDivineResult<TOut>[]>;
+```
+
+### Parameters
+
+#### payloads?
+
+`TIn`[]
+
+#### retry?
+
+`RetryConfig`
+
+### Returns
+
+`Promise`\<[`DivinerDivineResult`](#../type-aliases/DivinerDivineResult)\<`TOut`\>[]\>
+
+***
+
+### divineQuery
+
+```ts
+divineQuery: (payloads?, account?, retry?) => Promise<ModuleQueryResult<TOut>>;
+```
+
+### Parameters
+
+#### payloads?
+
+`TIn`[]
+
+#### account?
+
+`AccountInstance`
+
+#### retry?
+
+`RetryConfig`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`TOut`\>\>
+
+                ### <a id="ModuleEventSubscription"></a>ModuleEventSubscription
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+## Properties
+
+### sourceEvent
+
+```ts
+sourceEvent: string;
+```
+
+***
+
+### sourceModule
+
+```ts
+sourceModule: ModuleIdentifier;
+```
+
+***
+
+### targetModuleFunction?
+
+```ts
+optional targetModuleFunction?: string;
+```
+
+                ### <a id="SearchableStorage"></a>SearchableStorage
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+Configuration for searchable storage of local state
+
+## Properties
+
+### archivist
+
+```ts
+archivist: ModuleIdentifier;
+```
+
+Name/Address of the archivist where intermediate communications are stored
+
+***
+
+### boundWitnessDiviner?
+
+```ts
+optional boundWitnessDiviner?: ModuleIdentifier;
+```
+
+Name/Address of the diviner where intermediate communications are filtered
+
+***
+
+### payloadDiviner?
+
+```ts
+optional payloadDiviner?: ModuleIdentifier;
+```
+
+Name/Address of the diviner where intermediate communications are filtered
+
+              ### type-aliases
+
+                ### <a id="AttachableDivinerInstanceTypeCheck"></a>AttachableDivinerInstanceTypeCheck
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+type AttachableDivinerInstanceTypeCheck<T> = TypeCheck<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`AttachableDivinerInstance`](#../interfaces/AttachableDivinerInstance) = [`AttachableDivinerInstance`](#../interfaces/AttachableDivinerInstance)
+
+                ### <a id="DivineEndEventArgs"></a>DivineEndEventArgs
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+type DivineEndEventArgs<T, TIn, TOut> = ModuleEventArgs<T, {
+  errors: Error[];
+  inPayloads: TIn[];
+  outPayloads: TOut[];
+}>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+### TIn
+
+`TIn` *extends* `Payload` = `Payload`
+
+### TOut
+
+`TOut` *extends* `Payload` = `Payload`
+
+                ### <a id="DivineStartEventArgs"></a>DivineStartEventArgs
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+type DivineStartEventArgs<T, TIn> = ModuleEventArgs<T, {
+  inPayloads: TIn[];
+}>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+### TIn
+
+`TIn` *extends* `Payload` = `Payload`
+
+                ### <a id="DivinedPayload"></a>DivinedPayload
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+type DivinedPayload<T, S> = Payload<WithAdditional<{
+  sources: Hash[];
+}, T>, S>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `void` \| `EmptyObject` \| `WithSchema` = `void`
+
+### S
+
+`S` *extends* `Schema` \| `void` = `void`
+
+                ### <a id="DivinerConfig"></a>DivinerConfig
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+type DivinerConfig<TConfig, TSchema> = ModuleConfig<WithAdditional<{
+  eventSubscriptions?: ModuleEventSubscription[];
+}, Omit<TConfig, "schema">>, TSchema extends Schema ? TSchema : TConfig extends Payload ? TConfig["schema"] : DivinerConfigSchema>;
+```
+
+## Type Parameters
+
+### TConfig
+
+`TConfig` *extends* `Payload` \| `EmptyObject` \| `void` = `void`
+
+### TSchema
+
+`TSchema` *extends* `Schema` \| `void` = `void`
+
+                ### <a id="DivinerConfigSchema"></a>DivinerConfigSchema
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+type DivinerConfigSchema = typeof DivinerConfigSchema;
+```
+
+                ### <a id="DivinerDivineQuery"></a>DivinerDivineQuery
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+type DivinerDivineQuery = Query<{
+  schema: DivinerDivineQuerySchema;
+}>;
+```
+
+                ### <a id="DivinerDivineQuerySchema"></a>DivinerDivineQuerySchema
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+type DivinerDivineQuerySchema = typeof DivinerDivineQuerySchema;
+```
+
+                ### <a id="DivinerDivineResult"></a>DivinerDivineResult
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+type DivinerDivineResult<T> = WithoutPrivateStorageMeta<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Payload`
+
+                ### <a id="DivinerModuleEventData"></a>DivinerModuleEventData
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+type DivinerModuleEventData<TInstance, TIn, TOut> = DivineEndEventData<TInstance, TIn, TOut> & DivineStartEventData<TInstance, TIn> & ModuleEventData<TInstance>;
+```
+
+## Type Parameters
+
+### TInstance
+
+`TInstance` *extends* `ModuleInstance` = `ModuleInstance`
+
+### TIn
+
+`TIn` *extends* `Payload` = `Payload`
+
+### TOut
+
+`TOut` *extends* `Payload` = `Payload`
+
+                ### <a id="DivinerModuleQueries"></a>DivinerModuleQueries
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+type DivinerModuleQueries = ModuleQueries | DivinerQueries;
+```
+
+                ### <a id="DivinerQueries"></a>DivinerQueries
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+type DivinerQueries = DivinerDivineQuery;
+```
+
+              ### variables
+
+                ### <a id="DivinerConfigSchema"></a>DivinerConfigSchema
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+const DivinerConfigSchema: "network.xyo.diviner.config" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="DivinerDivineQuerySchema"></a>DivinerDivineQuerySchema
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+const DivinerDivineQuerySchema: "network.xyo.query.diviner.divine" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="asAttachableDivinerInstance"></a>asAttachableDivinerInstance
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+const asAttachableDivinerInstance: AsTypeFunction<AttachableDivinerInstance<DivinerParams<AnyConfigSchema<DivinerConfig>>, Payload, Payload, DivinerModuleEventData>>;
+```
+
+                ### <a id="asDivinerInstance"></a>asDivinerInstance
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+const asDivinerInstance: AsTypeFunction<DivinerInstance<DivinerParams<AnyConfigSchema<DivinerConfig>>, Payload, Payload, DivinerModuleEventData>>;
+```
+
+                ### <a id="asDivinerModule"></a>asDivinerModule
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+const asDivinerModule: AsTypeFunction<DivinerModule<DivinerParams<AnyConfigSchema<DivinerConfig>>, DivinerModuleEventData>>;
+```
+
+                ### <a id="isAttachableDivinerInstance"></a>isAttachableDivinerInstance
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+const isAttachableDivinerInstance: TypeCheck<AttachableDivinerInstance>;
+```
+
+                ### <a id="isDivinerInstance"></a>isDivinerInstance
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+const isDivinerInstance: TypeCheck<DivinerInstance>;
+```
+
+                ### <a id="isDivinerModule"></a>isDivinerModule
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+const isDivinerModule: TypeCheck<DivinerModule>;
+```
+
+                ### <a id="requiredAttachableDivinerInstanceFunctions"></a>requiredAttachableDivinerInstanceFunctions
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+const requiredAttachableDivinerInstanceFunctions: ObjectTypeShape = {};
+```
+
+                ### <a id="withDivinerInstance"></a>withDivinerInstance
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+const withDivinerInstance: <R>(mod, closure) => R | undefined;
+```
+
+## Type Parameters
+
+### R
+
+`R`
+
+## Parameters
+
+### mod
+
+`any`
+
+### closure
+
+(`mod`) => `R`
+
+## Returns
+
+`R` \| `undefined`
+
+## Deprecated
+
+use narrowing instead [ if(is) ]
+
+                ### <a id="withDivinerModule"></a>withDivinerModule
+
+[**@xyo-network/diviner-model**](#../README)
+
+***
+
+```ts
+const withDivinerModule: <R>(mod, closure) => R | undefined;
+```
+
+## Type Parameters
+
+### R
+
+`R`
+
+## Parameters
+
+### mod
+
+`any`
+
+### closure
+
+(`mod`) => `R`
+
+## Returns
+
+`R` \| `undefined`
+
+## Deprecated
 
-## Credits
+use narrowing instead [ if(is) ]
 
-[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/diviner-model.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/diviner-model
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/diviner-model.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE