Giter Club home page Giter Club logo

hourly's Introduction

Hourly

Hourly is a setInterval() replacement to conveniently set up firing on the hour

API

hourly(fn, offset, ...params)

fn {function} - the function to be repeatedly called. [offset] {number} - optional number of milliseconds to offset the hour by. [params] {...object} - optional parameters to pass into function.

Returned is a Promise which will resolve to the intervalId usable with clearInterval. Note that this will only be returned after the first invocation of hourly has already occured.

Executable

hourly.js is [also executable](https://github.com/rektide/hourly/blob/master/hourly.js#L42-L61], and will print the ISO8601 time to the screen on the hour.

Example

The example is based off the executable code, printing the date to the screen quarter past the hour.

var hourly = require("hourly")

// set to run at quarter past the hour
var interval = setHourly(() => console.log(new Date().toISOString()), 15 * 60 * 100)

// stop after 24 hours
setTimeout(()=> interval.then(interval => clearInterval), 24 * 60 * 60 * 1000)

Compatibility

Hourly is written in ES5 and is a CommonJS module.

hourly's People

Contributors

rektide avatar

Stargazers

John Elliott avatar

Watchers

 avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.