# schedule-function

> A package to continuously run a function.

Latest version **1.0.2** (published 2022-05-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install schedule-function
pnpm add schedule-function
yarn add schedule-function
bun add schedule-function
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2022-05-17 |
| First published | 2020-08-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ryan Eghrari |
| Maintainers | ryaneghrari |
| Keywords | chain |

## Links

- npm: https://www.npmjs.com/package/schedule-function
- npm.io page: https://npm.io/package/schedule-function

## Dependencies (2)

- [joi](https://npm.io/package/joi.md) ^17.1.1
- [cron](https://npm.io/package/cron.md) ^1.8.2

## Recent versions

- 1.0.2 (latest) — 2020-08-03
- 1.0.1 — 2020-08-03
- 1.0.0 — 2020-08-03

## README

# schedule-function 

## About
`schedule-function` allows you to rerun a function once it completes. You can also pass a delay (in seconds) to wait before re-running the function. Lastly you can pass an `onComplete` function which will run each time the `run` function is completed. 

## Quick start

1. `npm i schedule-function`
2. `const fschedule = require('schedule-function');`
3. Call schedule function you want to continuously run.

```javascript
const fscheduler = require('schedule-function');

fscheduler.schedule({
	delay: 10, //seconds
	run: () => { console.log('function I want to run continuously') },
})
```

## Help
Contact [Ryan Eghrari](mailto:ryan@raidoninc.com), if you have any problems.

---
_Source: https://npm.io/package/schedule-function · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._