Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 1.75 KB

README.md

File metadata and controls

43 lines (28 loc) · 1.75 KB

Aevum

Travis npm Version npm bundle size (minified) Maintainability Test Coverage npm License


Aevum is a highly customizable and lightweight timer formatter, aimed to be used in high-performance applications. Therefore it's optimized in speed but still letting you tune everything you need to do.

It does not have any runtime dependencies and can be used in any modern JavaScript environment.


Installation

yarn add aevum
npm install aevum

Usage

// ES6 Import
import { Aevum } from 'aevum';

// CommonJS Module
const Aevum = require('aevum').Aevum;

const instance = new Aevum('My timer says: (h:[h]:)(m:[m]:)(s:[s].)(ddd)');

instance.format(1234); // "My timer says: 1.234"

Documentation

A more detailed documentation about the installation process, how to build the library as well as as a in-depth description about the usage can be found in the Documentation

For changes to the Documentation, see the Documentation Repository