count-up-down

This is the base repository that I use to create a simple static page for counting up or down.

How to Use

$3

We are using jsDelivr to distribute the package for browser usage. The HTML snippet is as the following.

``html




`

$3

To install the package, if you are using npm:

`bash


NPM.

`ts
import { calculate } from 'count-up-down';

const ONE_HOUR_AGO = new Date(new Date().getTime() - 3600 * 1000);

// {
// result: { days: 0, hours: 1, minutes: 0, months: 0, seconds: 0, years: 0 },
// type: 'countdown'
// }
console.log(calculate(new Date(), ONE_HOUR_AGO));
`

Documentation

The API documentation is generated using typedoc. Below are the links to the browser and Node package:

1. Browser
2. Node

To re-generate the documentation, we can do yarn generate:doc on the the root of this repository.

Development

$3

1. Yarn Classic (v1)
2. Node.js® LTS (at least v14)

After that, on root project, do this to install the dependencies:

`bash
yarn
`

$3

The following is the information on each of the important folders in this repository.

1. plugins folder contains the plugins for esbuild
2. scripts folder contains build scripts
3. src` folder contains the main library code

Versioning

This library follows semantic versioning. Please visit https://semver.org for more information.

License

See LICENSE.