@xyo-network/sdk-js 3.14.16 → 3.14.18

package/docs/interfaces/AttachableArchivistInstance.md

@@ -0,0 +1,1331 @@
+[@xyo-network/sdk-js](../README.md) / AttachableArchivistInstance
+
+# Interface: AttachableArchivistInstance\<TParams, TEventData, TPayload\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/attachable/AttachableInstance.d.ts:9
+
+## Extends
+
+- [`ArchivistModuleInstance`](ArchivistModuleInstance.md)\<`TParams`, `TEventData`\>.[`AttachableModuleInstance`](AttachableModuleInstance.md)\<`TParams`, `TEventData`\>.[`ArchivistInstance`](ArchivistInstance.md)\<`TParams`, `TEventData`, `TPayload`\>
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`ArchivistParams`](../type-aliases/ArchivistParams.md) = [`ArchivistParams`](../type-aliases/ArchivistParams.md)
+
+### TEventData
+
+`TEventData` *extends* [`ArchivistModuleEventData`](ArchivistModuleEventData.md) = [`ArchivistModuleEventData`](ArchivistModuleEventData.md)
+
+### TPayload
+
+`TPayload` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
+
+## Properties
+
+### account?
+
+> `optional` **account**: `AccountInstance`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:24
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`account`](ArchivistInstance.md#account)
+
+***
+
+### addParent()
+
+> **addParent**: (`mod`) => `void`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:25
+
+#### Parameters
+
+##### mod
+
+[`ModuleInstance`](ModuleInstance.md)
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`addParent`](ArchivistInstance.md#addparent)
+
+***
+
+### address
+
+> **address**: `Lowercase`\<`string`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:10
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`address`](ArchivistInstance.md#address)
+
+***
+
+### addressCache()?
+
+> `optional` **addressCache**: (`direction`, `includePrivate`) => `undefined` \| [`AddressToWeakInstanceCache`](AddressToWeakInstanceCache.md)
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:26
+
+#### Parameters
+
+##### direction
+
+[`Direction`](../type-aliases/Direction.md)
+
+##### includePrivate
+
+`boolean`
+
+#### Returns
+
+`undefined` \| [`AddressToWeakInstanceCache`](AddressToWeakInstanceCache.md)
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`addressCache`](ArchivistInstance.md#addresscache)
+
+***
+
+### config
+
+> **config**: `TParams`\[`"config"`\]
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:11
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`config`](ArchivistInstance.md#config)
+
+***
+
+### downResolver
+
+> `readonly` **downResolver**: [`ModuleResolverInstance`](ModuleResolverInstance.md)
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/attachable/AttachableInstance.d.ts:8
+
+#### Inherited from
+
+[`AttachableModuleInstance`](AttachableModuleInstance.md).[`downResolver`](AttachableModuleInstance.md#downresolver)
+
+***
+
+### eventData
+
+> **eventData**: `TEventData`
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:11
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`eventData`](ArchivistInstance.md#eventdata)
+
+***
+
+### id
+
+> **id**: `string`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:13
+
+The name (if specified) or address of the module
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`id`](ArchivistInstance.md#id)
+
+***
+
+### manifest()
+
+> **manifest**: (`maxDepth?`, `ignoreAddresses?`) => `Promisable`\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleQueryFunctions.d.ts:9
+
+#### Parameters
+
+##### maxDepth?
+
+`number`
+
+##### ignoreAddresses?
+
+`Lowercase`\<`string`\>[]
+
+#### Returns
+
+`Promisable`\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`manifest`](ArchivistInstance.md#manifest)
+
+***
+
+### manifestQuery()
+
+> **manifestQuery**: (`account`, `maxDepth?`, `ignoreAddresses?`) => `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleQueryFunctions.d.ts:10
+
+#### Parameters
+
+##### account
+
+`AccountInstance`
+
+##### maxDepth?
+
+`number`
+
+##### ignoreAddresses?
+
+`Lowercase`\<`string`\>[]
+
+#### Returns
+
+`Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`ModuleManifestPayload`](../type-aliases/ModuleManifestPayload.md)\>\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`manifestQuery`](ArchivistInstance.md#manifestquery)
+
+***
+
+### modName?
+
+> `optional` **modName**: `string`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:14
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`modName`](ArchivistInstance.md#modname)
+
+***
+
+### moduleAddress()
+
+> **moduleAddress**: () => `Promisable`\<([`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md) \| [`AddressPayload`](../type-aliases/AddressPayload.md))[]\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleQueryFunctions.d.ts:11
+
+#### Returns
+
+`Promisable`\<([`AddressPreviousHashPayload`](../type-aliases/AddressPreviousHashPayload.md) \| [`AddressPayload`](../type-aliases/AddressPayload.md))[]\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`moduleAddress`](ArchivistInstance.md#moduleaddress)
+
+***
+
+### params
+
+> **params**: `TParams`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:15
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`params`](ArchivistInstance.md#params)
+
+***
+
+### parents()
+
+> **parents**: () => `Promisable`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:28
+
+#### Returns
+
+`Promisable`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`parents`](ArchivistInstance.md#parents)
+
+***
+
+### pipeline?
+
+> `readonly` `optional` **pipeline**: `"one-to-one"` \| `"one-to-many"` \| `"many-to-one"` \| `"many-to-many"`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:35
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`pipeline`](ArchivistInstance.md#pipeline)
+
+***
+
+### previousHash()
+
+> **previousHash**: () => `Promisable`\<`undefined` \| `string`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:16
+
+#### Returns
+
+`Promisable`\<`undefined` \| `string`\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`previousHash`](ArchivistInstance.md#previoushash)
+
+***
+
+### priority
+
+> **priority**: [`ObjectResolverPriority`](../type-aliases/ObjectResolverPriority.md)
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:16
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`priority`](ArchivistInstance.md#priority)
+
+***
+
+### privateChildren()
+
+> **privateChildren**: () => `Promisable`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:29
+
+#### Returns
+
+`Promisable`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`privateChildren`](ArchivistInstance.md#privatechildren)
+
+***
+
+### privateResolver
+
+> `readonly` **privateResolver**: [`ModuleResolverInstance`](ModuleResolverInstance.md)
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/attachable/AttachableInstance.d.ts:9
+
+#### Inherited from
+
+[`AttachableModuleInstance`](AttachableModuleInstance.md).[`privateResolver`](AttachableModuleInstance.md#privateresolver)
+
+***
+
+### publicChildren()
+
+> **publicChildren**: () => `Promisable`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:30
+
+#### Returns
+
+`Promisable`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`publicChildren`](ArchivistInstance.md#publicchildren)
+
+***
+
+### queries
+
+> **queries**: `string`[]
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:17
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`queries`](ArchivistInstance.md#queries)
+
+***
+
+### query()
+
+> **query**: \<`T`, `TConf`\>(`query`, `payloads?`, `queryConfig?`) => `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:18
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md) = [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)
+
+##### TConf
+
+`TConf` *extends* [`ModuleConfig`](../type-aliases/ModuleConfig.md) = [`ModuleConfig`](../type-aliases/ModuleConfig.md)
+
+#### Parameters
+
+##### query
+
+`T`
+
+##### payloads?
+
+[`Payload`](../type-aliases/Payload.md)[]
+
+##### queryConfig?
+
+`TConf`
+
+#### Returns
+
+`Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`query`](ArchivistInstance.md#query)
+
+***
+
+### queryable()
+
+> **queryable**: \<`T`, `TConf`\>(`query`, `payloads?`, `queryConfig?`) => `Promisable`\<`boolean`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:19
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md) = [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)
+
+##### TConf
+
+`TConf` *extends* [`ModuleConfig`](../type-aliases/ModuleConfig.md) = [`ModuleConfig`](../type-aliases/ModuleConfig.md)
+
+#### Parameters
+
+##### query
+
+`T`
+
+##### payloads?
+
+[`Payload`](../type-aliases/Payload.md)[]
+
+##### queryConfig?
+
+`TConf`
+
+#### Returns
+
+`Promisable`\<`boolean`\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`queryable`](ArchivistInstance.md#queryable)
+
+***
+
+### removeParent()
+
+> **removeParent**: (`address`) => `void`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:31
+
+#### Parameters
+
+##### address
+
+`Lowercase`\<`string`\>
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`removeParent`](ArchivistInstance.md#removeparent)
+
+***
+
+### siblings()
+
+> **siblings**: () => `Promisable`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:32
+
+#### Returns
+
+`Promisable`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`siblings`](ArchivistInstance.md#siblings)
+
+***
+
+### start()?
+
+> `optional` **start**: () => `Promisable`\<`boolean`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:20
+
+#### Returns
+
+`Promisable`\<`boolean`\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`start`](ArchivistInstance.md#start)
+
+***
+
+### state()
+
+> **state**: () => `Promisable`\<[`Payload`](../type-aliases/Payload.md)[]\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleQueryFunctions.d.ts:12
+
+#### Returns
+
+`Promisable`\<[`Payload`](../type-aliases/Payload.md)[]\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`state`](ArchivistInstance.md#state)
+
+***
+
+### stateQuery()
+
+> **stateQuery**: (`account`) => `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleQueryFunctions.d.ts:13
+
+#### Parameters
+
+##### account
+
+`AccountInstance`
+
+#### Returns
+
+`Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`stateQuery`](ArchivistInstance.md#statequery)
+
+***
+
+### status
+
+> `readonly` **status**: [`ModuleStatus`](../type-aliases/ModuleStatus.md)
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:36
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`status`](ArchivistInstance.md#status)
+
+***
+
+### stop()?
+
+> `optional` **stop**: () => `Promisable`\<`boolean`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:21
+
+#### Returns
+
+`Promisable`\<`boolean`\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`stop`](ArchivistInstance.md#stop)
+
+***
+
+### upResolver
+
+> `readonly` **upResolver**: [`ModuleResolverInstance`](ModuleResolverInstance.md)
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/attachable/AttachableInstance.d.ts:10
+
+#### Inherited from
+
+[`AttachableModuleInstance`](AttachableModuleInstance.md).[`upResolver`](AttachableModuleInstance.md#upresolver)
+
+## Methods
+
+### all()
+
+> **all**(): `PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TPayload`\>\>\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:4
+
+#### Returns
+
+`PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TPayload`\>\>\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`all`](ArchivistInstance.md#all)
+
+***
+
+### allQuery()
+
+> **allQuery**(`account?`): `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/RawQueryFunctions.d.ts:8
+
+#### Parameters
+
+##### account?
+
+`AccountInstance`
+
+#### Returns
+
+`Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`allQuery`](ArchivistInstance.md#allquery)
+
+***
+
+### clear()
+
+> **clear**(): `Promisable`\<`void`\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:11
+
+#### Returns
+
+`Promisable`\<`void`\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`clear`](ArchivistInstance.md#clear)
+
+***
+
+### clearListeners()
+
+> **clearListeners**(`eventNames`): `void`
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:12
+
+#### Parameters
+
+##### eventNames
+
+keyof `TEventData` | keyof `TEventData`[]
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`clearListeners`](ArchivistInstance.md#clearlisteners)
+
+***
+
+### clearQuery()
+
+> **clearQuery**(`account?`): `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/RawQueryFunctions.d.ts:9
+
+#### Parameters
+
+##### account?
+
+`AccountInstance`
+
+#### Returns
+
+`Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`clearQuery`](ArchivistInstance.md#clearquery)
+
+***
+
+### commit()
+
+> **commit**(): `PromisableArray`\<`TPayload`\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:16
+
+#### Returns
+
+`PromisableArray`\<`TPayload`\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`commit`](ArchivistInstance.md#commit)
+
+***
+
+### commitQuery()
+
+> **commitQuery**(`account?`): `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/RawQueryFunctions.d.ts:10
+
+#### Parameters
+
+##### account?
+
+`AccountInstance`
+
+#### Returns
+
+`Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`commitQuery`](ArchivistInstance.md#commitquery)
+
+***
+
+### delete()
+
+> **delete**(`ids`): `PromisableArray`\<`Lowercase`\<`string`\>\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:12
+
+#### Parameters
+
+##### ids
+
+`Lowercase`\<`string`\>[]
+
+#### Returns
+
+`PromisableArray`\<`Lowercase`\<`string`\>\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`delete`](ArchivistInstance.md#delete)
+
+***
+
+### deleteQuery()
+
+> **deleteQuery**(`hashes`, `account?`): `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/RawQueryFunctions.d.ts:11
+
+#### Parameters
+
+##### hashes
+
+`Lowercase`\<`string`\>[]
+
+##### account?
+
+`AccountInstance`
+
+#### Returns
+
+`Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`deleteQuery`](ArchivistInstance.md#deletequery)
+
+***
+
+### emit()
+
+> **emit**\<`TEventName`\>(`eventName`, `eventArgs`): `Promise`\<`void`\>
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:13
+
+#### Type Parameters
+
+##### TEventName
+
+`TEventName` *extends* `string` \| `number` \| `symbol`
+
+#### Parameters
+
+##### eventName
+
+`TEventName`
+
+##### eventArgs
+
+`TEventData`\[`TEventName`\]
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`emit`](ArchivistInstance.md#emit)
+
+***
+
+### emitSerial()
+
+> **emitSerial**\<`TEventName`\>(`eventName`, `eventArgs`): `Promise`\<`void`\>
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:14
+
+#### Type Parameters
+
+##### TEventName
+
+`TEventName` *extends* `string` \| `number` \| `symbol`
+
+#### Parameters
+
+##### eventName
+
+`TEventName`
+
+##### eventArgs
+
+`TEventData`\[`TEventName`\]
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`emitSerial`](ArchivistInstance.md#emitserial)
+
+***
+
+### get()
+
+> **get**(`ids`): `PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TPayload`\>\>\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:7
+
+#### Parameters
+
+##### ids
+
+`Lowercase`\<`string`\>[]
+
+#### Returns
+
+`PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TPayload`\>\>\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`get`](ArchivistInstance.md#get)
+
+***
+
+### getQuery()
+
+> **getQuery**(`hashes`, `account?`): `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/RawQueryFunctions.d.ts:12
+
+#### Parameters
+
+##### hashes
+
+`Lowercase`\<`string`\>[]
+
+##### account?
+
+`AccountInstance`
+
+#### Returns
+
+`Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`getQuery`](ArchivistInstance.md#getquery)
+
+***
+
+### insert()
+
+> **insert**(`item`): `PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TPayload`\>\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:13
+
+#### Parameters
+
+##### item
+
+`TPayload` & `DeepRestrictToStringKeys`\<[`SchemaFields`](SchemaFields.md) & [`PayloadFields`](PayloadFields.md) & `object`\> & `Partial`\<[`PayloadMetaFields`](PayloadMetaFields.md)\>[]
+
+#### Returns
+
+`PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TPayload`\>\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`insert`](ArchivistInstance.md#insert)
+
+***
+
+### insertQuery()
+
+> **insertQuery**(`payloads`, `account?`): `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/RawQueryFunctions.d.ts:13
+
+#### Parameters
+
+##### payloads
+
+[`Payload`](../type-aliases/Payload.md)[]
+
+##### account?
+
+`AccountInstance`
+
+#### Returns
+
+`Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`insertQuery`](ArchivistInstance.md#insertquery)
+
+***
+
+### listenerCount()
+
+> **listenerCount**(`eventNames`): `number`
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:15
+
+#### Parameters
+
+##### eventNames
+
+keyof `TEventData` | keyof `TEventData`[]
+
+#### Returns
+
+`number`
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`listenerCount`](ArchivistInstance.md#listenercount)
+
+***
+
+### next()
+
+> **next**(`options?`): `PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TPayload`\>\>\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:8
+
+#### Parameters
+
+##### options?
+
+[`NextOptions`](NextOptions.md)\<`Lowercase`\<`string`\>\>
+
+#### Returns
+
+`PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TPayload`\>\>\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`next`](ArchivistInstance.md#next)
+
+***
+
+### nextQuery()
+
+> **nextQuery**(`options?`, `account?`): `Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/RawQueryFunctions.d.ts:14
+
+#### Parameters
+
+##### options?
+
+[`ArchivistNextOptions`](ArchivistNextOptions.md)
+
+##### account?
+
+`AccountInstance`
+
+#### Returns
+
+`Promisable`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\>
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`nextQuery`](ArchivistInstance.md#nextquery)
+
+***
+
+### off()
+
+> **off**\<`TEventName`\>(`eventNames`, `listener`): `void`
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:16
+
+#### Type Parameters
+
+##### TEventName
+
+`TEventName` *extends* `string` \| `number` \| `symbol`
+
+#### Parameters
+
+##### eventNames
+
+`TEventName` | `TEventName`[]
+
+##### listener
+
+[`EventListener`](../type-aliases/EventListener.md)\<`TEventData`\[`TEventName`\]\>
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`off`](ArchivistInstance.md#off)
+
+***
+
+### offAny()
+
+> **offAny**(`listener`): `void`
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:17
+
+#### Parameters
+
+##### listener
+
+`Promise`\<`void`\> | [`EventAnyListener`](../type-aliases/EventAnyListener.md)\<[`EventArgs`](../type-aliases/EventArgs.md)\>
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`offAny`](ArchivistInstance.md#offany)
+
+***
+
+### on()
+
+> **on**\<`TEventName`\>(`eventNames`, `listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:18
+
+#### Type Parameters
+
+##### TEventName
+
+`TEventName` *extends* `string` \| `number` \| `symbol`
+
+#### Parameters
+
+##### eventNames
+
+`TEventName` | `TEventName`[]
+
+##### listener
+
+[`EventListener`](../type-aliases/EventListener.md)\<`TEventData`\[`TEventName`\]\>
+
+#### Returns
+
+[`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`on`](ArchivistInstance.md#on)
+
+***
+
+### onAny()
+
+> **onAny**(`listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:19
+
+#### Parameters
+
+##### listener
+
+[`EventAnyListener`](../type-aliases/EventAnyListener.md)
+
+#### Returns
+
+[`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`onAny`](ArchivistInstance.md#onany)
+
+***
+
+### once()
+
+> **once**\<`TEventName`\>(`eventName`, `listener`): [`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:20
+
+#### Type Parameters
+
+##### TEventName
+
+`TEventName` *extends* `string` \| `number` \| `symbol`
+
+#### Parameters
+
+##### eventName
+
+`TEventName`
+
+##### listener
+
+[`EventListener`](../type-aliases/EventListener.md)\<`TEventData`\[`TEventName`\]\>
+
+#### Returns
+
+[`EventUnsubscribeFunction`](../type-aliases/EventUnsubscribeFunction.md)
+
+#### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`once`](ArchivistInstance.md#once)
+
+***
+
+### resolve()
+
+#### Call Signature
+
+> **resolve**\<`T`\>(): `Promisable`\<`undefined` \| `T`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:18
+
+##### Type Parameters
+
+###### T
+
+`T` *extends* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>
+
+##### Returns
+
+`Promisable`\<`undefined` \| `T`\>
+
+##### Deprecated
+
+do not pass undefined.  If trying to get all, pass '*'
+
+##### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`resolve`](ArchivistInstance.md#resolve)
+
+#### Call Signature
+
+> **resolve**\<`T`\>(`all`, `options?`): `Promisable`\<`T`[]\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:19
+
+##### Type Parameters
+
+###### T
+
+`T` *extends* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>
+
+##### Parameters
+
+###### all
+
+`"*"`
+
+###### options?
+
+[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
+
+##### Returns
+
+`Promisable`\<`T`[]\>
+
+##### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`resolve`](ArchivistInstance.md#resolve)
+
+#### Call Signature
+
+> **resolve**\<`T`\>(`id`, `options?`): `Promisable`\<`undefined` \| `T`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:20
+
+##### Type Parameters
+
+###### T
+
+`T` *extends* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>
+
+##### Parameters
+
+###### id
+
+`string`
+
+###### options?
+
+[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
+
+##### Returns
+
+`Promisable`\<`undefined` \| `T`\>
+
+##### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`resolve`](ArchivistInstance.md#resolve)
+
+#### Call Signature
+
+> **resolve**\<`T`\>(`id?`, `options?`): `Promisable`\<`undefined` \| `T` \| `T`[]\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:21
+
+##### Type Parameters
+
+###### T
+
+`T` *extends* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>
+
+##### Parameters
+
+###### id?
+
+`string`
+
+###### options?
+
+[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
+
+##### Returns
+
+`Promisable`\<`undefined` \| `T` \| `T`[]\>
+
+##### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`resolve`](ArchivistInstance.md#resolve)
+
+***
+
+### resolvePrivate()
+
+#### Call Signature
+
+> **resolvePrivate**\<`T`\>(`all`, `options?`): `Promise`\<`T`[]\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:22
+
+##### Type Parameters
+
+###### T
+
+`T` *extends* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>
+
+##### Parameters
+
+###### all
+
+`"*"`
+
+###### options?
+
+[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
+
+##### Returns
+
+`Promise`\<`T`[]\>
+
+##### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`resolvePrivate`](ArchivistInstance.md#resolveprivate)
+
+#### Call Signature
+
+> **resolvePrivate**\<`T`\>(`id`, `options?`): `Promise`\<`undefined` \| `T`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:23
+
+##### Type Parameters
+
+###### T
+
+`T` *extends* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>
+
+##### Parameters
+
+###### id
+
+`string`
+
+###### options?
+
+[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
+
+##### Returns
+
+`Promise`\<`undefined` \| `T`\>
+
+##### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`resolvePrivate`](ArchivistInstance.md#resolveprivate)
+
+#### Call Signature
+
+> **resolvePrivate**\<`T`\>(`id`, `options?`): `Promise`\<`undefined` \| `T` \| `T`[]\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ObjectResolver.d.ts:24
+
+##### Type Parameters
+
+###### T
+
+`T` *extends* [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\> = [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>
+
+##### Parameters
+
+###### id
+
+`string`
+
+###### options?
+
+[`ObjectFilterOptions`](ObjectFilterOptions.md)\<`T`\>
+
+##### Returns
+
+`Promise`\<`undefined` \| `T` \| `T`[]\>
+
+##### Inherited from
+
+[`ArchivistInstance`](ArchivistInstance.md).[`resolvePrivate`](ArchivistInstance.md#resolveprivate)