Skip to content

Commit c26b3d9

Browse files
committed
Update README.md
Update README.md with disabled option.
1 parent d819b57 commit c26b3d9

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ A simple and effective way of handling JavaScript internals using jQuery. Versio
44
## Creating a new timer
55
Timers are created with an easy to remember syntax.
66

7-
var timer = $.timer(timeout, callback);
7+
var timer = $.timer(timeout, callback, disabled);
88

99
- `timeout` is the time to set the interval to run at, in milliseconds.
10-
11-
The callback option can obviously be either a reference to another function, or an anonymous function.
10+
- `callback` can be either a reference to another function, or an anonymous function.
11+
- `disabled` if set to true, the timer is created inactive, needs a .reset() to trigger first. Optional.
1212

1313
## Timer methods
1414
In the chance that you need to stop or reset your timer, you can use the following two methods:

0 commit comments

Comments
 (0)