Skip to content

Commit

Permalink
Merge pull request #118 from oneminch/master
Browse files Browse the repository at this point in the history
Update API documentation with two functions: isPaused() & getConfig()
  • Loading branch information
albert-gonzalez authored Mar 16, 2021
2 parents 322bc1b + 442b59f commit 57bfd88
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ If you want to use EasyTimer with React, you can use the EasyTimer React Hook. Y
- pause(): Pause the timer. After pause, you can call the start method without parameters to resume the timer.
- reset(): Reset the timer values
- isRunning(): Returns true if the timer is currently running.
- isPaused(): Returns true if the timer is paused.
- addEventListener(eventType, callback): Add a listener to an event. Timer triggers events when is updated
- Events triggered:
- secondTenthsUpdated
Expand All @@ -133,6 +134,7 @@ If you want to use EasyTimer with React, you can use the EasyTimer React Hook. Y
- off(eventType, callback): removeEventListener alias.
- getTimeValues(): Returns an object with the current values. The keys of the returned object are 'secondTenths', 'seconds', 'minutes', 'hours' and 'days'.
- getTotalTimeValues(): Returns an object with the current absolute values. The keys of the returned object are 'secondTenths', 'seconds', 'minutes', 'hours' and 'days'.
- getConfig(): Returns the configuration parameters.

## Browser Support

Expand Down

0 comments on commit 57bfd88

Please sign in to comment.