smarttime/readme.md

51 lines
2.3 KiB
Markdown
Raw Normal View History

2018-10-21 15:23:58 +00:00
# @pushrocks/smarttime
2019-04-10 09:34:30 +00:00
handle time in smart ways
2018-03-11 15:44:32 +00:00
2019-04-10 09:34:30 +00:00
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smarttime)
* [gitlab.com (source)](https://gitlab.com/pushrocks/smarttime)
* [github.com (source mirror)](https://github.com/pushrocks/smarttime)
* [docs (typedoc)](https://pushrocks.gitlab.io/smarttime/)
2017-08-16 12:39:25 +00:00
## Status for master
2019-04-10 09:34:30 +00:00
[![build status](https://gitlab.com/pushrocks/smarttime/badges/master/build.svg)](https://gitlab.com/pushrocks/smarttime/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smarttime/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smarttime/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smarttime.svg)](https://www.npmjs.com/package/@pushrocks/smarttime)
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smarttime/badge.svg)](https://snyk.io/test/npm/@pushrocks/smarttime)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
2017-08-16 12:39:25 +00:00
## Usage
2018-03-11 15:44:32 +00:00
2017-08-16 12:39:25 +00:00
Use TypeScript for best in class instellisense.
2018-10-21 10:12:44 +00:00
Smarttime offers smart ways to deal with time.
2019-06-17 14:54:39 +00:00
### class CronManager
This class provides scheduling of functions with a cron syntax
```typescript
import { CronManager } from '@pushrocks/smarrtime';
const cronManagerInstance = new CronManager();
cronManagerInstance.addConrjob('* * * * * *', async () => {
console.log('hello'); // will log 'hello' to console once every second;
})
cronManagerInstance.start();
```
2018-10-21 15:23:58 +00:00
2019-06-17 14:54:39 +00:00
### class ExtendedDate
This class offers static functions to create zone specific JavaScript dates from European formated time strings.
2018-10-21 15:23:58 +00:00
```TypeScript
import { ExtendedDate } from '@pushrocks/smarttime'
const myDate: Date = ExtendedDate.fromEuropeanDate('8.6.2018')
```
2019-04-10 09:34:30 +00:00
For further information read the linked docs at the top of this readme.
2017-08-16 12:39:25 +00:00
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
2019-04-10 09:34:30 +00:00
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
2017-08-16 12:39:25 +00:00
2019-04-10 09:34:30 +00:00
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)