@xyo-network/sdk-js 4.2.1 → 5.0.0

package/docs/interfaces/ArchivistLabels.md

@@ -1,23 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / ArchivistLabels
-
-# Interface: ArchivistLabels
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/Labels.d.ts:2
-
-Object used to represent labels identifying a resource.
-
-## Extends
-
-- [`Labels`](Labels.md)
-
-## Indexable
-
-\[`key`: `string`\]: `undefined` \| `string`
-
-## Properties
-
-### network.xyo.archivist.persistence.scope
-
-> **scope**: `"memory"` \| `"thread"` \| `"process"` \| `"device"` \| `"network"`
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/Labels.d.ts:3

package/docs/interfaces/ArchivistModuleEventData.md

@@ -1,157 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / ArchivistModuleEventData
-
-# Interface: ArchivistModuleEventData
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/EventData.d.ts:3
-
-## Extends
-
-- `InsertedEventData`.`DeletedEventData`.`ClearedEventData`.[`ModuleEventData`](ModuleEventData.md)
-
-## Indexable
-
-\[`key`: `string` \| `number` \| `symbol`\]: [`EventArgs`](../type-aliases/EventArgs.md)
-
-## Properties
-
-### cleared
-
-> **cleared**: `object`
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/EventModels/Cleared.d.ts:5
-
-#### mod
-
-> **mod**: [`Module`](Module.md)
-
-#### Inherited from
-
-`ClearedEventData.cleared`
-
-***
-
-### deleted
-
-> **deleted**: `object` & `object`
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/EventModels/Deleted.d.ts:8
-
-#### Type declaration
-
-##### mod
-
-> **mod**: [`Module`](Module.md)
-
-#### Type declaration
-
-##### hashes
-
-> **hashes**: `Lowercase`\<`string`\>[]
-
-#### Inherited from
-
-`DeletedEventData.deleted`
-
-***
-
-### inserted
-
-> **inserted**: `object` & `object`
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/EventModels/Inserted.d.ts:8
-
-#### Type declaration
-
-##### mod
-
-> **mod**: [`Module`](Module.md)
-
-#### Type declaration
-
-##### payloads
-
-> **payloads**: [`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<[`Payload`](../type-aliases/Payload.md)\>[]
-
-#### Inherited from
-
-`InsertedEventData.inserted`
-
-***
-
-### moduleBusy
-
-> **moduleBusy**: `object` & `object`
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/EventsModels/ModuleBusy.d.ts:7
-
-#### Type declaration
-
-##### mod
-
-> **mod**: `object`
-
-#### Type declaration
-
-##### busy
-
-> **busy**: `boolean`
-
-#### Inherited from
-
-[`ModuleEventData`](ModuleEventData.md).[`moduleBusy`](ModuleEventData.md#modulebusy)
-
-***
-
-### moduleError
-
-> **moduleError**: `object` & `object`
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/EventsModels/ModuleError.d.ts:7
-
-#### Type declaration
-
-##### mod
-
-> **mod**: `object`
-
-#### Type declaration
-
-##### error
-
-> **error**: `Error`
-
-#### Inherited from
-
-[`ModuleEventData`](ModuleEventData.md).[`moduleError`](ModuleEventData.md#moduleerror)
-
-***
-
-### moduleQueried
-
-> **moduleQueried**: `object` & `object`
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/EventsModels/ModuleQueried.d.ts:12
-
-#### Type declaration
-
-##### mod
-
-> **mod**: `object`
-
-#### Type declaration
-
-##### payloads?
-
-> `optional` **payloads**: [`Payload`](../type-aliases/Payload.md)[]
-
-##### query
-
-> **query**: [`UnsignedQueryBoundWitness`](../type-aliases/UnsignedQueryBoundWitness.md)
-
-##### result
-
-> **result**: [`ModuleQueryResult`](../type-aliases/ModuleQueryResult.md)
-
-#### Inherited from
-
-[`ModuleEventData`](ModuleEventData.md).[`moduleQueried`](ModuleEventData.md#modulequeried)

package/docs/interfaces/ArchivistModuleInstance.md

@@ -1,486 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / ArchivistModuleInstance
-
-# Interface: ArchivistModuleInstance\<TParams, TEventData\>
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/ModuleInstance.d.ts:4
-
-## Extends
-
-- [`Module`](Module.md)\<`TParams`, `TEventData`\>
-
-## Extended by
-
-- [`AttachableArchivistInstance`](AttachableArchivistInstance.md)
-- [`ArchivistInstance`](ArchivistInstance.md)
-
-## Type Parameters
-
-### TParams
-
-`TParams` *extends* [`ModuleParams`](../type-aliases/ModuleParams.md)\<[`AnyConfigSchema`](../type-aliases/AnyConfigSchema.md)\<[`ArchivistConfig`](../type-aliases/ArchivistConfig.md)\>\> = [`ModuleParams`](../type-aliases/ModuleParams.md)\<[`AnyConfigSchema`](../type-aliases/AnyConfigSchema.md)\<[`ArchivistConfig`](../type-aliases/ArchivistConfig.md)\>\>
-
-### TEventData
-
-`TEventData` *extends* [`ArchivistModuleEventData`](ArchivistModuleEventData.md) = [`ArchivistModuleEventData`](ArchivistModuleEventData.md)
-
-## Properties
-
-### address
-
-> **address**: `Lowercase`\<`string`\>
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:10
-
-#### Inherited from
-
-[`Module`](Module.md).[`address`](Module.md#address)
-
-***
-
-### config
-
-> **config**: `TParams`\[`"config"`\]
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:11
-
-#### Inherited from
-
-[`Module`](Module.md).[`config`](Module.md#config)
-
-***
-
-### eventData
-
-> **eventData**: `TEventData`
-
-Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:11
-
-#### Inherited from
-
-[`Module`](Module.md).[`eventData`](Module.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
-
-[`Module`](Module.md).[`id`](Module.md#id)
-
-***
-
-### modName?
-
-> `optional` **modName**: `string`
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:14
-
-#### Inherited from
-
-[`Module`](Module.md).[`modName`](Module.md#modname)
-
-***
-
-### params
-
-> **params**: `TParams`
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:15
-
-#### Inherited from
-
-[`Module`](Module.md).[`params`](Module.md#params)
-
-***
-
-### 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
-
-[`Module`](Module.md).[`previousHash`](Module.md#previoushash)
-
-***
-
-### queries
-
-> **queries**: `string`[]
-
-Defined in: packages/modules/packages/module/packages/model/dist/types/module/ModuleFields.d.ts:17
-
-#### Inherited from
-
-[`Module`](Module.md).[`queries`](Module.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
-
-[`Module`](Module.md).[`query`](Module.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
-
-[`Module`](Module.md).[`queryable`](Module.md#queryable)
-
-***
-
-### 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
-
-[`Module`](Module.md).[`start`](Module.md#start)
-
-***
-
-### 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
-
-[`Module`](Module.md).[`stop`](Module.md#stop)
-
-## 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
-
-[`Module`](Module.md).[`clearListeners`](Module.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
-
-[`Module`](Module.md).[`emit`](Module.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
-
-[`Module`](Module.md).[`emitSerial`](Module.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
-
-[`Module`](Module.md).[`listenerCount`](Module.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
-
-[`Module`](Module.md).[`off`](Module.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
-
-[`Module`](Module.md).[`offAny`](Module.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
-
-[`Module`](Module.md).[`on`](Module.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
-
-[`Module`](Module.md).[`onAny`](Module.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
-
-[`Module`](Module.md).[`once`](Module.md#once)

package/docs/interfaces/ArchivistNextOptions.md

@@ -1,57 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / ArchivistNextOptions
-
-# Interface: ArchivistNextOptions
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/NextOptions.d.ts:8
-
-## Extends
-
-- [`NextOptions`](NextOptions.md)\<`Hash`\>
-
-## Properties
-
-### cursor?
-
-> `optional` **cursor**: `Lowercase`\<`string`\>
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/NextOptions.d.ts:3
-
-#### Inherited from
-
-[`NextOptions`](NextOptions.md).[`cursor`](NextOptions.md#cursor)
-
-***
-
-### limit?
-
-> `optional` **limit**: `number`
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/NextOptions.d.ts:4
-
-#### Inherited from
-
-[`NextOptions`](NextOptions.md).[`limit`](NextOptions.md#limit)
-
-***
-
-### open?
-
-> `optional` **open**: `boolean`
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/NextOptions.d.ts:5
-
-#### Inherited from
-
-[`NextOptions`](NextOptions.md).[`open`](NextOptions.md#open)
-
-***
-
-### order?
-
-> `optional` **order**: `"asc"` \| `"desc"`
-
-Defined in: packages/modules/packages/archivist/packages/model/dist/types/NextOptions.d.ts:6
-
-#### Inherited from
-
-[`NextOptions`](NextOptions.md).[`order`](NextOptions.md#order)