aboutsummaryrefslogtreecommitdiff
path: root/tools/addon-sdk-1.3/packages/addon-kit/docs/timers.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/addon-sdk-1.3/packages/addon-kit/docs/timers.md')
-rw-r--r--tools/addon-sdk-1.3/packages/addon-kit/docs/timers.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/tools/addon-sdk-1.3/packages/addon-kit/docs/timers.md b/tools/addon-sdk-1.3/packages/addon-kit/docs/timers.md
new file mode 100644
index 0000000..bc36750
--- /dev/null
+++ b/tools/addon-sdk-1.3/packages/addon-kit/docs/timers.md
@@ -0,0 +1,48 @@
+<!-- contributed by Drew Willcoxon [adw@mozilla.com] -->
+<!-- contributed by Atul Varma [atul@mozilla.com] -->
+<!-- edited by Noelle Murata [fiveinchpixie@gmail.com] -->
+<!-- contributed by Irakli Gozalishvil [gozala@mozilla.com] -->
+
+The `timers` module provides access to web-like timing functionality.
+
+<api name="setTimeout">
+@function
+ Schedules `callback` to be called in `ms` milliseconds. Any additional
+ arguments are passed straight through to the callback.
+@returns {integer}
+ An ID that can later be used to undo this scheduling, if `callback` hasn't yet
+ been called.
+@param callback {function}
+ Function to be called.
+@param ms {integer}
+ Interval in milliseconds after which the function will be called.
+</api>
+
+<api name="clearTimeout">
+@function
+ Given an ID returned from `setTimeout()`, prevents the callback with the ID
+ from being called (if it hasn't yet been called).
+@param ID {integer}
+ An ID returned from `setTimeout()`.
+</api>
+
+<api name="setInterval">
+@function
+ Schedules `callback` to be called repeatedly every `ms` milliseconds. Any
+ additional arguments are passed straight through to the callback.
+@returns {integer}
+ An ID that can later be used to unschedule the callback.
+@param callback {function}
+ Function to be called.
+@param ms {integer}
+ Interval in milliseconds at which the function will be called.
+</api>
+
+<api name="clearInterval">
+@function
+ Given an ID returned from `setInterval()`, prevents the callback with the ID
+ from being called again.
+@param ID {integer}
+ An ID returned from `setInterval()`.
+</api>
+