Skip to content

Commit 4aeb455

Browse files
authored
doc(activity): Document timestamps in Activity Info (#1527)
1 parent e91df70 commit 4aeb455

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

packages/activity/src/index.ts

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -152,25 +152,37 @@ export interface Info {
152152
*/
153153
readonly workflowType: string;
154154
/**
155-
* Timestamp for when this Activity was scheduled in milliseconds
155+
* Timestamp for when this Activity was first scheduled.
156+
* For retries, this will have the timestamp of the first attempt.
157+
* See {@link currentAttemptScheduledTimestampMs} for current attempt.
158+
*
159+
* @format number of milliseconds from epoch
156160
*/
157161
readonly scheduledTimestampMs: number;
158162
/**
159-
* Timeout for this Activity from schedule to close in milliseconds.
163+
* Timeout for this Activity from schedule to close.
164+
*
165+
* @format number of milliseconds
160166
*/
161167
readonly scheduleToCloseTimeoutMs: number;
162168
/**
163-
* Timeout for this Activity from start to close in milliseconds
169+
* Timeout for this Activity from start to close.
170+
*
171+
* @format number of milliseconds
164172
*/
165173
readonly startToCloseTimeoutMs: number;
166174
/**
167-
* Timestamp for when the current attempt of this Activity was scheduled in milliseconds
175+
* Timestamp for when the current attempt of this Activity was scheduled.
176+
*
177+
* @format number of milliseconds from epoch
168178
*/
169179
readonly currentAttemptScheduledTimestampMs: number;
170180
/**
171-
* Heartbeat timeout in milliseconds.
181+
* Heartbeat timeout.
172182
* If this timeout is defined, the Activity must heartbeat before the timeout is reached.
173183
* The Activity must **not** heartbeat in case this timeout is not defined.
184+
*
185+
* @format number of milliseconds
174186
*/
175187
readonly heartbeatTimeoutMs?: number;
176188
/**

0 commit comments

Comments
 (0)