Skip to content
/ runout Public

Helper to know if you are running out of time

License

Notifications You must be signed in to change notification settings

bredele/runout

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Runout

Build Status NPM Downloads pledge

Given an expiration limit, filter dates that are valid, expired or expire soon. This helper also accepts dates formatted in milliseconds or in RFC822 or ISO 861 string formats.

Usage

const runout = require('runout')

// example using instance of Date
runout([
  new Date('01-01-2000'),
  new Date('01-01-2100'),
  new Date('01-01-2300'),
], new Date('01-01-2101'))
// { valid: [946710000000, 4102470000000], expired: [10413817200000], soon: []}

// exmaple using RFC822 formats
runout([
  new Date('01-01-2000'),
  '01-01-2100',
  new Date('01-01-2300'),
], '01-01-2101')
// { valid: [946710000000, 4102470000000], expired: [10413817200000], soon: []}


// example with a year time range for dates expiring soon
runout([
  new Date('01-01-2000'),
  new Date('01-01-2100'),
  new Date('12-06-2100'),
  new Date('01-01-2300'),
], new Date('01-01-2101'), 1000 * 60 * 60 * 24 * 365)
// { valid: [946710000000, 4102470000000], expired: [10413817200000], soon: [4102470000000, 4131759600000]}

Installation

npm install runout --save

NPM

Question

For questions and feedback please use our twitter account. For support, bug reports and or feature requests please make sure to read our community guideline and use the issue list of this repo and make sure it's not present yet in our reporting checklist.

Contribution

runout is an open source project and would not exist without its community. If you want to participate please make sure to read our guideline before making a pull request. If you have any runout related project, component or other let everyone know in our wiki.

License

The MIT License (MIT)

Copyright (c) 2016 Olivier Wietrich

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Helper to know if you are running out of time

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published