@xyo-network/sdk-js 3.14.16 → 3.14.18

package/docs/interfaces/AttachableNodeInstance.md

@@ -0,0 +1,1309 @@
+[@xyo-network/sdk-js](../README.md) / AttachableNodeInstance
+
+# Interface: AttachableNodeInstance\<TParams, TEventData\>
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/attachable/AttachableInstance.d.ts:7
+
+## Extends
+
+- [`NodeModule`](NodeModule.md)\<`TParams`, `TEventData`\>.[`AttachableModuleInstance`](AttachableModuleInstance.md)\<`TParams`, `TEventData`\>.[`NodeInstance`](NodeInstance.md)\<`TParams`, `TEventData`\>
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`NodeParams`](../type-aliases/NodeParams.md) = [`NodeParams`](../type-aliases/NodeParams.md)
+
+### TEventData
+
+`TEventData` *extends* [`NodeModuleEventData`](NodeModuleEventData.md) = [`NodeModuleEventData`](NodeModuleEventData.md)
+
+## Properties
+
+### account?
+
+> `optional` **account**: `AccountInstance`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/Instance.d.ts:24
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`account`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`addParent`](NodeInstance.md#addparent)
+
+***
+
+### address
+
+> **address**: `Lowercase`\<`string`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:10
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`address`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`addressCache`](NodeInstance.md#addresscache)
+
+***
+
+### attach()
+
+> **attach**: (`id`, `external?`) => `Promise`\<`undefined` \| `Lowercase`\<`string`\>\>
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/instance.d.ts:8
+
+#### Parameters
+
+##### id
+
+`string`
+
+##### external?
+
+`boolean`
+
+#### Returns
+
+`Promise`\<`undefined` \| `Lowercase`\<`string`\>\>
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`attach`](NodeInstance.md#attach)
+
+***
+
+### attached()
+
+> **attached**: () => `Promise`\<`Lowercase`\<`string`\>[]\>
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/instance.d.ts:10
+
+#### Returns
+
+`Promise`\<`Lowercase`\<`string`\>[]\>
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`attached`](NodeInstance.md#attached)
+
+***
+
+### attachedQuery()
+
+> **attachedQuery**: (`account?`) => `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`AddressPayload`](../type-aliases/AddressPayload.md)\>\>
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/instance.d.ts:11
+
+#### Parameters
+
+##### account?
+
+`AccountInstance`
+
+#### Returns
+
+`Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`AddressPayload`](../type-aliases/AddressPayload.md)\>\>
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`attachedQuery`](NodeInstance.md#attachedquery)
+
+***
+
+### attachQuery()
+
+> **attachQuery**: (`id`, `external?`, `account?`) => `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`AddressPayload`](../type-aliases/AddressPayload.md)\>\>
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/instance.d.ts:9
+
+#### Parameters
+
+##### id
+
+`string`
+
+##### external?
+
+`boolean`
+
+##### account?
+
+`AccountInstance`
+
+#### Returns
+
+`Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`AddressPayload`](../type-aliases/AddressPayload.md)\>\>
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`attachQuery`](NodeInstance.md#attachquery)
+
+***
+
+### certify()
+
+> **certify**: (`id`) => `Promise`\<`undefined` \| [`ChildCertificationFields`](ChildCertificationFields.md)\>
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/instance.d.ts:12
+
+#### Parameters
+
+##### id
+
+`string`
+
+#### Returns
+
+`Promise`\<`undefined` \| [`ChildCertificationFields`](ChildCertificationFields.md)\>
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`certify`](NodeInstance.md#certify)
+
+***
+
+### certifyQuery()
+
+> **certifyQuery**: (`id`, `account?`) => `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`ChildCertification`](../type-aliases/ChildCertification.md)\>\>
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/instance.d.ts:13
+
+#### Parameters
+
+##### id
+
+`string`
+
+##### account?
+
+`AccountInstance`
+
+#### Returns
+
+`Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`ChildCertification`](../type-aliases/ChildCertification.md)\>\>
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`certifyQuery`](NodeInstance.md#certifyquery)
+
+***
+
+### config
+
+> **config**: `TParams`\[`"config"`\]
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:11
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`config`](NodeInstance.md#config)
+
+***
+
+### detach()
+
+> **detach**: (`id`) => `Promise`\<`undefined` \| `Lowercase`\<`string`\>\>
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/instance.d.ts:14
+
+#### Parameters
+
+##### id
+
+`string`
+
+#### Returns
+
+`Promise`\<`undefined` \| `Lowercase`\<`string`\>\>
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`detach`](NodeInstance.md#detach)
+
+***
+
+### detachQuery()
+
+> **detachQuery**: (`id`, `account?`) => `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`AddressPayload`](../type-aliases/AddressPayload.md)\>\>
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/instance.d.ts:15
+
+#### Parameters
+
+##### id
+
+`string`
+
+##### account?
+
+`AccountInstance`
+
+#### Returns
+
+`Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`AddressPayload`](../type-aliases/AddressPayload.md)\>\>
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`detachQuery`](NodeInstance.md#detachquery)
+
+***
+
+### 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
+
+[`NodeInstance`](NodeInstance.md).[`eventData`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`id`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`manifest`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`manifestQuery`](NodeInstance.md#manifestquery)
+
+***
+
+### modName?
+
+> `optional` **modName**: `string`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:14
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`modName`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`moduleAddress`](NodeInstance.md#moduleaddress)
+
+***
+
+### params
+
+> **params**: `TParams`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:15
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`params`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`parents`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`pipeline`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`previousHash`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`priority`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`privateChildren`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`publicChildren`](NodeInstance.md#publicchildren)
+
+***
+
+### queries
+
+> **queries**: `string`[]
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:17
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`queries`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`query`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`queryable`](NodeInstance.md#queryable)
+
+***
+
+### register()?
+
+> `optional` **register**: (`mod`) => `Promise`\<`void`\>
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/instance.d.ts:20
+
+#### Parameters
+
+##### mod
+
+[`AttachableModuleInstance`](AttachableModuleInstance.md)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`register`](NodeInstance.md#register)
+
+***
+
+### registered()
+
+> **registered**: () => `Promise`\<`Lowercase`\<`string`\>[]\>
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/instance.d.ts:16
+
+#### Returns
+
+`Promise`\<`Lowercase`\<`string`\>[]\>
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`registered`](NodeInstance.md#registered)
+
+***
+
+### registeredModules()?
+
+> `optional` **registeredModules**: () => [`AttachableModuleInstance`](AttachableModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/instance.d.ts:21
+
+#### Returns
+
+[`AttachableModuleInstance`](AttachableModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`registeredModules`](NodeInstance.md#registeredmodules)
+
+***
+
+### registeredQuery()
+
+> **registeredQuery**: (`account?`) => `Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`AddressPayload`](../type-aliases/AddressPayload.md)\>\>
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/instance.d.ts:17
+
+#### Parameters
+
+##### account?
+
+`AccountInstance`
+
+#### Returns
+
+`Promise`\<[`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)\<[`AddressPayload`](../type-aliases/AddressPayload.md)\>\>
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`registeredQuery`](NodeInstance.md#registeredquery)
+
+***
+
+### 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
+
+[`NodeInstance`](NodeInstance.md).[`removeParent`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`siblings`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`start`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`state`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`stateQuery`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`status`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`stop`](NodeInstance.md#stop)
+
+***
+
+### unregister()?
+
+> `optional` **unregister**: (`mod`) => `Promise`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>\>
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/instance.d.ts:22
+
+#### Parameters
+
+##### mod
+
+[`ModuleInstance`](ModuleInstance.md)
+
+#### Returns
+
+`Promise`\<[`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>\>
+
+#### Inherited from
+
+[`NodeInstance`](NodeInstance.md).[`unregister`](NodeInstance.md#unregister)
+
+***
+
+### 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
+
+### 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
+
+[`NodeInstance`](NodeInstance.md).[`clearListeners`](NodeInstance.md#clearlisteners)
+
+***
+
+### 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
+
+[`NodeInstance`](NodeInstance.md).[`emit`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`emitSerial`](NodeInstance.md#emitserial)
+
+***
+
+### 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
+
+[`NodeInstance`](NodeInstance.md).[`listenerCount`](NodeInstance.md#listenercount)
+
+***
+
+### 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
+
+[`NodeInstance`](NodeInstance.md).[`off`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`offAny`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`on`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`onAny`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`once`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`resolve`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`resolve`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`resolve`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`resolve`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`resolvePrivate`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`resolvePrivate`](NodeInstance.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
+
+[`NodeInstance`](NodeInstance.md).[`resolvePrivate`](NodeInstance.md#resolveprivate)