@aikirun/types
v0.1.13
Published
Core type definitions for Aiki - including workflow, task, client, and trigger types
Readme
@aikirun/types
Core type definitions for Aiki durable execution engine.
This package provides the foundational TypeScript types used throughout the Aiki ecosystem. It is typically not used directly, but imported by other Aiki packages.
Installation
npm install @aikirun/typesExports
/client
Types for the client package, including client configuration and response types.
/trigger
Trigger strategy types for controlling when workflows should execute:
immediate- Execute immediatelydelayed- Execute after a durationstartAt- Execute at a specific timestamp
/workflow
Workflow definition types and interfaces.
/task
Task definition and execution types.
/workflow-run
Runtime state and execution types for workflow runs:
- Workflow run states (scheduled, queued, running, sleeping, etc.)
- Task execution states
- Child workflow execution states
- Event waiting conditions
/workflow-run-api
API contract types for workflow run operations.
/serializable
Types for serializable error handling.
Usage
These types are primarily used by other Aiki packages:
import type { WorkflowOptions } from "@aikirun/types/workflow-run";
import type { TriggerStrategy } from "@aikirun/types/trigger";Related Packages
- @aikirun/lib - Foundation utilities
- @aikirun/client - Client SDK
- @aikirun/workflow - Workflow SDK
- @aikirun/task - Task SDK
- @aikirun/worker - Worker SDK
License
Apache-2.0
