Skip to content

Commit 4d87689

Browse files
authored
docs: Explain the purpose of updateId (#1318)
1 parent 25a7695 commit 4d87689

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

packages/client/src/workflow-options.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,14 @@ export function compileWorkflowOptions<T extends WorkflowOptions>(options: T): W
6666
}
6767

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

0 commit comments

Comments
 (0)