Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/afraid-phones-love.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@effect/workflow": patch
---

Add Workflow type utils
35 changes: 35 additions & 0 deletions packages/workflow/src/Workflow.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,41 @@ import type { WorkflowEngine, WorkflowInstance } from "./WorkflowEngine.js"
*/
export const TypeId: unique symbol = Symbol.for("@effect/workflow/Workflow")

/**
* @since 1.0.0
*/
export declare namespace Workflow {
/**
* Extracts the type of the Payload of a `Workflow`.
*
* @since 1.0.0
* @category Type-level Utils
*/
export type Payload<W extends Workflow<any, any, any, any>> = W extends Workflow<any, infer Payload, any, any>
? Payload["Type"]
: never

/**
* Extracts the type of the Success of a `Workflow`.
*
* @since 1.0.0
* @category Type-level Utils
*/
export type Success<W extends Workflow<any, any, any, any>> = W extends Workflow<any, any, infer Success, any>
? Success["Type"]
: never

/**
* Extracts the type of the Error of a `Workflow`.
*
* @since 1.0.0
* @category Type-level Utils
*/
export type Error<W extends Workflow<any, any, any, any>> = W extends Workflow<any, any, any, infer Error>
? Error["Type"]
: never
}

/**
* @since 1.0.0
* @category Symbols
Expand Down