@xyo-network/sdk-js 4.2.1 → 5.0.0

package/docs/classes/ManifestWrapper.md

@@ -1,689 +0,0 @@
-[@xyo-network/sdk-js](../README.md) / ManifestWrapper
-
-# Class: ManifestWrapper\<TManifest\>
-
-Defined in: packages/manifest/packages/wrapper/dist/types/Wrapper.d.ts:8
-
-Provides functionality that can be performed on a PackageManifest
-
-## Extends
-
-- [`PayloadWrapper`](PayloadWrapper.md)\<`TManifest` *extends* [`WithAnySchema`](../type-aliases/WithAnySchema.md)\<[`PackageManifestPayload`](../type-aliases/PackageManifestPayload.md)\> ? `TManifest` : [`WithAnySchema`](../type-aliases/WithAnySchema.md)\<[`PackageManifestPayload`](../type-aliases/PackageManifestPayload.md)\>\>
-
-## Type Parameters
-
-### TManifest
-
-`TManifest` *extends* [`WithAnySchema`](../type-aliases/WithAnySchema.md)\<[`PackageManifestPayload`](../type-aliases/PackageManifestPayload.md)\> \| `void` = `void`
-
-## Constructors
-
-### Constructor
-
-> **new ManifestWrapper**\<`TManifest`\>(`payload`, `wallet`, `locator`, `publicChildren?`, `privateChildren?`, `moduleIdentifierTransformers?`): `ManifestWrapper`\<`TManifest`\>
-
-Defined in: packages/manifest/packages/wrapper/dist/types/Wrapper.d.ts:14
-
-#### Parameters
-
-##### payload
-
-`TManifest` *extends* `object` ? `TManifest`\<`TManifest`\> : `object`
-
-##### wallet
-
-`WalletInstance`
-
-##### locator
-
-[`ModuleFactoryLocatorInstance`](../interfaces/ModuleFactoryLocatorInstance.md)
-
-##### publicChildren?
-
-[`ModuleManifest`](../interfaces/ModuleManifest.md)[]
-
-##### privateChildren?
-
-[`ModuleManifest`](../interfaces/ModuleManifest.md)[]
-
-##### moduleIdentifierTransformers?
-
-[`ModuleIdentifierTransformer`](../interfaces/ModuleIdentifierTransformer.md)[]
-
-#### Returns
-
-`ManifestWrapper`\<`TManifest`\>
-
-#### Overrides
-
-`PayloadWrapper<TManifest extends WithAnySchema<PackageManifestPayload> ? TManifest : WithAnySchema<PackageManifestPayload>>.constructor`
-
-## Properties
-
-### payload
-
-> **payload**: `TManifest` *extends* `object` ? `TManifest`\<`TManifest`\> : `object`
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadWrapperBase.d.ts:8
-
-#### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`payload`](PayloadWrapper.md#payload)
-
-## Methods
-
-### dataHash()
-
-> **dataHash**(): `Promise`\<`Lowercase`\<`string`\>\>
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadWrapperBase.d.ts:16
-
-#### Returns
-
-`Promise`\<`Lowercase`\<`string`\>\>
-
-#### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`dataHash`](PayloadWrapper.md#datahash)
-
-***
-
-### getErrors()
-
-> **getErrors**(): `Promise`\<`Error`[]\>
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadWrapperBase.d.ts:17
-
-#### Returns
-
-`Promise`\<`Error`[]\>
-
-#### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`getErrors`](PayloadWrapper.md#geterrors)
-
-***
-
-### getValid()
-
-> **getValid**(): `Promise`\<`boolean`\>
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadWrapperBase.d.ts:18
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-#### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`getValid`](PayloadWrapper.md#getvalid)
-
-***
-
-### hash()
-
-> **hash**(): `Promise`\<`Lowercase`\<`string`\>\>
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadWrapperBase.d.ts:19
-
-#### Returns
-
-`Promise`\<`Lowercase`\<`string`\>\>
-
-#### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`hash`](PayloadWrapper.md#hash)
-
-***
-
-### loadModule()
-
-> **loadModule**(`wallet`, `node`, `manifest`, `external?`): `Promise`\<`void`\>
-
-Defined in: packages/manifest/packages/wrapper/dist/types/Wrapper.d.ts:15
-
-#### Parameters
-
-##### wallet
-
-`WalletInstance`
-
-##### node
-
-`MemoryNode`
-
-##### manifest
-
-[`ModuleManifest`](../interfaces/ModuleManifest.md)
-
-##### external?
-
-`boolean`
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### loadNodeFromIndex()
-
-> **loadNodeFromIndex**(`index`): `Promise`\<`MemoryNode`\<`BaseParamsFields` & `object`, [`NodeModuleEventData`](../interfaces/NodeModuleEventData.md)\>\>
-
-Defined in: packages/manifest/packages/wrapper/dist/types/Wrapper.d.ts:16
-
-#### Parameters
-
-##### index
-
-`number`
-
-#### Returns
-
-`Promise`\<`MemoryNode`\<`BaseParamsFields` & `object`, [`NodeModuleEventData`](../interfaces/NodeModuleEventData.md)\>\>
-
-***
-
-### loadNodeFromManifest()
-
-> **loadNodeFromManifest**(`wallet`, `manifest`, `path?`, `loadConfigChildren?`): `Promise`\<`MemoryNode`\<`BaseParamsFields` & `object`, [`NodeModuleEventData`](../interfaces/NodeModuleEventData.md)\>\>
-
-Defined in: packages/manifest/packages/wrapper/dist/types/Wrapper.d.ts:17
-
-#### Parameters
-
-##### wallet
-
-`WalletInstance`
-
-##### manifest
-
-[`NodeManifest`](../interfaces/NodeManifest.md)
-
-##### path?
-
-`string`
-
-##### loadConfigChildren?
-
-`boolean`
-
-#### Returns
-
-`Promise`\<`MemoryNode`\<`BaseParamsFields` & `object`, [`NodeModuleEventData`](../interfaces/NodeModuleEventData.md)\>\>
-
-***
-
-### loadNodes()
-
-> **loadNodes**(`node?`): `Promise`\<`MemoryNode`\<`BaseParamsFields` & `object`, [`NodeModuleEventData`](../interfaces/NodeModuleEventData.md)\>[]\>
-
-Defined in: packages/manifest/packages/wrapper/dist/types/Wrapper.d.ts:21
-
-Load the nodes that are defined in the wrapped manifest and optionally attach them to a node
-
-#### Parameters
-
-##### node?
-
-`MemoryNode`\<`BaseParamsFields` & `object`, [`NodeModuleEventData`](../interfaces/NodeModuleEventData.md)\>
-
-#### Returns
-
-`Promise`\<`MemoryNode`\<`BaseParamsFields` & `object`, [`NodeModuleEventData`](../interfaces/NodeModuleEventData.md)\>[]\>
-
-***
-
-### nodeManifest()
-
-> **nodeManifest**(`index`): `object`
-
-Defined in: packages/manifest/packages/wrapper/dist/types/Wrapper.d.ts:22
-
-#### Parameters
-
-##### index
-
-`number`
-
-#### Returns
-
-`object`
-
-##### config
-
-> **config**: `object`
-
-###### config.accountPath?
-
-> `optional` **accountPath**: `string`
-
-###### config.features?
-
-> `optional` **features**: `string`[]
-
-###### config.labels?
-
-> `optional` **labels**: `object`
-
-###### Index Signature
-
-\[`x`: `string`\]: `undefined` \| `string`
-
-###### config.language?
-
-> `optional` **language**: `string`
-
-###### config.name
-
-> **name**: `string`
-
-###### config.os?
-
-> `optional` **os**: `string`
-
-###### config.schema
-
-> **schema**: `string`
-
-##### description?
-
-> `optional` **description**: `string`
-
-##### lazyStart?
-
-> `optional` **lazyStart**: `boolean`
-
-##### modules?
-
-> `optional` **modules**: `object`
-
-###### modules.private?
-
-> `optional` **private**: (`string` \| \{ `config`: \{ `accountPath?`: `string`; `features?`: `string`[]; `labels?`: \{[`x`: `string`]: ... \| ...; \}; `language?`: `string`; `name`: `string`; `os?`: `string`; `schema`: `string`; \}; `description?`: `string`; `lazyStart?`: `boolean`; `status?`: \{ `address`: `any`; `children?`: \{[`x`: ...]: ...; \}; \}; \})[]
-
-###### modules.public?
-
-> `optional` **public**: (`string` \| \{ `config`: \{ `accountPath?`: `string`; `features?`: `string`[]; `labels?`: \{[`x`: `string`]: ... \| ...; \}; `language?`: `string`; `name`: `string`; `os?`: `string`; `schema`: `string`; \}; `description?`: `string`; `lazyStart?`: `boolean`; `status?`: \{ `address`: `any`; `children?`: \{[`x`: ...]: ...; \}; \}; \})[]
-
-##### status?
-
-> `optional` **status**: `object`
-
-###### status.address
-
-> **address**: `any`
-
-###### status.children?
-
-> `optional` **children**: `object`
-
-###### Index Signature
-
-\[`x`: `Lowercase`\<`string`\>\]: `null` \| `string`
-
-***
-
-### schema()
-
-> **schema**(): `string`
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadWrapperBase.d.ts:20
-
-#### Returns
-
-`string`
-
-#### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`schema`](PayloadWrapper.md#schema)
-
-***
-
-### validate()
-
-> **validate**(): `Promise`\<`Error`[]\>
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadDataWrapper.d.ts:16
-
-#### Returns
-
-`Promise`\<`Error`[]\>
-
-#### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`validate`](PayloadWrapper.md#validate)
-
-***
-
-### as()
-
-> `static` **as**\<`T`\>(`value`): `null` \| `PayloadDataWrapper`\<`T`\>
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadDataWrapper.d.ts:9
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
-
-#### Parameters
-
-##### value
-
-`unknown`
-
-#### Returns
-
-`null` \| `PayloadDataWrapper`\<`T`\>
-
-#### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`as`](PayloadWrapper.md#as)
-
-***
-
-### load()
-
-> `static` **load**(`address`): `Promise`\<`null` \| `PayloadDataWrapper`\<[`Payload`](../type-aliases/Payload.md)\>\>
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadDataWrapper.d.ts:10
-
-#### Parameters
-
-##### address
-
-`Lowercase`\<`string`\>
-
-#### Returns
-
-`Promise`\<`null` \| `PayloadDataWrapper`\<[`Payload`](../type-aliases/Payload.md)\>\>
-
-#### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`load`](PayloadWrapper.md#load)
-
-***
-
-### parse()
-
-> `static` **parse**\<`T`\>(`payload?`): `undefined` \| `PayloadDataWrapper`\<`T`\>
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadDataWrapper.d.ts:11
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-
-#### Parameters
-
-##### payload?
-
-`unknown`
-
-#### Returns
-
-`undefined` \| `PayloadDataWrapper`\<`T`\>
-
-#### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`parse`](PayloadWrapper.md#parse)
-
-***
-
-### setLoaderFactory()
-
-> `static` **setLoaderFactory**(`factory`): `void`
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadDataWrapper.d.ts:12
-
-#### Parameters
-
-##### factory
-
-`null` | [`PayloadLoaderFactory`](../type-aliases/PayloadLoaderFactory.md)
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`setLoaderFactory`](PayloadWrapper.md#setloaderfactory)
-
-***
-
-### tryParse()
-
-> `static` **tryParse**\<`T`\>(`obj`): `undefined` \| `PayloadDataWrapper`\<`T`\>
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadDataWrapper.d.ts:13
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-
-#### Parameters
-
-##### obj
-
-`unknown`
-
-#### Returns
-
-`undefined` \| `PayloadDataWrapper`\<`T`\>
-
-#### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`tryParse`](PayloadWrapper.md#tryparse)
-
-***
-
-### unwrap()
-
-#### Call Signature
-
-> `static` **unwrap**\<`TPayload`\>(`payload?`): `undefined` \| `TPayload`
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadWrapperBase.d.ts:11
-
-##### Type Parameters
-
-###### TPayload
-
-`TPayload` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
-
-##### Parameters
-
-###### payload?
-
-`TPayload`
-
-##### Returns
-
-`undefined` \| `TPayload`
-
-##### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`unwrap`](PayloadWrapper.md#unwrap)
-
-#### Call Signature
-
-> `static` **unwrap**\<`TPayload`, `TWrapper`\>(`payload`): `TPayload`
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadWrapperBase.d.ts:12
-
-##### Type Parameters
-
-###### TPayload
-
-`TPayload` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
-
-###### TWrapper
-
-`TWrapper` *extends* [`PayloadWrapperBase`](PayloadWrapperBase.md)\<`TPayload`\> = [`PayloadWrapperBase`](PayloadWrapperBase.md)\<`TPayload`\>
-
-##### Parameters
-
-###### payload
-
-`TPayload` | `TWrapper`
-
-##### Returns
-
-`TPayload`
-
-##### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`unwrap`](PayloadWrapper.md#unwrap)
-
-#### Call Signature
-
-> `static` **unwrap**\<`TPayload`, `TWrapper`\>(`payload`): `TPayload`[]
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadWrapperBase.d.ts:13
-
-##### Type Parameters
-
-###### TPayload
-
-`TPayload` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
-
-###### TWrapper
-
-`TWrapper` *extends* [`PayloadWrapperBase`](PayloadWrapperBase.md)\<`TPayload`\> = [`PayloadWrapperBase`](PayloadWrapperBase.md)\<`TPayload`\>
-
-##### Parameters
-
-###### payload
-
-(`TPayload` \| `TWrapper`)[]
-
-##### Returns
-
-`TPayload`[]
-
-##### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`unwrap`](PayloadWrapper.md#unwrap)
-
-***
-
-### unwrapSinglePayload()
-
-#### Call Signature
-
-> `static` **unwrapSinglePayload**\<`TPayload`\>(`payload?`): `undefined` \| `TPayload`
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadWrapperBase.d.ts:14
-
-##### Type Parameters
-
-###### TPayload
-
-`TPayload` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
-
-##### Parameters
-
-###### payload?
-
-`TPayload`
-
-##### Returns
-
-`undefined` \| `TPayload`
-
-##### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`unwrapSinglePayload`](PayloadWrapper.md#unwrapsinglepayload)
-
-#### Call Signature
-
-> `static` **unwrapSinglePayload**\<`TPayload`, `TWrapper`\>(`payload`): `TPayload`
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadWrapperBase.d.ts:15
-
-##### Type Parameters
-
-###### TPayload
-
-`TPayload` *extends* [`Payload`](../type-aliases/Payload.md) = [`Payload`](../type-aliases/Payload.md)
-
-###### TWrapper
-
-`TWrapper` *extends* [`PayloadWrapperBase`](PayloadWrapperBase.md)\<`TPayload`\> = [`PayloadWrapperBase`](PayloadWrapperBase.md)\<`TPayload`\>
-
-##### Parameters
-
-###### payload
-
-`TPayload` | `TWrapper`
-
-##### Returns
-
-`TPayload`
-
-##### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`unwrapSinglePayload`](PayloadWrapper.md#unwrapsinglepayload)
-
-***
-
-### wrap()
-
-> `static` **wrap**\<`T`\>(`payload?`): `PayloadDataWrapper`\<`T`\>
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadDataWrapper.d.ts:14
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-
-#### Parameters
-
-##### payload?
-
-`T` | `PayloadDataWrapper`\<`T`\>
-
-#### Returns
-
-`PayloadDataWrapper`\<`T`\>
-
-#### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`wrap`](PayloadWrapper.md#wrap)
-
-***
-
-### wrappedMap()
-
-> `static` **wrappedMap**\<`T`\>(`payloads`): `Promise`\<`Record`\<`string`, `PayloadDataWrapper`\<`T`\>\>\>
-
-Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadDataWrapper.d.ts:15
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* [`Payload`](../type-aliases/Payload.md)
-
-#### Parameters
-
-##### payloads
-
-(`T` \| `PayloadDataWrapper`\<`T`\>)[]
-
-#### Returns
-
-`Promise`\<`Record`\<`string`, `PayloadDataWrapper`\<`T`\>\>\>
-
-#### Inherited from
-
-[`PayloadWrapper`](PayloadWrapper.md).[`wrappedMap`](PayloadWrapper.md#wrappedmap)