react-timer-and-stopwatch
Advanced tools
Comparing version 0.5.0 to 0.5.1
{ | ||
"name": "react-timer-and-stopwatch", | ||
"version": "0.5.0", | ||
"version": "0.5.1", | ||
"description": "A countdown timer and stopwatch hook for React", | ||
@@ -5,0 +5,0 @@ "license": "MIT", |
@@ -30,3 +30,3 @@ # React Timer and Stopwatch hook | ||
### Duration timer | ||
To set up a timer with a duration, use the `timerWithDuration` object property on **useTimer**'s `options.create` object parameter. Inside of `timerWithDuration` are two properties, [`time`](#common-properties) (required) and the optional `directionOfTimeForward` bool property. The [`time`](#common-properties) property takes either a number of milliseconds or alternatively a [time object](#terminology). The optional `directionOfTimeForward` bool property controls whether the direction of the timer will flow forward (start at 00:00:00) or backward (start at end, finish at 00:00:00). Time flows backward by default on Duration timers. | ||
To set up a timer with a duration, use the `timerWithDuration` object property on **useTimer**'s `options.create` object parameter. Inside of `timerWithDuration` are two properties, [`time`](#common-parameters) (required) and the optional `directionOfTimeForward` bool property. The [`time`](#common-parameters) property takes either a number of milliseconds or alternatively a [time object](#terminology). The optional `directionOfTimeForward` bool property controls whether the direction of the timer will flow forward (start at 00:00:00) or backward (start at end, finish at 00:00:00). Time flows backward by default on Duration timers. | ||
#### Example | ||
@@ -33,0 +33,0 @@ ```jsx |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package