Fix typos in heartbeat JSDoc (#1863)

daveyarwood · web-flow · commit 981d3f11eb47 · 2025-12-29T11:38:29.000-05:00
diff --git a/packages/activity/src/index.ts b/packages/activity/src/index.ts
@@ -453,7 +453,7 @@ export function sleep(ms: Duration): Promise<void> {
  * attribute set to a {@link TimeoutFailure}, which has the last value of `details` available at
  * {@link TimeoutFailure.lastHeartbeatDetails}.
  *
- * This is a shortcut for `Context.current().heatbeat(ms)` (see {@link Context.heartbeat}).
+ * This is a shortcut for `Context.current().heartbeat(details)` (see {@link Context.heartbeat}).
  */
 export function heartbeat(details?: unknown): void {
   Context.current().heartbeat(details);

Original file line number	Diff line number	Diff line change
`@@ -453,7 +453,7 @@ export function sleep(ms: Duration): Promise<void> {`
`453`	`453`	* attribute set to a {@link TimeoutFailure}, which has the last value of `details` available at
`454`	`454`	`* {@link TimeoutFailure.lastHeartbeatDetails}.`
`455`	`455`	`*`
`456`		- * This is a shortcut for `Context.current().heatbeat(ms)` (see {@link Context.heartbeat}).
	`456`	+ * This is a shortcut for `Context.current().heartbeat(details)` (see {@link Context.heartbeat}).
`457`	`457`	`*/`
`458`	`458`	`export function heartbeat(details?: unknown): void {`
`459`	`459`	`Context.current().heartbeat(details);`