Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
b403e1f
chore(deps): update dependency @testing-library/react to v11.2.2 (#44)
renovate[bot] Jan 26, 2021
efa2153
chore(deps): update react monorepo to v16.14.0 (#45)
renovate[bot] Jan 26, 2021
5bef50c
chore(deps): update dependency @types/node to v14.14.10 (#46)
renovate[bot] Jan 26, 2021
5406c30
chore(deps): pin dependency parcel-bundler to 1.12.4 (#53)
renovate[bot] Jan 26, 2021
c7b5153
chore(deps): update dependency @types/react-dom to v17 (#62)
renovate[bot] Jan 26, 2021
44e22f1
chore(deps): update dependency typescript to v4.1.2 (#56)
renovate[bot] Jan 26, 2021
b5892ff
chore(deps): update dependency ts-jest to v26.4.4 (#55)
renovate[bot] Jan 26, 2021
c3e20ee
Issues caused by missing items in hook dependency arrays (#63)
zpchavez Feb 10, 2021
ce81ea4
Adding option to initialize timer with a status of 'RUNNING' or 'PAUS…
robynm Nov 11, 2021
64ff764
chore(deps): bump elliptic from 6.5.3 to 6.5.4 (#66)
dependabot[bot] Nov 11, 2021
466cfc0
chore(deps): bump y18n from 4.0.0 to 4.0.1 (#67)
dependabot[bot] Nov 11, 2021
d0a46e4
chore(deps): bump lodash from 4.17.19 to 4.17.21 (#68)
dependabot[bot] Nov 11, 2021
d46d828
chore(deps): bump hosted-git-info from 2.8.5 to 2.8.9 (#69)
dependabot[bot] Nov 11, 2021
912f667
chore(deps): bump browserslist from 4.14.5 to 4.16.6 (#70)
dependabot[bot] Nov 11, 2021
71bb747
chore(deps): bump path-parse from 1.0.6 to 1.0.7 (#71)
dependabot[bot] Nov 11, 2021
180682a
chore(deps): bump tmpl from 1.0.4 to 1.0.5 (#72)
dependabot[bot] Nov 11, 2021
fafdd8f
chore(deps): bump ws from 5.2.2 to 5.2.3 (#75)
dependabot[bot] Nov 12, 2021
8867e8d
chore(deps): bump color-string from 1.5.4 to 1.6.0 (#76)
dependabot[bot] Nov 12, 2021
8342843
chore(deps): bump ajv from 6.10.2 to 6.12.6 (#78)
dependabot[bot] Feb 13, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,13 +113,14 @@ const { time, start, pause, reset, status } = useTimer({

The configuration and all its parameters are optional.

| Property | Type | Default value | Description |
| ------------ | -------- | ------------- | -------------------------------------------------------------------------------------- |
| autostart | boolean | false | Pass true to start timer automatically |
| endTime | number | null | The value for which timer stops |
| initialTime | number | 0 | The starting value for the timer |
| interval | number | 1000 | The interval in milliseconds |
| onTimeOver | function | | Callback function that is called when time is over |
| onTimeUpdate | function | | Callback function that is called when time is updated |
| step | number | 1 | The value to add to each increment / decrement |
| timerType | string | "INCREMENTAL" | The choice between a value that increases ("INCREMENTAL") or decreases ("DECREMENTAL") |
| Property | Type | Default value | Description |
| ------------- | -------- | ------------- | -------------------------------------------------------------------------------------- |
| autostart | boolean | false | Pass true to start timer automatically |
| endTime | number | null | The value for which timer stops |
| initialStatus | string | "STOPPED" | The initial status for the timer. Options are: "RUNNING", "PAUSED", and "STOPPED" |
| initialTime | number | 0 | The starting value for the timer |
| interval | number | 1000 | The interval in milliseconds |
| onTimeOver | function | | Callback function that is called when time is over |
| onTimeUpdate | function | | Callback function that is called when time is updated |
| step | number | 1 | The value to add to each increment / decrement |
| timerType | string | "INCREMENTAL" | The choice between a value that increases ("INCREMENTAL") or decreases ("DECREMENTAL") |
Loading