Skip to content

bartlomiejzuber/use-cron-parser

Repository files navigation

use-cron-parser

react hook fully typed npm Build Status License Netlify Status

hook icon

Useful & super tiny (bundlephobia package size less than 5KB ✔️) (❤️obvious dep on React & single function from date-fns) hook to parse cron expression and get Date object with next cron occurrence.

Installation

npm i use-cron-parser --save

Alternatively you may use yarn:

yarn add use-cron-parser

Link to npm: https://www.npmjs.com/package/use-cron-parser

Usage

import React from 'react';
import { useCronParser }  from 'use-cron-parser';

const App = () => {
  const cronExpression = "10 * * * *";
  const cron = useCronParser(cronExpression);
  
  return (
    <div className="App">
      <div>{cronExpression}</div>
      <div>{cron.next()}</div>
    </div>
  );
}

export default App;

DEMO

Hook params

Parameter Type Description Required
cronExpression string Cron expression to parse Y
options useCronParserOptions Set of hook options (skipValidation etc.) N

Options

Option Description Default
skipValidation Flag to skip/or not validation. false

Dependencies Deps

Single function from date-fns package & ❤️obvious peer dep on React only.

Reliability

This package is fully tested with total coverage set to Coverage Status. If you found any issue please report it here.

License

Made with 💖 by Bartlomiej Zuber (bartlomiej.zuber@outlook.com) and licensed under the MIT License

About

Useful & super tiny (<5KB ✔️) hook for cron expression handling in React

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published