dag-node / Exports / NodeIoAccessor
Class: NodeIoAccessor
Typed accessor for reading node inputs and building node outputs within execute methods.
Provides requireInput* helpers that return TResult with validation errors, and setOutput / toOutput for constructing the output payload.
See
AbstractNodeDefinition - base class that uses this accessor in lifecycle hooks
Table of contents
Constructors
Methods
- getInput
- requireInput
- requireInputString
- requireInputArray
- requireInputBinary
- requireInputBinaryList
- requireInputMediaReference
- requireInputBinaryReference
- setOutput
- toOutput
Constructors
constructor
• new NodeIoAccessor(input, nodeId): NodeIoAccessor
Parameters
| Name | Type |
|---|---|
input | TPortPayload |
nodeId | string |
Returns
Defined in
packages/dag-node/src/lifecycle/node-io-accessor.ts:19
Methods
getInput
▸ getInput(key): undefined | TPortValue
Parameters
| Name | Type |
|---|---|
key | string |
Returns
undefined | TPortValue
Defined in
packages/dag-node/src/lifecycle/node-io-accessor.ts:24
requireInput
▸ requireInput(key): TResult<TPortValue, IDagError>
Parameters
| Name | Type |
|---|---|
key | string |
Returns
TResult<TPortValue, IDagError>
Defined in
packages/dag-node/src/lifecycle/node-io-accessor.ts:28
requireInputString
▸ requireInputString(key): TResult<string, IDagError>
Parameters
| Name | Type |
|---|---|
key | string |
Returns
TResult<string, IDagError>
Defined in
packages/dag-node/src/lifecycle/node-io-accessor.ts:43
requireInputArray
▸ requireInputArray(key): TResult<TPortValue[], IDagError>
Parameters
| Name | Type |
|---|---|
key | string |
Returns
TResult<TPortValue[], IDagError>
Defined in
packages/dag-node/src/lifecycle/node-io-accessor.ts:61
requireInputBinary
▸ requireInputBinary(key, kind?): TResult<IParsedBinaryValue, IDagError>
Parameters
| Name | Type |
|---|---|
key | string |
kind? | "image" | "video" | "audio" | "file" |
Returns
TResult<IParsedBinaryValue, IDagError>
Defined in
packages/dag-node/src/lifecycle/node-io-accessor.ts:90
requireInputBinaryList
▸ requireInputBinaryList(key, kind?, options?): TResult<IParsedBinaryValue[], IDagError>
Parameters
| Name | Type |
|---|---|
key | string |
kind? | "image" | "video" | "audio" | "file" |
options? | Object |
options.minItems? | number |
options.maxItems? | number |
Returns
TResult<IParsedBinaryValue[], IDagError>
Defined in
packages/dag-node/src/lifecycle/node-io-accessor.ts:101
requireInputMediaReference
▸ requireInputMediaReference(key, options?): TResult<MediaReference, IDagError>
Parameters
| Name | Type |
|---|---|
key | string |
options? | Object |
options.allowStringUri? | boolean |
options.allowStringAssetUri? | boolean |
Returns
TResult<MediaReference, IDagError>
Defined in
packages/dag-node/src/lifecycle/node-io-accessor.ts:142
requireInputBinaryReference
▸ requireInputBinaryReference(key, kind?): TResult<MediaReference, IDagError>
Parameters
| Name | Type |
|---|---|
key | string |
kind? | "image" | "video" | "audio" | "file" |
Returns
TResult<MediaReference, IDagError>
Defined in
packages/dag-node/src/lifecycle/node-io-accessor.ts:153
setOutput
▸ setOutput(key, value): void
Parameters
| Name | Type |
|---|---|
key | string |
value | TPortValue |
Returns
void
Defined in
packages/dag-node/src/lifecycle/node-io-accessor.ts:175
toOutput
▸ toOutput(): TPortPayload
Returns
TPortPayload