Skip to content
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

doc: add notes that timer jobs should be side-effect-free #682

Merged
merged 1 commit into from
Jan 20, 2025
Merged

doc: add notes that timer jobs should be side-effect-free #682

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions src/Timer.mo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ module {
/// Installs a one-off timer that upon expiration after given duration `d`
/// executes the future `job()`.
///
/// Note: Since `job` can be called more than once (under rare circumstances),
/// it should not possess side-effects.
///
/// ```motoko no-repl
/// let now = Time.now();
/// let thirtyMinutes = 1_000_000_000 * 60 * 30;
Expand All @@ -37,6 +40,8 @@ module {
/// executes the future `job()` and reinserts itself for another expiration.
///
/// Note: A duration of 0 will only expire once.
/// Note: Since `job` can be called more than once (under rare circumstances),
/// it should not possess side-effects.
///
/// ```motoko no-repl
/// func checkAndWaterPlants() : async () {
Expand Down
Loading