Skip to content

[DO] Clarifying getAlarm behaviour if called while alarm is running #20175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 24, 2025
Merged

[DO] Clarifying getAlarm behaviour if called while alarm is running #20175

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
364991e
Clarifying getAlarm behaviour if called while alarm is running.
Oxyjun Feb 21, 2025
0ddd200
Wording tweak.
Oxyjun Feb 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/content/docs/durable-objects/api/alarms.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ Alarms can be used to build distributed primitives, like queues or batching of w

- If there is an alarm set, then return the currently set alarm time as the number of milliseconds elapsed since the UNIX epoch. Otherwise, return `null`.

- If `getAlarm` is called while an [`alarm`](/durable-objects/api/alarms/#alarm) is already running, it returns `null` unless `setAlarm` has also been called since the alarm handler started running.

### `setAlarm`

- <code>{" "}setAlarm(scheduledTimeMs <Type text="number" />)</code>
Expand Down Expand Up @@ -62,6 +64,7 @@ Alarms can be used to build distributed primitives, like queues or batching of w
- `retryCount` <Type text="number"/>: The number of times this alarm event has been retried.
- `isRetry` <Type text="boolean"/>: A boolean value to indicate if the alarm has been retried. This value is `true` if this alarm event is a retry.


- The `alarm()` handler has guaranteed at-least-once execution and will be retried upon failure using exponential backoff, starting at 2 second delays for up to 6 retries. Retries will be performed if the method fails with an uncaught exception.

- This method can be `async`.
Expand Down
Loading