eve
Version:
Filesystem-first framework for durable backend AI agents that run anywhere.
42 lines • 1.28 kB
TypeScript
export interface StepMetadata {
/**
* The name of the step.
*/
stepName: string;
/**
* Unique identifier for the currently executing step.
* Useful to use as part of an idempotency key for critical
* operations that must only be executed once (such as charging a customer).
*
* @remarks
*
* Only available inside a step function.
* Accessing this property in a workflow function will throw an error.
*/
stepId: string;
/**
* Timestamp when the current step started.
*
* @remarks
*
* Only available inside a step function.
* Accessing this property in a workflow function will throw an error.
*/
stepStartedAt: Date;
/**
* The number of times the current step has been executed. This will increase with each retry.
*
* @remarks
*
* Only available inside a step function.
* Accessing this property in a workflow function will throw an error.
*/
attempt: number;
}
/**
* Returns metadata available in the current step function.
* It uses `AsyncLocalStorage` to store the context and
* retrieve it in the step function.
*/
export declare function getStepMetadata(): StepMetadata;
//# sourceMappingURL=get-step-metadata.d.ts.map