@xyo-network/sdk-js 3.14.16 → 3.14.18

package/docs/classes/ModuleDetailsError.md

@@ -0,0 +1,179 @@
+[@xyo-network/sdk-js](../README.md) / ModuleDetailsError
+
+# Class: ModuleDetailsError
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/DetailsError.d.ts:2
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+> **new ModuleDetailsError**(`message`, `details?`): `ModuleDetailsError`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/DetailsError.d.ts:4
+
+#### Parameters
+
+##### message
+
+`string`
+
+##### details?
+
+`JsonValue`
+
+#### Returns
+
+`ModuleDetailsError`
+
+#### Overrides
+
+`Error.constructor`
+
+## Properties
+
+### details?
+
+> `optional` **details**: `JsonValue`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/DetailsError.d.ts:3
+
+***
+
+### message
+
+> **message**: `string`
+
+Defined in: node\_modules/.store/typescript-patch-f64146f279/package/lib/lib.es5.d.ts:1077
+
+#### Inherited from
+
+`Error.message`
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: node\_modules/.store/typescript-patch-f64146f279/package/lib/lib.es5.d.ts:1076
+
+#### Inherited from
+
+`Error.name`
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+Defined in: node\_modules/.store/typescript-patch-f64146f279/package/lib/lib.es5.d.ts:1078
+
+#### Inherited from
+
+`Error.stack`
+
+***
+
+### prepareStackTrace()?
+
+> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
+
+Defined in: node\_modules/.store/@types-node-npm-22.7.5-0428b60a8c/package/globals.d.ts:143
+
+Optional override for formatting stack traces
+
+#### Parameters
+
+##### err
+
+`Error`
+
+##### stackTraces
+
+`CallSite`[]
+
+#### Returns
+
+`any`
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Inherited from
+
+`Error.prepareStackTrace`
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+Defined in: node\_modules/.store/@types-node-npm-22.7.5-0428b60a8c/package/globals.d.ts:145
+
+#### Inherited from
+
+`Error.stackTraceLimit`
+
+## Methods
+
+### captureStackTrace()
+
+#### Call Signature
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Defined in: node\_modules/.store/@types-node-npm-22.7.5-0428b60a8c/package/globals.d.ts:136
+
+Create .stack property on a target object
+
+##### Parameters
+
+###### targetObject
+
+`object`
+
+###### constructorOpt?
+
+`Function`
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+`Error.captureStackTrace`
+
+#### Call Signature
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Defined in: node\_modules/.store/@types-node-npm-22.15.3-ab71dd4f9d/package/globals.d.ts:136
+
+Create .stack property on a target object
+
+##### Parameters
+
+###### targetObject
+
+`object`
+
+###### constructorOpt?
+
+`Function`
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+`Error.captureStackTrace`

package/docs/classes/ModuleFactory.md

@@ -0,0 +1,243 @@
+[@xyo-network/sdk-js](../README.md) / ModuleFactory
+
+# Class: ModuleFactory\<TModule\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/CreatableModule/ModuleFactory.d.ts:6
+
+## Type Parameters
+
+### TModule
+
+`TModule` *extends* [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md)
+
+## Implements
+
+- [`CreatableModuleFactory`](../type-aliases/CreatableModuleFactory.md)\<`TModule`\>
+
+## Constructors
+
+### Constructor
+
+> **new ModuleFactory**\<`TModule`\>(`creatableModule`, `params?`, `labels?`): `ModuleFactory`\<`TModule`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/CreatableModule/ModuleFactory.d.ts:15
+
+#### Parameters
+
+##### creatableModule
+
+[`CreatableModule`](../interfaces/CreatableModule.md)\<`TModule`\>
+
+##### params?
+
+`Omit`\<`TModule`\[`"params"`\], `"config"`\> & `object`
+
+##### labels?
+
+[`Labels`](../interfaces/Labels.md)
+
+#### Returns
+
+`ModuleFactory`\<`TModule`\>
+
+## Properties
+
+### configSchemas
+
+> **configSchemas**: `string`[]
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/CreatableModule/ModuleFactory.d.ts:7
+
+#### Implementation of
+
+`CreatableModuleFactory.configSchemas`
+
+***
+
+### creatableModule
+
+> **creatableModule**: [`CreatableModule`](../interfaces/CreatableModule.md)\<`TModule`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/CreatableModule/ModuleFactory.d.ts:8
+
+***
+
+### defaultConfigSchema
+
+> **defaultConfigSchema**: `string`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/CreatableModule/ModuleFactory.d.ts:9
+
+#### Implementation of
+
+`CreatableModuleFactory.defaultConfigSchema`
+
+***
+
+### defaultLogger?
+
+> `optional` **defaultLogger**: `Logger`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/CreatableModule/ModuleFactory.d.ts:10
+
+#### Implementation of
+
+`CreatableModuleFactory.defaultLogger`
+
+***
+
+### defaultParams?
+
+> `optional` **defaultParams**: `Omit`\<`TModule`\[`"params"`\], `"config"`\> & `object`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/CreatableModule/ModuleFactory.d.ts:11
+
+#### Type declaration
+
+##### config?
+
+> `optional` **config**: `Partial`\<`TModule`\[`"params"`\]\[`"config"`\]\>
+
+***
+
+### labels?
+
+> `optional` **labels**: [`Labels`](../interfaces/Labels.md)
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/CreatableModule/ModuleFactory.d.ts:14
+
+## Methods
+
+### \_getRootFunction()
+
+> **\_getRootFunction**(`funcName`): `any`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/CreatableModule/ModuleFactory.d.ts:21
+
+#### Parameters
+
+##### funcName
+
+`string`
+
+#### Returns
+
+`any`
+
+***
+
+### \_noOverride()
+
+> **\_noOverride**(`functionName`): `void`
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/CreatableModule/ModuleFactory.d.ts:22
+
+#### Parameters
+
+##### functionName
+
+`string`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+`CreatableModuleFactory._noOverride`
+
+***
+
+### create()
+
+> **create**\<`T`\>(`this`, `params`): `Promise`\<`T`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/CreatableModule/ModuleFactory.d.ts:23
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
+
+#### Parameters
+
+##### this
+
+[`CreatableModuleFactory`](../type-aliases/CreatableModuleFactory.md)\<`T`\>
+
+##### params
+
+`TModule`\[`"params"`\]
+
+#### Returns
+
+`Promise`\<`T`\>
+
+#### Implementation of
+
+`CreatableModuleFactory.create`
+
+***
+
+### factory()
+
+> **factory**\<`T`\>(`this`, `_params?`): [`CreatableModuleFactory`](../type-aliases/CreatableModuleFactory.md)\<`T`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/CreatableModule/ModuleFactory.d.ts:24
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
+
+#### Parameters
+
+##### this
+
+[`CreatableModule`](../interfaces/CreatableModule.md)\<`T`\>
+
+##### \_params?
+
+`T`\[`"params"`\]
+
+#### Returns
+
+[`CreatableModuleFactory`](../type-aliases/CreatableModuleFactory.md)\<`T`\>
+
+#### Implementation of
+
+`CreatableModuleFactory.factory`
+
+***
+
+### withParams()
+
+> `static` **withParams**\<`T`\>(`creatableModule`, `params?`, `labels?`): `ModuleFactory`\<`T`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/CreatableModule/ModuleFactory.d.ts:18
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`AttachableModuleInstance`](../interfaces/AttachableModuleInstance.md)\<`BaseParamsFields` & `object`, [`ModuleEventData`](../interfaces/ModuleEventData.md)\<`object`\>\>
+
+#### Parameters
+
+##### creatableModule
+
+[`CreatableModule`](../interfaces/CreatableModule.md)\<`T`\>
+
+##### params?
+
+`Omit`\<`T`\[`"params"`\], `"config"`\> & `object`
+
+##### labels?
+
+[`Labels`](../interfaces/Labels.md)
+
+#### Returns
+
+`ModuleFactory`\<`T`\>