Skip to content

Commit

Permalink
doc(activity): Document timestamps in Activity Info (#1527)
Browse files Browse the repository at this point in the history
  • Loading branch information
ikonst authored Sep 25, 2024
1 parent e91df70 commit 4aeb455
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions packages/activity/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -152,25 +152,37 @@ export interface Info {
*/
readonly workflowType: string;
/**
* Timestamp for when this Activity was scheduled in milliseconds
* Timestamp for when this Activity was first scheduled.
* For retries, this will have the timestamp of the first attempt.
* See {@link currentAttemptScheduledTimestampMs} for current attempt.
*
* @format number of milliseconds from epoch
*/
readonly scheduledTimestampMs: number;
/**
* Timeout for this Activity from schedule to close in milliseconds.
* Timeout for this Activity from schedule to close.
*
* @format number of milliseconds
*/
readonly scheduleToCloseTimeoutMs: number;
/**
* Timeout for this Activity from start to close in milliseconds
* Timeout for this Activity from start to close.
*
* @format number of milliseconds
*/
readonly startToCloseTimeoutMs: number;
/**
* Timestamp for when the current attempt of this Activity was scheduled in milliseconds
* Timestamp for when the current attempt of this Activity was scheduled.
*
* @format number of milliseconds from epoch
*/
readonly currentAttemptScheduledTimestampMs: number;
/**
* Heartbeat timeout in milliseconds.
* Heartbeat timeout.
* If this timeout is defined, the Activity must heartbeat before the timeout is reached.
* The Activity must **not** heartbeat in case this timeout is not defined.
*
* @format number of milliseconds
*/
readonly heartbeatTimeoutMs?: number;
/**
Expand Down

0 comments on commit 4aeb455

Please sign in to comment.