@xyo-network/sdk-js 3.14.16 → 3.14.18

package/docs/variables/isWitnessModule.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / isWitnessModule
+
+# Variable: isWitnessModule
+
+> `const` **isWitnessModule**: [`ModuleTypeCheck`](../type-aliases/ModuleTypeCheck.md)
+
+Defined in: packages/modules/packages/witness/packages/model/dist/types/typeChecks.d.ts:14

package/docs/variables/mixinResolverEventEmitter.md

@@ -0,0 +1,23 @@
+[@xyo-network/sdk-js](../README.md) / mixinResolverEventEmitter
+
+# Variable: mixinResolverEventEmitter()
+
+> `const` **mixinResolverEventEmitter**: \<`T`\>(`resolver`) => `T` & [`ResolverEventEmitter`](../interfaces/ResolverEventEmitter.md)
+
+Defined in: packages/modules/packages/module/packages/resolver/dist/types/ResolverEventEmitter.d.ts:9
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`ModuleResolver`](../interfaces/ModuleResolver.md) = [`ModuleResolver`](../interfaces/ModuleResolver.md)
+
+## Parameters
+
+### resolver
+
+`T`
+
+## Returns
+
+`T` & [`ResolverEventEmitter`](../interfaces/ResolverEventEmitter.md)

package/docs/variables/notBoundWitness.md

@@ -0,0 +1,17 @@
+[@xyo-network/sdk-js](../README.md) / notBoundWitness
+
+# Variable: notBoundWitness()
+
+> `const` **notBoundWitness**: (`x?`) => `x is BoundWitness`
+
+Defined in: packages/protocol/packages/boundwitness/packages/model/dist/types/isBoundWitness.d.ts:4
+
+## Parameters
+
+### x?
+
+`unknown` | `null`
+
+## Returns
+
+`x is BoundWitness`

package/docs/variables/notPayloadOfSchemaType.md

@@ -0,0 +1,33 @@
+[@xyo-network/sdk-js](../README.md) / notPayloadOfSchemaType
+
+# Variable: notPayloadOfSchemaType()
+
+> `const` **notPayloadOfSchemaType**: \<`T`\>(`schema`) => (`x?`) => `x is T`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/isPayloadOfSchemaType.d.ts:4
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](../type-aliases/Payload.md) \| `never` = `never`
+
+## Parameters
+
+### schema
+
+`T`\[`"schema"`\]
+
+## Returns
+
+> (`x?`): `x is T`
+
+### Parameters
+
+#### x?
+
+`unknown` | `null`
+
+### Returns
+
+`x is T`

package/docs/variables/omitSchema.md

@@ -0,0 +1,23 @@
+[@xyo-network/sdk-js](../README.md) / omitSchema
+
+# Variable: omitSchema()
+
+> `const` **omitSchema**: \<`T`\>(`payload`) => [`WithoutSchema`](../type-aliases/WithoutSchema.md)\<`T`\>
+
+Defined in: packages/protocol/packages/payload/packages/builder/dist/types/Builder.d.ts:6
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`WithOptionalSchema`](../type-aliases/WithOptionalSchema.md)
+
+## Parameters
+
+### payload
+
+`T`
+
+## Returns
+
+[`WithoutSchema`](../type-aliases/WithoutSchema.md)\<`T`\>

package/docs/variables/payloadHashesContains.md

@@ -0,0 +1,29 @@
+[@xyo-network/sdk-js](../README.md) / payloadHashesContains
+
+# Variable: payloadHashesContains()
+
+> `const` **payloadHashesContains**: (`bw`, `payloadHash`) => `boolean`
+
+Defined in: packages/protocol/packages/boundwitness/packages/validator/dist/types/lib/payloadHashes/payloadHashesContains.d.ts:9
+
+Checks if the boundwitness contains the payload hash
+
+## Parameters
+
+### bw
+
+[`BoundWitness`](../type-aliases/BoundWitness.md)
+
+The boundwitness to check
+
+### payloadHash
+
+`Hash`
+
+The payload hash to check for
+
+## Returns
+
+`boolean`
+
+True if the boundwitness contains the payload hash

package/docs/variables/payloadHashesContainsAll.md

@@ -0,0 +1,29 @@
+[@xyo-network/sdk-js](../README.md) / payloadHashesContainsAll
+
+# Variable: payloadHashesContainsAll()
+
+> `const` **payloadHashesContainsAll**: (`bw`, `payloadHashes`) => `boolean`
+
+Defined in: packages/protocol/packages/boundwitness/packages/validator/dist/types/lib/payloadHashes/payloadHashesContainsAll.d.ts:9
+
+Checks if the boundwitness contains all of the payload hashes
+
+## Parameters
+
+### bw
+
+[`BoundWitness`](../type-aliases/BoundWitness.md)
+
+The boundwitness to check
+
+### payloadHashes
+
+`Hash`[]
+
+The payload hashes to check for
+
+## Returns
+
+`boolean`
+
+True if the boundwitness contains all of the payload hashes

package/docs/variables/payloadHashesContainsAny.md

@@ -0,0 +1,31 @@
+[@xyo-network/sdk-js](../README.md) / payloadHashesContainsAny
+
+# Variable: payloadHashesContainsAny()
+
+> `const` **payloadHashesContainsAny**: (`bw`, `payloadHashes`) => `boolean`
+
+Defined in: packages/protocol/packages/boundwitness/packages/validator/dist/types/lib/payloadHashes/payloadHashesContainsAny.d.ts:11
+
+Checks if the boundwitness contains any of the payload hashes. If the payload hashes array
+is empty, it will return true. This is to match the behavior or payload hashesContainsAll
+which will return true if the payload hashes array is empty.
+
+## Parameters
+
+### bw
+
+[`BoundWitness`](../type-aliases/BoundWitness.md)
+
+The boundwitness to check
+
+### payloadHashes
+
+`Hash`[]
+
+The payload hashes to check for
+
+## Returns
+
+`boolean`
+
+True if the boundwitness contains any of the payload hashes

package/docs/variables/payloadJsonSchema.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / payloadJsonSchema
+
+# Variable: payloadJsonSchema
+
+> `const` **payloadJsonSchema**: `JSONSchemaType`\<[`Payload`](../type-aliases/Payload.md)\>
+
+Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/SchemaType.d.ts:9

package/docs/variables/payloadPropertiesJsonSchema.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / payloadPropertiesJsonSchema
+
+# Variable: payloadPropertiesJsonSchema
+
+> `const` **payloadPropertiesJsonSchema**: `JSONSchemaType`\<[`Payload`](../type-aliases/Payload.md)\>\[`"properties"`\]
+
+Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/SchemaType.d.ts:8

package/docs/variables/payloadSchemasContains.md

@@ -0,0 +1,29 @@
+[@xyo-network/sdk-js](../README.md) / payloadSchemasContains
+
+# Variable: payloadSchemasContains()
+
+> `const` **payloadSchemasContains**: (`bw`, `schema`) => `boolean`
+
+Defined in: packages/protocol/packages/boundwitness/packages/validator/dist/types/lib/payloadSchemas/payloadSchemasContains.d.ts:9
+
+Checks if the boundwitness contains the payload schema
+
+## Parameters
+
+### bw
+
+[`BoundWitness`](../type-aliases/BoundWitness.md)
+
+The boundwitness to check
+
+### schema
+
+[`Schema`](../type-aliases/Schema.md)
+
+The payload schema to check for
+
+## Returns
+
+`boolean`
+
+True if the boundwitness contains the payload schema

package/docs/variables/payloadSchemasContainsAll.md

@@ -0,0 +1,29 @@
+[@xyo-network/sdk-js](../README.md) / payloadSchemasContainsAll
+
+# Variable: payloadSchemasContainsAll()
+
+> `const` **payloadSchemasContainsAll**: (`bw`, `payloadSchemas`) => `boolean`
+
+Defined in: packages/protocol/packages/boundwitness/packages/validator/dist/types/lib/payloadSchemas/payloadSchemasContainsAll.d.ts:9
+
+Checks if the boundwitness contains all of the payload schemas
+
+## Parameters
+
+### bw
+
+[`BoundWitness`](../type-aliases/BoundWitness.md)
+
+The boundwitness to check
+
+### payloadSchemas
+
+[`Schema`](../type-aliases/Schema.md)[]
+
+The payload schemas to check for
+
+## Returns
+
+`boolean`
+
+True if the boundwitness contains all of the payload schemas

package/docs/variables/payloadSchemasContainsAny.md

@@ -0,0 +1,31 @@
+[@xyo-network/sdk-js](../README.md) / payloadSchemasContainsAny
+
+# Variable: payloadSchemasContainsAny()
+
+> `const` **payloadSchemasContainsAny**: (`bw`, `payloadSchemas`) => `boolean`
+
+Defined in: packages/protocol/packages/boundwitness/packages/validator/dist/types/lib/payloadSchemas/payloadSchemasContainsAny.d.ts:11
+
+Checks if the boundwitness contains any of the payload schemas. If the payload schemas array
+is empty, it will return true. This is to match the behavior or payload schemasContainsAll
+which will return true if the payload schemas array is empty.
+
+## Parameters
+
+### bw
+
+[`BoundWitness`](../type-aliases/BoundWitness.md)
+
+The boundwitness to check
+
+### payloadSchemas
+
+[`Schema`](../type-aliases/Schema.md)[]
+
+The payload schemas to check for
+
+## Returns
+
+`boolean`
+
+True if the boundwitness contains any of the payload schemas

package/docs/variables/registerCreatableModuleFactories.md

@@ -0,0 +1,25 @@
+[@xyo-network/sdk-js](../README.md) / registerCreatableModuleFactories
+
+# Variable: registerCreatableModuleFactories()
+
+> `const` **registerCreatableModuleFactories**: (`factories`, `registry?`, `primary?`) => [`CreatableModuleRegistry`](../interfaces/CreatableModuleRegistry.md)
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/CreatableModule/CreatableModuleRegistry.d.ts:12
+
+## Parameters
+
+### factories
+
+([`CreatableModuleFactory`](../type-aliases/CreatableModuleFactory.md) \| [`LabeledCreatableModuleFactory`](../type-aliases/LabeledCreatableModuleFactory.md))[]
+
+### registry?
+
+[`CreatableModuleRegistry`](../interfaces/CreatableModuleRegistry.md)
+
+### primary?
+
+`boolean`
+
+## Returns
+
+[`CreatableModuleRegistry`](../interfaces/CreatableModuleRegistry.md)

package/docs/variables/registerCreatableModuleFactory.md

@@ -0,0 +1,35 @@
+[@xyo-network/sdk-js](../README.md) / registerCreatableModuleFactory
+
+# Variable: registerCreatableModuleFactory()
+
+> `const` **registerCreatableModuleFactory**: \<`TModule`\>(`registry`, `factory`, `labels?`, `primary?`) => `void`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/CreatableModule/CreatableModuleRegistry.d.ts:9
+
+## Type Parameters
+
+### TModule
+
+`TModule` *extends* [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md)
+
+## Parameters
+
+### registry
+
+[`CreatableModuleRegistry`](../interfaces/CreatableModuleRegistry.md)
+
+### factory
+
+[`CreatableModuleFactory`](../type-aliases/CreatableModuleFactory.md)\<`TModule`\> | [`LabeledCreatableModuleFactory`](../type-aliases/LabeledCreatableModuleFactory.md)\<`TModule`\>
+
+### labels?
+
+[`Labels`](../interfaces/Labels.md)
+
+### primary?
+
+`boolean` | [`Schema`](../type-aliases/Schema.md) | [`Schema`](../type-aliases/Schema.md)[]
+
+## Returns
+
+`void`

package/docs/variables/removeEmptyFields.md

@@ -0,0 +1,23 @@
+[@xyo-network/sdk-js](../README.md) / removeEmptyFields
+
+# Variable: removeEmptyFields()
+
+> `const` **removeEmptyFields**: \<`T`\>(`obj`) => `T`
+
+Defined in: packages/protocol/packages/core/packages/hash/dist/types/removeEmptyFields.d.ts:2
+
+## Type Parameters
+
+### T
+
+`T` *extends* `EmptyObject`
+
+## Parameters
+
+### obj
+
+`T`
+
+## Returns
+
+`T`

package/docs/variables/requiredAttachableArchivistInstanceFunctions.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / requiredAttachableArchivistInstanceFunctions
+
+# Variable: requiredAttachableArchivistInstanceFunctions
+
+> `const` **requiredAttachableArchivistInstanceFunctions**: `ObjectTypeShape`
+
+Defined in: packages/modules/packages/archivist/packages/model/dist/types/attachable/isAttachableInstance.d.ts:4

package/docs/variables/requiredAttachableBridgeInstanceFunctions.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / requiredAttachableBridgeInstanceFunctions
+
+# Variable: requiredAttachableBridgeInstanceFunctions
+
+> `const` **requiredAttachableBridgeInstanceFunctions**: `ObjectTypeShape`
+
+Defined in: packages/modules/packages/bridge/packages/model/dist/types/attachable/isAttachableInstance.d.ts:4

package/docs/variables/requiredAttachableDivinerInstanceFunctions.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / requiredAttachableDivinerInstanceFunctions
+
+# Variable: requiredAttachableDivinerInstanceFunctions
+
+> `const` **requiredAttachableDivinerInstanceFunctions**: `ObjectTypeShape`
+
+Defined in: packages/modules/packages/diviner/packages/model/dist/types/attachable/isAttachableInstance.d.ts:4

package/docs/variables/requiredAttachableModuleInstanceFunctions.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / requiredAttachableModuleInstanceFunctions
+
+# Variable: requiredAttachableModuleInstanceFunctions
+
+> `const` **requiredAttachableModuleInstanceFunctions**: `ObjectTypeShape`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/attachable/isAttachableInstance.d.ts:4

package/docs/variables/requiredAttachableNodeInstanceFunctions.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / requiredAttachableNodeInstanceFunctions
+
+# Variable: requiredAttachableNodeInstanceFunctions
+
+> `const` **requiredAttachableNodeInstanceFunctions**: `ObjectTypeShape`
+
+Defined in: packages/modules/packages/node/packages/model/dist/types/attachable/isAttachableInstance.d.ts:4

package/docs/variables/requiredAttachableSentinelInstanceFunctions.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / requiredAttachableSentinelInstanceFunctions
+
+# Variable: requiredAttachableSentinelInstanceFunctions
+
+> `const` **requiredAttachableSentinelInstanceFunctions**: `ObjectTypeShape`
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/attachable/isAttachableInstance.d.ts:4

package/docs/variables/requiredAttachableWitnessInstanceFunctions.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / requiredAttachableWitnessInstanceFunctions
+
+# Variable: requiredAttachableWitnessInstanceFunctions
+
+> `const` **requiredAttachableWitnessInstanceFunctions**: `ObjectTypeShape`
+
+Defined in: packages/modules/packages/witness/packages/model/dist/types/attachable/isAttachableInstance.d.ts:4

package/docs/variables/requiredModuleInstanceFunctions.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / requiredModuleInstanceFunctions
+
+# Variable: requiredModuleInstanceFunctions
+
+> `const` **requiredModuleInstanceFunctions**: `ObjectTypeShape`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/isModuleInstance.d.ts:4

package/docs/variables/requiredModuleQueries.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / requiredModuleQueries
+
+# Variable: requiredModuleQueries
+
+> `const` **requiredModuleQueries**: [`Schema`](../type-aliases/Schema.md)[]
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/isModule.d.ts:4

package/docs/variables/requiredModuleShape.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / requiredModuleShape
+
+# Variable: requiredModuleShape
+
+> `const` **requiredModuleShape**: `ObjectTypeShape`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/module/isModuleObject.d.ts:3

package/docs/variables/resolveAddressToInstance.md

@@ -0,0 +1,33 @@
+[@xyo-network/sdk-js](../README.md) / resolveAddressToInstance
+
+# Variable: resolveAddressToInstance()
+
+> `const` **resolveAddressToInstance**: (`root`, `address`, `includePrivate?`, `ignore?`, `direction?`) => `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md) \| `undefined`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/resolveAddressToInstance.d.ts:8
+
+## Parameters
+
+### root
+
+[`ModuleInstance`](../interfaces/ModuleInstance.md)
+
+### address
+
+`Address`
+
+### includePrivate?
+
+`boolean`
+
+### ignore?
+
+`Address`[]
+
+### direction?
+
+[`ModuleResolveDirection`](../type-aliases/ModuleResolveDirection.md)
+
+## Returns
+
+`Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md) \| `undefined`\>

package/docs/variables/resolveAddressToInstanceAll.md

@@ -0,0 +1,29 @@
+[@xyo-network/sdk-js](../README.md) / resolveAddressToInstanceAll
+
+# Variable: resolveAddressToInstanceAll()
+
+> `const` **resolveAddressToInstanceAll**: (`root`, `address`, `includePrivate?`, `ignore?`) => `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md) \| `undefined`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/resolveAddressToInstance.d.ts:7
+
+## Parameters
+
+### root
+
+[`ModuleInstance`](../interfaces/ModuleInstance.md)
+
+### address
+
+`Address`
+
+### includePrivate?
+
+`boolean`
+
+### ignore?
+
+`Address`[]
+
+## Returns
+
+`Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md) \| `undefined`\>

package/docs/variables/resolveAddressToInstanceDown.md

@@ -0,0 +1,29 @@
+[@xyo-network/sdk-js](../README.md) / resolveAddressToInstanceDown
+
+# Variable: resolveAddressToInstanceDown()
+
+> `const` **resolveAddressToInstanceDown**: (`root`, `address`, `includePrivate?`, `ignore?`) => `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md) \| `undefined`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/resolveAddressToInstance.d.ts:4
+
+## Parameters
+
+### root
+
+[`ModuleInstance`](../interfaces/ModuleInstance.md)
+
+### address
+
+`Address`
+
+### includePrivate?
+
+`boolean`
+
+### ignore?
+
+`Address`[]
+
+## Returns
+
+`Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md) \| `undefined`\>

package/docs/variables/resolveAddressToInstanceSiblings.md

@@ -0,0 +1,29 @@
+[@xyo-network/sdk-js](../README.md) / resolveAddressToInstanceSiblings
+
+# Variable: resolveAddressToInstanceSiblings()
+
+> `const` **resolveAddressToInstanceSiblings**: (`root`, `address`, `includePrivate?`, `ignore?`) => `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md) \| `undefined`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/resolveAddressToInstance.d.ts:5
+
+## Parameters
+
+### root
+
+[`ModuleInstance`](../interfaces/ModuleInstance.md)
+
+### address
+
+`Address`
+
+### includePrivate?
+
+`boolean`
+
+### ignore?
+
+`Address`[]
+
+## Returns
+
+`Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md) \| `undefined`\>

package/docs/variables/resolveAddressToInstanceUp.md

@@ -0,0 +1,29 @@
+[@xyo-network/sdk-js](../README.md) / resolveAddressToInstanceUp
+
+# Variable: resolveAddressToInstanceUp()
+
+> `const` **resolveAddressToInstanceUp**: (`root`, `address`, `includePrivate?`, `ignore?`) => `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md) \| `undefined`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/resolveAddressToInstance.d.ts:6
+
+## Parameters
+
+### root
+
+[`ModuleInstance`](../interfaces/ModuleInstance.md)
+
+### address
+
+`Address`
+
+### includePrivate?
+
+`boolean`
+
+### ignore?
+
+`Address`[]
+
+## Returns
+
+`Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md) \| `undefined`\>

package/docs/variables/resolveAll.md

@@ -0,0 +1,25 @@
+[@xyo-network/sdk-js](../README.md) / resolveAll
+
+# Variable: resolveAll()
+
+> `const` **resolveAll**: (`root`, `maxDepth?`, `exclude?`) => `Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)[]\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ResolveHelper/resolveAll.d.ts:5
+
+## Parameters
+
+### root
+
+[`ModuleInstance`](../interfaces/ModuleInstance.md)
+
+### maxDepth?
+
+`number`
+
+### exclude?
+
+`Address`[]
+
+## Returns
+
+`Promise`\<[`ModuleInstance`](../interfaces/ModuleInstance.md)[]\>