@xyo-network/sdk-js 3.14.16 → 3.14.18

package/docs/type-aliases/PayloadLoader.md

@@ -0,0 +1,17 @@
+[@xyo-network/sdk-js](../README.md) / PayloadLoader
+
+# Type Alias: PayloadLoader()
+
+> **PayloadLoader** = (`address`) => `Promise`\<[`Payload`](Payload.md) \| `null`\>
+
+Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadWrapperBase.d.ts:4
+
+## Parameters
+
+### address
+
+`Address`
+
+## Returns
+
+`Promise`\<[`Payload`](Payload.md) \| `null`\>

package/docs/type-aliases/PayloadLoaderFactory.md

@@ -0,0 +1,11 @@
+[@xyo-network/sdk-js](../README.md) / PayloadLoaderFactory
+
+# Type Alias: PayloadLoaderFactory()
+
+> **PayloadLoaderFactory** = () => [`PayloadLoader`](PayloadLoader.md)
+
+Defined in: packages/protocol/packages/payload/packages/wrapper/dist/types/PayloadWrapperBase.d.ts:5
+
+## Returns
+
+[`PayloadLoader`](PayloadLoader.md)

package/docs/type-aliases/PayloadProperty.md

@@ -0,0 +1,15 @@
+[@xyo-network/sdk-js](../README.md) / PayloadProperty
+
+# Type Alias: PayloadProperty\<T\>
+
+> **PayloadProperty**\<`T`\> = keyof `T`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/PayloadValueExpression.d.ts:5
+
+Type corresponding to the properties of a payload
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)

package/docs/type-aliases/PayloadSchema.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / PayloadSchema
+
+# Type Alias: PayloadSchema
+
+> **PayloadSchema** = *typeof* [`PayloadSchema`](../variables/PayloadSchema.md)
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/Schema.d.ts:5

package/docs/type-aliases/PayloadSetPayload.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / PayloadSetPayload
+
+# Type Alias: PayloadSetPayload
+
+> **PayloadSetPayload** = [`Payload`](Payload.md)\<[`PayloadSet`](../interfaces/PayloadSet.md), [`PayloadSetSchema`](PayloadSetSchema.md)\>
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/PayloadSet/PayloadSetPayload.d.ts:7

package/docs/type-aliases/PayloadSetSchema.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / PayloadSetSchema
+
+# Type Alias: PayloadSetSchema
+
+> **PayloadSetSchema** = *typeof* [`PayloadSetSchema`](../variables/PayloadSetSchema.md)
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/PayloadSet/PayloadSetSchema.d.ts:1

package/docs/type-aliases/PayloadValidationFunction.md

@@ -0,0 +1,15 @@
+[@xyo-network/sdk-js](../README.md) / PayloadValidationFunction
+
+# Type Alias: PayloadValidationFunction\<T\>
+
+> **PayloadValidationFunction**\<`T`\> = [`SyncPayloadValidationFunction`](SyncPayloadValidationFunction.md)\<`T`\> \| [`AsyncPayloadValidationFunction`](AsyncPayloadValidationFunction.md)\<`T`\>
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/PayloadValidationFunction.d.ts:13
+
+A function that validates the supplied payload
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)

package/docs/type-aliases/PayloadValue.md

@@ -0,0 +1,19 @@
+[@xyo-network/sdk-js](../README.md) / PayloadValue
+
+# Type Alias: PayloadValue\<T, Key\>
+
+> **PayloadValue**\<`T`, `Key`\> = `T`\[`Key`\]
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/PayloadValueExpression.d.ts:13
+
+Type corresponding to the payload values
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
+
+### Key
+
+`Key` *extends* [`PayloadProperty`](PayloadProperty.md)\<`T`\> = [`PayloadProperty`](PayloadProperty.md)\<`T`\>

package/docs/type-aliases/PayloadValueExpression.md

@@ -0,0 +1,33 @@
+[@xyo-network/sdk-js](../README.md) / PayloadValueExpression
+
+# Type Alias: PayloadValueExpression()\<T, Key, TValue\>
+
+> **PayloadValueExpression**\<`T`, `Key`, `TValue`\> = (`payload`) => `TValue`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/PayloadValueExpression.d.ts:25
+
+An expressions that selects a property value from the payload
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](Payload.md) = [`Payload`](Payload.md)
+
+### Key
+
+`Key` *extends* [`PayloadProperty`](PayloadProperty.md)\<`T`\> = [`PayloadProperty`](PayloadProperty.md)\<`T`\>
+
+### TValue
+
+`TValue` = [`PayloadValue`](PayloadValue.md)\<`T`, `Key`\>
+
+## Parameters
+
+### payload
+
+`T`
+
+## Returns
+
+`TValue`

package/docs/type-aliases/PayloadWithOptionalSources.md

@@ -0,0 +1,21 @@
+[@xyo-network/sdk-js](../README.md) / PayloadWithOptionalSources
+
+# Type Alias: ~~PayloadWithOptionalSources\<T, S\>~~
+
+> **PayloadWithOptionalSources**\<`T`, `S`\> = [`WithOptionalSources`](WithOptionalSources.md)\<[`Payload`](Payload.md)\<`T`, `S`\>\>
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:30
+
+## Type Parameters
+
+### T
+
+`T` *extends* `void` \| `EmptyObject` \| [`WithSchema`](WithSchema.md) = `void`
+
+### S
+
+`S` *extends* [`Schema`](Schema.md) \| `void` = `void`
+
+## Deprecated
+
+optional $sources are now optional in all Payloads

package/docs/type-aliases/PayloadWithSources.md

@@ -0,0 +1,17 @@
+[@xyo-network/sdk-js](../README.md) / PayloadWithSources
+
+# Type Alias: PayloadWithSources\<T, S\>
+
+> **PayloadWithSources**\<`T`, `S`\> = [`WithSources`](WithSources.md)\<[`Payload`](Payload.md)\<`T`, `S`\>\>
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/Payload.d.ts:28
+
+## Type Parameters
+
+### T
+
+`T` *extends* `void` \| `EmptyObject` \| [`WithSchema`](WithSchema.md) = `void`
+
+### S
+
+`S` *extends* [`Schema`](Schema.md) \| `void` = `void`

package/docs/type-aliases/QualifiedSequence.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / QualifiedSequence
+
+# Type Alias: QualifiedSequence
+
+> **QualifiedSequence** = `Hex` & `Exclude`\<`string`, `"reserved-qualified-sequence-value"`\>
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Sequence.d.ts:3

package/docs/type-aliases/Query.md

@@ -0,0 +1,17 @@
+[@xyo-network/sdk-js](../README.md) / Query
+
+# Type Alias: Query\<T, S\>
+
+> **Query**\<`T`, `S`\> = [`Payload`](Payload.md)\<`T` *extends* `void` ? [`QueryFields`](../interfaces/QueryFields.md) : `T` & [`QueryFields`](../interfaces/QueryFields.md), `S` *extends* `void` ? `T` *extends* [`WithSchema`](WithSchema.md) ? `T`\[`"schema"`\] : `T` *extends* `void` ? [`Schema`](Schema.md) : `void` : `S`\>
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/Query.d.ts:15
+
+## Type Parameters
+
+### T
+
+`T` *extends* `void` \| `EmptyObject` \| [`WithSchema`](WithSchema.md) = `void`
+
+### S
+
+`S` *extends* [`Schema`](Schema.md) \| `void` = `void`

package/docs/type-aliases/QueryBoundWitness.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / QueryBoundWitness
+
+# Type Alias: QueryBoundWitness
+
+> **QueryBoundWitness** = [`UnsignedQueryBoundWitness`](UnsignedQueryBoundWitness.md)
+
+Defined in: packages/protocol/packages/boundwitness/packages/model/dist/types/QueryBoundWitness.d.ts:9

package/docs/type-aliases/QueryBoundWitnessFields.md

@@ -0,0 +1,23 @@
+[@xyo-network/sdk-js](../README.md) / QueryBoundWitnessFields
+
+# Type Alias: QueryBoundWitnessFields
+
+> **QueryBoundWitnessFields** = `object`
+
+Defined in: packages/protocol/packages/boundwitness/packages/model/dist/types/QueryBoundWitness.d.ts:4
+
+## Properties
+
+### error\_hashes?
+
+> `optional` **error\_hashes**: `Hash`[]
+
+Defined in: packages/protocol/packages/boundwitness/packages/model/dist/types/QueryBoundWitness.d.ts:5
+
+***
+
+### query
+
+> **query**: `Hash`
+
+Defined in: packages/protocol/packages/boundwitness/packages/model/dist/types/QueryBoundWitness.d.ts:6

package/docs/type-aliases/QueryFulfillFinishedEventArgs.md

@@ -0,0 +1,13 @@
+[@xyo-network/sdk-js](../README.md) / QueryFulfillFinishedEventArgs
+
+# Type Alias: QueryFulfillFinishedEventArgs\<T\>
+
+> **QueryFulfillFinishedEventArgs**\<`T`\> = [`ModuleEventArgs`](ModuleEventArgs.md)\<`T`, \{ `payloads?`: [`Payload`](Payload.md)[]; `query`: [`QueryBoundWitness`](QueryBoundWitness.md); `result?`: [`ModuleQueryResult`](ModuleQueryResult.md); `status`: `"success"` \| `"failure"`; \}\>
+
+Defined in: packages/modules/packages/bridge/packages/model/dist/types/Events/QueryFulfillFinished.d.ts:5
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Module`](../interfaces/Module.md) = [`Module`](../interfaces/Module.md)

package/docs/type-aliases/QueryFulfillStartedEventArgs.md

@@ -0,0 +1,13 @@
+[@xyo-network/sdk-js](../README.md) / QueryFulfillStartedEventArgs
+
+# Type Alias: QueryFulfillStartedEventArgs\<T\>
+
+> **QueryFulfillStartedEventArgs**\<`T`\> = [`ModuleEventArgs`](ModuleEventArgs.md)\<`T`, \{ `payloads?`: [`Payload`](Payload.md)[]; `query`: [`QueryBoundWitness`](QueryBoundWitness.md); \}\>
+
+Defined in: packages/modules/packages/bridge/packages/model/dist/types/Events/QueryFulfillStarted.d.ts:5
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Module`](../interfaces/Module.md) = [`Module`](../interfaces/Module.md)

package/docs/type-aliases/QueryModuleFilter.md

@@ -0,0 +1,13 @@
+[@xyo-network/sdk-js](../README.md) / QueryModuleFilter
+
+# Type Alias: QueryModuleFilter\<T\>
+
+> **QueryModuleFilter**\<`T`\> = [`QueryObjectFilter`](../interfaces/QueryObjectFilter.md)\<`T`\>
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/instance/ModuleFilter.d.ts:41
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md) = [`ModuleInstance`](../interfaces/ModuleInstance.md)

package/docs/type-aliases/QuerySendFinishedEventArgs.md

@@ -0,0 +1,13 @@
+[@xyo-network/sdk-js](../README.md) / QuerySendFinishedEventArgs
+
+# Type Alias: QuerySendFinishedEventArgs\<T\>
+
+> **QuerySendFinishedEventArgs**\<`T`\> = [`ModuleEventArgs`](ModuleEventArgs.md)\<`T`, \{ `payloads?`: [`Payload`](Payload.md)[]; `query`: [`QueryBoundWitness`](QueryBoundWitness.md); `result?`: [`ModuleQueryResult`](ModuleQueryResult.md); `status`: `"success"` \| `"failure"`; \}\>
+
+Defined in: packages/modules/packages/bridge/packages/model/dist/types/Events/QuerySendFinished.d.ts:5
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Module`](../interfaces/Module.md) = [`Module`](../interfaces/Module.md)

package/docs/type-aliases/QuerySendStartedEventArgs.md

@@ -0,0 +1,13 @@
+[@xyo-network/sdk-js](../README.md) / QuerySendStartedEventArgs
+
+# Type Alias: QuerySendStartedEventArgs\<T\>
+
+> **QuerySendStartedEventArgs**\<`T`\> = [`ModuleEventArgs`](ModuleEventArgs.md)\<`T`, \{ `payloads?`: [`Payload`](Payload.md)[]; `query`: [`QueryBoundWitness`](QueryBoundWitness.md); \}\>
+
+Defined in: packages/modules/packages/bridge/packages/model/dist/types/Events/QuerySendStarted.d.ts:5
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Module`](../interfaces/Module.md) = [`Module`](../interfaces/Module.md)

package/docs/type-aliases/ReportEndEventArgs.md

@@ -0,0 +1,13 @@
+[@xyo-network/sdk-js](../README.md) / ReportEndEventArgs
+
+# Type Alias: ReportEndEventArgs\<T\>
+
+> **ReportEndEventArgs**\<`T`\> = [`ModuleEventArgs`](ModuleEventArgs.md)\<`T`, \{ `boundwitness?`: [`BoundWitness`](BoundWitness.md); `inPayloads?`: [`Payload`](Payload.md)[]; `outPayloads?`: [`Payload`](Payload.md)[]; \}\>
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/EventsModels/ReportEnd.d.ts:5
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Module`](../interfaces/Module.md) = [`Module`](../interfaces/Module.md)

package/docs/type-aliases/ReportStartEventArgs.md

@@ -0,0 +1,13 @@
+[@xyo-network/sdk-js](../README.md) / ReportStartEventArgs
+
+# Type Alias: ReportStartEventArgs\<T\>
+
+> **ReportStartEventArgs**\<`T`\> = [`ModuleEventArgs`](ModuleEventArgs.md)\<`T`, \{ `inPayloads?`: [`Payload`](Payload.md)[]; \}\>
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/EventsModels/ReportStart.d.ts:4
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Module`](../interfaces/Module.md) = [`Module`](../interfaces/Module.md)

package/docs/type-aliases/ReservedModuleIdentifierCharacter.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / ReservedModuleIdentifierCharacter
+
+# Type Alias: ReservedModuleIdentifierCharacter
+
+> **ReservedModuleIdentifierCharacter** = keyof *typeof* [`DisallowedModuleIdentifierCharacters`](../variables/DisallowedModuleIdentifierCharacters.md)
+
+Defined in: packages/modules/packages/module/packages/model/dist/types/ModuleIdentifier.d.ts:34

package/docs/type-aliases/ResolvedArchivistTask.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / ResolvedArchivistTask
+
+# Type Alias: ResolvedArchivistTask
+
+> **ResolvedArchivistTask** = [`ResolvedModuleTask`](ResolvedModuleTask.md)\<[`ArchivistTask`](ArchivistTask.md), [`ArchivistInstance`](../interfaces/ArchivistInstance.md)\>
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/ResolvedTask.d.ts:10

package/docs/type-aliases/ResolvedDivinerTask.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / ResolvedDivinerTask
+
+# Type Alias: ResolvedDivinerTask
+
+> **ResolvedDivinerTask** = [`ResolvedModuleTask`](ResolvedModuleTask.md)\<[`DivinerTask`](DivinerTask.md), [`DivinerInstance`](../interfaces/DivinerInstance.md)\>
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/ResolvedTask.d.ts:11

package/docs/type-aliases/ResolvedModuleTask.md

@@ -0,0 +1,27 @@
+[@xyo-network/sdk-js](../README.md) / ResolvedModuleTask
+
+# Type Alias: ResolvedModuleTask\<TTask, TInstance\>
+
+> **ResolvedModuleTask**\<`TTask`, `TInstance`\> = `Omit`\<`TTask`, `"mod"`\> & `object`
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/ResolvedTask.d.ts:6
+
+## Type declaration
+
+### mod
+
+> **mod**: `TInstance`
+
+#### Field
+
+the modules that performs the task
+
+## Type Parameters
+
+### TTask
+
+`TTask` *extends* [`ModuleTask`](../interfaces/ModuleTask.md) = [`ModuleTask`](../interfaces/ModuleTask.md)
+
+### TInstance
+
+`TInstance` *extends* [`ModuleInstance`](../interfaces/ModuleInstance.md) = [`ModuleInstance`](../interfaces/ModuleInstance.md)

package/docs/type-aliases/ResolvedTask.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / ResolvedTask
+
+# Type Alias: ResolvedTask
+
+> **ResolvedTask** = [`ResolvedArchivistTask`](ResolvedArchivistTask.md) \| [`ResolvedDivinerTask`](ResolvedDivinerTask.md) \| [`ResolvedWitnessTask`](ResolvedWitnessTask.md) \| [`ResolvedModuleTask`](ResolvedModuleTask.md)
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/ResolvedTask.d.ts:13

package/docs/type-aliases/ResolvedWitnessTask.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / ResolvedWitnessTask
+
+# Type Alias: ResolvedWitnessTask
+
+> **ResolvedWitnessTask** = [`ResolvedModuleTask`](ResolvedModuleTask.md)\<[`WitnessTask`](WitnessTask.md), [`WitnessInstance`](../interfaces/WitnessInstance.md)\>
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/ResolvedTask.d.ts:12

package/docs/type-aliases/Schema.md

@@ -0,0 +1,9 @@
+[@xyo-network/sdk-js](../README.md) / Schema
+
+# Type Alias: Schema
+
+> **Schema** = `string`
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/Schema.d.ts:4
+
+Schema type in Javascript is a string

package/docs/type-aliases/SentinelAutomationPayload.md

@@ -0,0 +1,9 @@
+[@xyo-network/sdk-js](../README.md) / SentinelAutomationPayload
+
+# Type Alias: SentinelAutomationPayload
+
+> **SentinelAutomationPayload** = [`Payload`](Payload.md)\<[`SentinelIntervalAutomationPayload`](SentinelIntervalAutomationPayload.md) \| [`SentinelEventAutomationPayload`](SentinelEventAutomationPayload.md), [`SentinelAutomationSchema`](SentinelAutomationSchema.md) \| [`SentinelIntervalAutomationSchema`](SentinelIntervalAutomationSchema.md) \| [`SentinelEventAutomationSchema`](SentinelEventAutomationSchema.md)\>
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Automation.d.ts:34
+
+Settings for an Automation

package/docs/type-aliases/SentinelAutomationSchema.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / SentinelAutomationSchema
+
+# Type Alias: SentinelAutomationSchema
+
+> **SentinelAutomationSchema** = *typeof* [`SentinelAutomationSchema`](../variables/SentinelAutomationSchema.md)
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Automation.d.ts:2

package/docs/type-aliases/SentinelBaseAutomationPayload.md

@@ -0,0 +1,13 @@
+[@xyo-network/sdk-js](../README.md) / SentinelBaseAutomationPayload
+
+# Type Alias: SentinelBaseAutomationPayload\<T\>
+
+> **SentinelBaseAutomationPayload**\<`T`\> = [`Payload`](Payload.md)\<`object` & `T`\>
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Automation.d.ts:8
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`Payload`](Payload.md)

package/docs/type-aliases/SentinelConfig.md

@@ -0,0 +1,17 @@
+[@xyo-network/sdk-js](../README.md) / SentinelConfig
+
+# Type Alias: SentinelConfig\<TConfig, TSchema\>
+
+> **SentinelConfig**\<`TConfig`, `TSchema`\> = [`ModuleConfig`](ModuleConfig.md)\<`WithAdditional`\<\{ `automations?`: [`SentinelAutomationPayload`](SentinelAutomationPayload.md)[]; `schema`: `TConfig` *extends* [`Payload`](Payload.md) ? `TConfig`\[`"schema"`\] : [`SentinelConfigSchema`](SentinelConfigSchema.md); `synchronous?`: `boolean`; `tasks`: [`Task`](Task.md)[]; `throwErrors?`: `boolean`; \}, `TConfig`\>, `TSchema`\>
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Config.d.ts:8
+
+## Type Parameters
+
+### TConfig
+
+`TConfig` *extends* [`Payload`](Payload.md) \| `void` = `void`
+
+### TSchema
+
+`TSchema` *extends* `string` \| `void` = `void`

package/docs/type-aliases/SentinelConfigSchema.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / SentinelConfigSchema
+
+# Type Alias: SentinelConfigSchema
+
+> **SentinelConfigSchema** = *typeof* [`SentinelConfigSchema`](../variables/SentinelConfigSchema.md)
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Config.d.ts:6

package/docs/type-aliases/SentinelEventAutomationPayload.md

@@ -0,0 +1,9 @@
+[@xyo-network/sdk-js](../README.md) / SentinelEventAutomationPayload
+
+# Type Alias: SentinelEventAutomationPayload
+
+> **SentinelEventAutomationPayload** = [`SentinelBaseAutomationPayload`](SentinelBaseAutomationPayload.md)\<\{ `schema`: [`SentinelEventAutomationSchema`](SentinelEventAutomationSchema.md); `type`: `"event"`; \}\>
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Automation.d.ts:29
+
+Settings for an Event Automation

package/docs/type-aliases/SentinelEventAutomationSchema.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / SentinelEventAutomationSchema
+
+# Type Alias: SentinelEventAutomationSchema
+
+> **SentinelEventAutomationSchema** = *typeof* [`SentinelEventAutomationSchema`](../variables/SentinelEventAutomationSchema.md)
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Automation.d.ts:6

package/docs/type-aliases/SentinelIntervalAutomationPayload.md

@@ -0,0 +1,9 @@
+[@xyo-network/sdk-js](../README.md) / SentinelIntervalAutomationPayload
+
+# Type Alias: SentinelIntervalAutomationPayload
+
+> **SentinelIntervalAutomationPayload** = [`SentinelBaseAutomationPayload`](SentinelBaseAutomationPayload.md)\<\{ `end?`: `number`; `frequency?`: `number`; `frequencyUnits?`: `"second"` \| `"minute"` \| `"hour"` \| `"day"` \| `"millis"`; `remaining?`: `number`; `schema`: [`SentinelIntervalAutomationSchema`](SentinelIntervalAutomationSchema.md); `start`: `number`; `type`: `"interval"`; \}\>
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Automation.d.ts:12
+
+Settings for an Interval Automation

package/docs/type-aliases/SentinelIntervalAutomationSchema.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / SentinelIntervalAutomationSchema
+
+# Type Alias: SentinelIntervalAutomationSchema
+
+> **SentinelIntervalAutomationSchema** = *typeof* [`SentinelIntervalAutomationSchema`](../variables/SentinelIntervalAutomationSchema.md)
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Automation.d.ts:4

package/docs/type-aliases/SentinelModuleQueries.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / SentinelModuleQueries
+
+# Type Alias: SentinelModuleQueries
+
+> **SentinelModuleQueries** = [`ModuleQueries`](ModuleQueries.md) \| [`SentinelQueries`](SentinelQueries.md)
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Queries/index.d.ts:5

package/docs/type-aliases/SentinelParams.md

@@ -0,0 +1,17 @@
+[@xyo-network/sdk-js](../README.md) / SentinelParams
+
+# Type Alias: SentinelParams\<TConfig, TAdditionalParams\>
+
+> **SentinelParams**\<`TConfig`, `TAdditionalParams`\> = [`ModuleParams`](ModuleParams.md)\<`TConfig`, `TAdditionalParams`\>
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Params.d.ts:4
+
+## Type Parameters
+
+### TConfig
+
+`TConfig` *extends* [`AnyConfigSchema`](AnyConfigSchema.md)\<[`SentinelConfig`](SentinelConfig.md)\> = [`AnyConfigSchema`](AnyConfigSchema.md)\<[`SentinelConfig`](SentinelConfig.md)\>
+
+### TAdditionalParams
+
+`TAdditionalParams` *extends* `EmptyObject` \| `void` = `void`

package/docs/type-aliases/SentinelQueries.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / SentinelQueries
+
+# Type Alias: SentinelQueries
+
+> **SentinelQueries** = [`SentinelReportQuery`](SentinelReportQuery.md)
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Queries/index.d.ts:4

package/docs/type-aliases/SentinelReportQuery.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / SentinelReportQuery
+
+# Type Alias: SentinelReportQuery
+
+> **SentinelReportQuery** = [`Query`](Query.md)\<\{ `schema`: [`SentinelReportQuerySchema`](SentinelReportQuerySchema.md); \}\>
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Queries/Report.d.ts:4

package/docs/type-aliases/SentinelReportQuerySchema.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / SentinelReportQuerySchema
+
+# Type Alias: SentinelReportQuerySchema
+
+> **SentinelReportQuerySchema** = *typeof* [`SentinelReportQuerySchema`](../variables/SentinelReportQuerySchema.md)
+
+Defined in: packages/modules/packages/sentinel/packages/model/dist/types/Queries/Report.d.ts:2

package/docs/type-aliases/Sequence.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / Sequence
+
+# Type Alias: Sequence
+
+> **Sequence** = [`LocalSequence`](LocalSequence.md) \| [`QualifiedSequence`](QualifiedSequence.md)
+
+Defined in: packages/protocol/packages/payload/packages/model/dist/types/StorageMeta/sequence/Sequence.d.ts:4

package/docs/type-aliases/Signed.md

@@ -0,0 +1,19 @@
+[@xyo-network/sdk-js](../README.md) / Signed
+
+# Type Alias: Signed\<T\>
+
+> **Signed**\<`T`\> = `T` & `object`
+
+Defined in: packages/protocol/packages/boundwitness/packages/model/dist/types/BoundWitness/BoundWitness.d.ts:36
+
+## Type declaration
+
+### $signatures
+
+> **$signatures**: `Hex`[]
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`UnsignedBoundWitness`](UnsignedBoundWitness.md) = [`UnsignedBoundWitness`](UnsignedBoundWitness.md)

package/docs/type-aliases/SignedBoundWitness.md

@@ -0,0 +1,7 @@
+[@xyo-network/sdk-js](../README.md) / SignedBoundWitness
+
+# Type Alias: SignedBoundWitness
+
+> **SignedBoundWitness** = [`Signed`](Signed.md)\<[`UnsignedBoundWitness`](UnsignedBoundWitness.md)\>
+
+Defined in: packages/protocol/packages/boundwitness/packages/model/dist/types/BoundWitness/BoundWitness.d.ts:39