Timers

Documentation of Meteor's timeout APIs.

Meteor uses global environment variablesto keep track of things like the current request’s user. To make surethese variables have the right values, you need to useMeteor.setTimeout instead of setTimeout and Meteor.setIntervalinstead of setInterval.

These functions work just like their native JavaScript equivalents.If you call the native function, you’ll get an error stating that Meteorcode must always run within a Fiber, and advising to useMeteor.bindEnvironment.

Anywhere

Meteor.setTimeout(func, delay)

import { Meteor } from 'meteor/meteor' (meteor/timers.js, line 38)

Call a function in the future after waiting for a specified delay.

Arguments

• funcFunction

• The function to run

• delayNumber

• Number of milliseconds to wait before calling function

Returns a handle that can be used by Meteor.clearTimeout.

Anywhere

Meteor.setInterval(func, delay)

import { Meteor } from 'meteor/meteor' (meteor/timers.js, line 49)

Call a function repeatedly, with a time delay between calls.

Arguments

• funcFunction

• The function to run

• delayNumber

• Number of milliseconds to wait between each function call.

Returns a handle that can be used by Meteor.clearInterval.

Anywhere

Meteor.clearTimeout(id)

import { Meteor } from 'meteor/meteor' (meteor/timers.js, line 69)

Cancel a function call scheduled by Meteor.setTimeout.

Arguments

• idObject
• The handle returned by Meteor.setTimeout

Anywhere

Meteor.clearInterval(id)

import { Meteor } from 'meteor/meteor' (meteor/timers.js, line 59)

Cancel a repeating function call scheduled by Meteor.setInterval.

Arguments

• idObject
• The handle returned by Meteor.setInterval