timecount API

Welcome! This documentation was created in order to contribute to the maintainance and understanding of the source code of timecount.

Introduction

This NodeJS module is written using TypeScript and transpiled to the Standard ECMA-262 (ES6) specifications. The documentation is generated with the help of TypeDoc. The tests are performed via Mocha and Chai. The build tool is Gulp.

Explore the API

👉🏻 The right panel contains links to timecount modules. Clicking on a module will reveal more information about it as well and display a list of all its exported members (variables, types, functions, classes and interfaces).

The following classes are what provide most of the module's functionality:

• Time: nanosecond-based encapsulation of time lengths;
• TimeWriter: synthesize strings describing times;
• localization.Locale: translate synthesized strings;
• utils.BasicTimer: count the duration of your operations;
• utils.Timer: basic timer plus pausing;
• utils.StopWatch: timer plus time segmentation (laps).

Links

• GitHub Repository
• NpmJS Package
• Contributing to timecount
• Translating timecount
• Issues, suggestions and questions
• Contributors
• Project Changelog

---

Thanks for your interest in learning more about timecount!