Skip to content

Commit

Permalink
docs: Explain the purpose of updateId (#1318)
Browse files Browse the repository at this point in the history
  • Loading branch information
lorensr authored Feb 2, 2024
1 parent 25a7695 commit 4d87689
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions packages/client/src/workflow-options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,14 @@ export function compileWorkflowOptions<T extends WorkflowOptions>(options: T): W
}

export interface WorkflowUpdateOptions {
/**
* The Update Id, which is a unique-per-Workflow-Execution identifier for this Update.
*
* We recommend setting it to a meaningful business ID or idempotency key (like a request ID) passed from upstream. If
* it is not provided, it will be set to a random string by the Client. If the Server receives two Updates with the
* same Update Id to a Workflow Execution with the same Run Id, the second Update will return a handle to the first
* Update.
*/
readonly updateId?: string;
}

Expand Down

0 comments on commit 4d87689

Please sign in to comment.