Skip to content

actaro-sdk


actaro-sdk / ActionDefinition

Interface: ActionDefinition<S, E>

Defined in: types.ts:12

Type Parameters

S

S extends z.ZodTypeAny = z.ZodTypeAny

E

E = unknown

Properties

description?

optional description?: string

Defined in: types.ts:14


execute

execute: (input) => Awaitable<E>

Defined in: types.ts:16

Parameters

input

TypeOf<S>

Returns

Awaitable<E>


idempotencyKey?

optional idempotencyKey?: (input) => string

Defined in: types.ts:18

Parameters

input

TypeOf<S>

Returns

string


input

input: S

Defined in: types.ts:15


metadata?

optional metadata?: Record<string, unknown>

Defined in: types.ts:19


name

name: string

Defined in: types.ts:13


verify

verify: (input, execution) => Awaitable<VerificationResult>

Defined in: types.ts:17

Parameters

input

TypeOf<S>

execution

E

Returns

Awaitable<VerificationResult>

Released under the MIT License.