@xyo-network/sdk-js 3.14.16 → 3.14.17

package/docs/interfaces/EventFunctions.md

@@ -0,0 +1,235 @@
+[@xyo-network/sdk-js](../README.md) / EventFunctions
+
+# Interface: EventFunctions\<TEventData\>
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:10
+
+## Extended by
+
+- [`Module`](Module.md)
+
+## Type Parameters
+
+### TEventData
+
+`TEventData` *extends* [`EventData`](../type-aliases/EventData.md)
+
+## Properties
+
+### eventData
+
+> **eventData**: `TEventData`
+
+Defined in: packages/modules/packages/module/packages/events/dist/types/model/Event.d.ts:11
+
+## 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`
+
+***
+
+### 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`\>
+
+***
+
+### 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`\>
+
+***
+
+### 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`
+
+***
+
+### 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`
+
+***
+
+### 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`
+
+***
+
+### 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)
+
+***
+
+### 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)
+
+***
+
+### 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)

package/docs/interfaces/ExposedEventData.md

@@ -0,0 +1,43 @@
+[@xyo-network/sdk-js](../README.md) / ExposedEventData
+
+# Interface: ExposedEventData\<T\>
+
+Defined in: packages/modules/packages/bridge/packages/model/dist/types/Events/Exposed.d.ts:6
+
+## Extends
+
+- [`EventData`](../type-aliases/EventData.md)
+
+## Extended by
+
+- [`BridgeModuleEventData`](BridgeModuleEventData.md)
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Module`](Module.md) = [`Module`](Module.md)
+
+## Indexable
+
+\[`key`: `string` \| `number` \| `symbol`\]: [`EventArgs`](../type-aliases/EventArgs.md)
+
+## Properties
+
+### exposed
+
+> **exposed**: `object` & `object`
+
+Defined in: packages/modules/packages/bridge/packages/model/dist/types/Events/Exposed.d.ts:7
+
+#### Type declaration
+
+##### mod
+
+> **mod**: `T`
+
+#### Type declaration
+
+##### modules
+
+> **modules**: [`ModuleInstance`](ModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](ModuleEventData.md)\<`object`\>\>[]

package/docs/interfaces/FetchedPayload.md

@@ -0,0 +1,27 @@
+[@xyo-network/sdk-js](../README.md) / FetchedPayload
+
+# Interface: FetchedPayload\<T\>
+
+Defined in: packages/protocol/packages/payload/packages/huri/dist/types/Huri.d.ts:9
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
+
+## Properties
+
+### huri?
+
+> `optional` **huri**: [`Huri`](../classes/Huri.md)\<[`Payload`](../type-aliases/Payload.md)\>
+
+Defined in: packages/protocol/packages/payload/packages/huri/dist/types/Huri.d.ts:10
+
+***
+
+### payload
+
+> **payload**: `T`
+
+Defined in: packages/protocol/packages/payload/packages/huri/dist/types/Huri.d.ts:11

package/docs/interfaces/FullArchivist.md

@@ -0,0 +1,147 @@
+[@xyo-network/sdk-js](../README.md) / FullArchivist
+
+# Interface: FullArchivist\<TReadResponse, TWriteResponse, TWrite, TId\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/PayloadArchivist.d.ts:14
+
+## Extends
+
+- [`ReadWriteArchivist`](ReadWriteArchivist.md)\<`TReadResponse`, `TWriteResponse`, `TWrite`, `TId`\>.[`StashArchivist`](StashArchivist.md)\<`TWriteResponse`\>
+
+## Type Parameters
+
+### TReadResponse
+
+`TReadResponse` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
+
+### TWriteResponse
+
+`TWriteResponse` *extends* [`Payload`](../type-aliases/Payload.md) = `TReadResponse`
+
+### TWrite
+
+`TWrite` *extends* [`Payload`](../type-aliases/Payload.md) = `TReadResponse`
+
+### TId
+
+`TId` = `Hash`
+
+## Methods
+
+### clear()
+
+> **clear**(): `Promisable`\<`void`\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:11
+
+#### Returns
+
+`Promisable`\<`void`\>
+
+#### Inherited from
+
+[`ReadWriteArchivist`](ReadWriteArchivist.md).[`clear`](ReadWriteArchivist.md#clear)
+
+***
+
+### commit()
+
+> **commit**(): `PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TWriteResponse`\>\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:16
+
+#### Returns
+
+`PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TWriteResponse`\>\>
+
+#### Inherited from
+
+[`StashArchivist`](StashArchivist.md).[`commit`](StashArchivist.md#commit)
+
+***
+
+### delete()
+
+> **delete**(`ids`): `PromisableArray`\<`TId`\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:12
+
+#### Parameters
+
+##### ids
+
+`TId`[]
+
+#### Returns
+
+`PromisableArray`\<`TId`\>
+
+#### Inherited from
+
+[`ReadWriteArchivist`](ReadWriteArchivist.md).[`delete`](ReadWriteArchivist.md#delete)
+
+***
+
+### get()
+
+> **get**(`ids`): `PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TReadResponse`\>\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:7
+
+#### Parameters
+
+##### ids
+
+`TId`[]
+
+#### Returns
+
+`PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TReadResponse`\>\>
+
+#### Inherited from
+
+[`ReadWriteArchivist`](ReadWriteArchivist.md).[`get`](ReadWriteArchivist.md#get)
+
+***
+
+### insert()
+
+> **insert**(`item`): `PromisableArray`\<`TWriteResponse`\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:13
+
+#### Parameters
+
+##### item
+
+`TWrite`[]
+
+#### Returns
+
+`PromisableArray`\<`TWriteResponse`\>
+
+#### Inherited from
+
+[`ReadWriteArchivist`](ReadWriteArchivist.md).[`insert`](ReadWriteArchivist.md#insert)
+
+***
+
+### next()
+
+> **next**(`options?`): `PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TReadResponse`\>\>
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/ArchivistFunctions.d.ts:8
+
+#### Parameters
+
+##### options?
+
+[`NextOptions`](NextOptions.md)\<`TId`\>
+
+#### Returns
+
+`PromisableArray`\<[`WithStorageMeta`](../type-aliases/WithStorageMeta.md)\<`TReadResponse`\>\>
+
+#### Inherited from
+
+[`ReadWriteArchivist`](ReadWriteArchivist.md).[`next`](ReadWriteArchivist.md#next)

package/docs/interfaces/HashStorageMeta.md

@@ -0,0 +1,33 @@
+[@xyo-network/sdk-js](../README.md) / HashStorageMeta
+
+# Interface: HashStorageMeta
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/Hash.d.ts:4
+
+## Extends
+
+- [`DataHashStorageMeta`](DataHashStorageMeta.md)
+
+## Extended by
+
+- [`StorageMeta`](StorageMeta.md)
+
+## Properties
+
+### \_dataHash
+
+> **\_dataHash**: `Lowercase`\<`string`\>
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/DataHash.d.ts:4
+
+#### Inherited from
+
+[`DataHashStorageMeta`](DataHashStorageMeta.md).[`_dataHash`](DataHashStorageMeta.md#_datahash)
+
+***
+
+### \_hash
+
+> **\_hash**: `Lowercase`\<`string`\>
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/Hash.d.ts:5

package/docs/interfaces/HuriOptions.md

@@ -0,0 +1,21 @@
+[@xyo-network/sdk-js](../README.md) / HuriOptions
+
+# Interface: HuriOptions
+
+Defined in: packages/protocol/packages/payload/packages/huri/dist/types/Huri.d.ts:5
+
+## Properties
+
+### archivistUri?
+
+> `optional` **archivistUri**: `string`
+
+Defined in: packages/protocol/packages/payload/packages/huri/dist/types/Huri.d.ts:6
+
+***
+
+### token?
+
+> `optional` **token**: `string`
+
+Defined in: packages/protocol/packages/payload/packages/huri/dist/types/Huri.d.ts:7

package/docs/interfaces/JobEndEventData.md

@@ -0,0 +1,47 @@
+[@xyo-network/sdk-js](../README.md) / JobEndEventData
+
+# Interface: JobEndEventData\<T\>
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/EventsModels/JobEnd.d.ts:9
+
+## Extends
+
+- [`EventData`](../type-aliases/EventData.md)
+
+## Extended by
+
+- [`SentinelModuleEventData`](SentinelModuleEventData.md)
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Module`](Module.md) = [`Module`](Module.md)
+
+## Indexable
+
+\[`key`: `string` \| `number` \| `symbol`\]: [`EventArgs`](../type-aliases/EventArgs.md)
+
+## Properties
+
+### jobEnd
+
+> **jobEnd**: `object` & `object`
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/EventsModels/JobEnd.d.ts:10
+
+#### Type declaration
+
+##### mod
+
+> **mod**: `T`
+
+#### Type declaration
+
+##### finalResult?
+
+> `optional` **finalResult**: `Record`\<`Lowercase`\<`string`\>, [`Payload`](../type-aliases/Payload.md)[]\>
+
+##### inPayloads?
+
+> `optional` **inPayloads**: [`Payload`](../type-aliases/Payload.md)[]

package/docs/interfaces/JobStartEventData.md

@@ -0,0 +1,43 @@
+[@xyo-network/sdk-js](../README.md) / JobStartEventData
+
+# Interface: JobStartEventData\<T\>
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/EventsModels/JobStart.d.ts:7
+
+## Extends
+
+- [`EventData`](../type-aliases/EventData.md)
+
+## Extended by
+
+- [`SentinelModuleEventData`](SentinelModuleEventData.md)
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Module`](Module.md) = [`Module`](Module.md)
+
+## Indexable
+
+\[`key`: `string` \| `number` \| `symbol`\]: [`EventArgs`](../type-aliases/EventArgs.md)
+
+## Properties
+
+### jobStart
+
+> **jobStart**: `object` & `object`
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/EventsModels/JobStart.d.ts:8
+
+#### Type declaration
+
+##### mod
+
+> **mod**: `T`
+
+#### Type declaration
+
+##### inPayloads?
+
+> `optional` **inPayloads**: [`Payload`](../type-aliases/Payload.md)[]

package/docs/interfaces/Labels.md

@@ -0,0 +1,15 @@
+[@xyo-network/sdk-js](../README.md) / Labels
+
+# Interface: Labels
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/Labels/Labels.d.ts:4
+
+Object used to represent labels identifying a resource.
+
+## Extended by
+
+- [`ArchivistLabels`](ArchivistLabels.md)
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `string`

package/docs/interfaces/Manifest.md

@@ -0,0 +1,18 @@
+[@xyo-network/sdk-js](../README.md) / Manifest
+
+# Interface: Manifest
+
+Defined in: packages/manifest/packages/model/dist/types/Manifest.d.ts:3
+
+## Extended by
+
+- [`ModuleManifest`](ModuleManifest.md)
+- [`PackageManifest`](PackageManifest.md)
+
+## Properties
+
+### description?
+
+> `optional` **description**: `string`
+
+Defined in: packages/manifest/packages/model/dist/types/Manifest.d.ts:4

package/docs/interfaces/ManifestWrapperExParams.md

@@ -0,0 +1,45 @@
+[@xyo-network/sdk-js](../README.md) / ManifestWrapperExParams
+
+# Interface: ManifestWrapperExParams
+
+Defined in: packages/manifest/packages/wrapper/dist/types/WrapperEx.d.ts:7
+
+## Properties
+
+### locator
+
+> **locator**: [`ModuleFactoryLocatorInstance`](ModuleFactoryLocatorInstance.md)
+
+Defined in: packages/manifest/packages/wrapper/dist/types/WrapperEx.d.ts:8
+
+***
+
+### moduleIdentifierTransformers?
+
+> `optional` **moduleIdentifierTransformers**: [`ModuleIdentifierTransformer`](ModuleIdentifierTransformer.md)[]
+
+Defined in: packages/manifest/packages/wrapper/dist/types/WrapperEx.d.ts:9
+
+***
+
+### privateChildren?
+
+> `optional` **privateChildren**: [`ModuleManifest`](ModuleManifest.md)[]
+
+Defined in: packages/manifest/packages/wrapper/dist/types/WrapperEx.d.ts:10
+
+***
+
+### publicChildren?
+
+> `optional` **publicChildren**: [`ModuleManifest`](ModuleManifest.md)[]
+
+Defined in: packages/manifest/packages/wrapper/dist/types/WrapperEx.d.ts:11
+
+***
+
+### wallet
+
+> **wallet**: `WalletInstance`
+
+Defined in: packages/manifest/packages/wrapper/dist/types/WrapperEx.d.ts:12