JavaScript Date Helpers

A lightweight, tree shakable, and tested JavaScript library for working with dates.

Documentation

There is a documentation site which will inform you of the methods available. The documentation contains information like parameter types, return values and a short description what each method does. The documentation can be found here

Dependencies

The library itself has no dependencies. To be able to test and build the library a few packages are required. Most notably:

• Babel to create a version of the library which can be used on Node.js
• Mocha and Chai for unit testing
• Istanbul for code coverage

Installation and usage

To add the library to your project, you can install it using your favorite package manager like so:

npm install --save-dev js-date-helper

or

yarn add -D js-date-helper

With the library installed you can import only the methods you need.

import { addDays, addMonths } from 'js-date-helper';

If you use a bundler like Webpack or Rollup it will be able to tree shake the library and only bundle the library methods you use.

Missing something?

In case you're missing a feature or some of documentation is unclear, please create an issue on Github.

Contributing

Contributions are more than welcome. If you want to contribute to this project, please keep the following in mind:

• The project includes an editorconfig with rules for line feeds, indentation, etc. Make sure your changes follow to these settings.
• The project uses ESLint to lint the code, please make sure your changes do not introduce linting issues.
• Each library method lives in its own subfolder under the src folder. For each method there should be a similar named test file with the unit tests.

─ src/
  └─ myCoolFeature/
     ├─ myCoolFeature.js
     └─ myCoolFeature.test.js

• Each method must contain unit tests to make sure everything keeps working as intended.

License

This project is released under the MIT license.