https://github.com/leflon/timers
https://github.com/leflon/timers
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/leflon/timers
- Owner: leflon
- License: mit
- Created: 2021-12-29T21:24:04.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-01T20:46:28.000Z (about 1 year ago)
- Last Synced: 2025-03-07T23:27:53.671Z (3 months ago)
- Language: TypeScript
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# better-timers
## Enhanced `setInterval` and `setTimeout`
## Installation
With `npm`:
```
npm install good-timers
```
With `yarn`:
```
yarn add good-timers
```
## Documentation
## [Interval](https://github.com/paulleflon/timers/blob/master/src/lib/Interval.ts)
### Constructor
```
new Interval(callback, params, ...args)
```
| Parameter | Type | Description |
| ---------- | ---- | ----------- |
| callback | Function | The function to recurrently execute |
| params | [IntervalParams](https://github.com/paulleflon/timers/blob/master/src/lib/IntervalParams.ts) \| number | Parameters of the interval. A number can be passed, it will be used as the interval's delay |
| args | [any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)[] | Arguments to pass in the callback function |
### Properties
| Property | Type | Description |
| -------- | ---- | ----------- |
| args | [any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)[] | Arguments to pass in the callback function |
| callback | Function | The function to recurrently execute |
| createdAt | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | The Date when the Interval was instanciated |
| delay | number | The delay between each execution of the callback |
| executions | number | The amount of times the callback function has been executed by the Interval |
| lastExecution | ?[Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | The Date when the last callback execution occured |
| maxExecutions | ?number | The maximum amount of callback executions before the interval automatically stops |
| paused | boolean | Whether the Interval is being paused |
| resetDelayOnPause | ?boolean | Whether to reset the delay of the next execution when the Interval gets paused |
| paused | boolean | Whether the Interval is being paused |
### Methods
| Method | Return Type | Description |
| ------ | ----------- | ----------- |
| pause | [void](https://www.typescriptlang.org/docs/handbook/2/functions.html?#void) | Pauses the Interval |
| resume | [void](https://www.typescriptlang.org/docs/handbook/2/functions.html?#void) | Resumes the Interval |
## [Timeout](https://github.com/paulleflon/timers/blob/master/src/lib/Timeout.ts)
### Constructor
```
new Timeout(callback, delay, ...args)
```
| Parameter | Type | Description |
| ---------- | ---- | ----------- |
| callback | Function | The function to execute |
| delay | number | The delay before the callback function is executed |
| args | [any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)[] | Arguments to pass in the callback function |
### Properties
| Property | Type | Description |
| -------- | ---- | ----------- |
| args | [any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)[] | Arguments to pass in the callback function |
| callback | Function | The function to execute |
| createdAt | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | The Date when the Timeout was instanciated |
| delay | number | The delay before the callback function is executed |
| finished | boolean | Whether the Timeout has finished |
| paused | boolean | Whether the Timeout is being paused |
| resumedAt | ?[Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | The Date when the Timeout was resumed |
### Methods
| Method | Return Type | Description |
| ------ | ----------- | ----------- |
| pause | [void](https://www.typescriptlang.org/docs/handbook/2/functions.html?#void) | Pauses the Timeout |
| rerun | [void](https://www.typescriptlang.org/docs/handbook/2/functions.html?#void) | Restarts the Timeout after it's finished. A `delay` parameter can be passed. |
| resume | [void](https://www.typescriptlang.org/docs/handbook/2/functions.html?#void) | Resumes the Timeout |
| stop | [void](https://www.typescriptlang.org/docs/handbook/2/functions.html?#void) | Stops the Timeout |