react-hook-time - npm Package Compare versions

Comparing version 0.0.1-alpha.9 to 0.0.1-beta.1

dist/src/useTimer/types.d.ts

@@ -59,3 +59,3 @@ export interface ITimeObject {
 }
-export interface IimerResultWithUpdate {
+export interface ITimerResultWithUpdate {
     start: () => void;
@@ -77,3 +77,3 @@ pause: () => void;
 }
-export interface IimerResultWithoutUpdate {
+export interface ITimerResultWithoutUpdate {
     start: () => void;
@@ -80,0 +80,0 @@ cancel: () => void;

dist/src/useTimer/useTimer.d.ts

@@ -1,2 +0,2 @@
-import { TTimerInitialTime, ITimerWithoutUpdate, IStopwatch, ITimer, IimerResultWithUpdate, IimerResultWithoutUpdate } from './types';
-export default function useTimer<T extends ITimer | ITimerWithoutUpdate | IStopwatch>(initialTimeOrSettings: TTimerInitialTime | T, settingsOrInitialTime?: T): T['preventUpdate'] extends true ? IimerResultWithoutUpdate : IimerResultWithUpdate;
+import { TTimerInitialTime, ITimerWithoutUpdate, IStopwatch, ITimer, ITimerResultWithUpdate, ITimerResultWithoutUpdate } from './types';
+export default function useTimer<T extends ITimer | ITimerWithoutUpdate | IStopwatch>(initialTimeOrSettings: TTimerInitialTime | T, settingsOrInitialTime?: T): T['preventUpdate'] extends true ? ITimerResultWithoutUpdate : ITimerResultWithUpdate;

package.json

 {
   "name": "react-hook-time",
-  "version": "0.0.1-alpha.9",
+  "version": "0.0.1-beta.1",
   "type": "module",
@@ -5,0 +5,0 @@ "description": "A React timer library",

README.md

@@ -1,4 +0,7 @@
-
 ![react-hook-time](https://github.com/dancheskus/react-hook-time/assets/35524994/5d76edad-11dc-403c-8fcb-607d2693168f)
 
+`react-hook-time` is a library for React that allows you to create timers and stopwatches in your applications. It supports TypeScript and provides a simple and clear API, making it easy to customize according to your needs. You can set initial time, choose time units, configure callbacks, and much more.
+
+[Demo](https://gg66l2.csb.app/)
+
 ### Install
@@ -25,1 +28,60 @@
 ```
+
+### API
+There are 3 options to pass arguments to `useTimer()`. You can pass initialTime, initialTime and settings object or just settings object
+```js
+const timer = useTimer(10)
+const timerWithoutUpdates = useTimer(15, { preventUpdate: true })
+const stopwatch = useTimer({ stapwatch: true })
+```
+
+#### Props
+**name** | **description**  | **type** | **default value**
+--|--|--|--
+autostart | enables autostart on component mount | boolean | false
+preventUpdate* | disables component re-render on every tick | boolean | false
+stopwatch* | enables stopwatch with time going up | boolean | false
+speedUpFirstSecond | first tick will happen faster after timer starts. Visual thing similar to iOS timers | boolean | false
+
+**preventUpdate** - with this prop most of the callbacks are not working. Only `onStart`, `onEnd` and `onCancel` are available
+**stopwatch** - with this prop `onEnd` callback is disabled
+
+#### Methods
+> `const timer = useTimer(10)`
+
+`timer` returns some values and functions
+**name** | **description**  | **type**
+--|--|--
+currentTime | current time | number
+formattedCurrentTime | you can get `years, days, hours, minutes, seconds` from this object | object
+isRunning | current timer state | boolean
+start | start timer | () => void
+pause | pause timer | () => void
+reset | reset time to initial value | (**resetSettings**) => void
+setTime | set new time value | (timeAmount, **timeSettings**) => void
+decTimeBy | decrease time | (timeAmount, **timeSettings**) => void
+incTimeBy | increase time | (timeAmount, **timeSettings**) => void
+
+#### *resetSettings*
+
+**name** | **description**  | **type** | **default value**
+--|--|--|--
+startIfWasStopped | starts timer after updating, increasing and decreasing time if was stopped before | boolean | false
+continueIfWasRunning | continues timer after updating, increasing and decreasing time if was running before | boolean | false
+
+#### *timeSettings*
+The same as ***resetSettings***  with one more key
+**name** | **description**  | **type** | **default value**
+--|--|--|--
+timeUnit | specifying the time unit to perform a function |  'ms'  \|  'sec'  \|  'min'  \|  'hour'  \|  'day' | 'sec'
+
+#### Callbacks
+**name** | **description**  | **return value**
+--|--|--
+onCancel | triggers when timer was cancelled | undefined
+onEnd | triggers when timer was ended | undefined
+onPause | triggers when timer was paused | currentTime
+onStart | triggers when timer was started | currentTime
+onReset | triggers when timer was reseted | currentTime
+onUpdate | triggers on every tick | currentTime
+onTimeSet | triggers when timer was set | currentTime

No alert changes

Improved metrics

Total package byte prevSize

46722

increased by6.76%

Number of lines in readme file

86

increased by244%

No dependency changes