# Niobe

> Human-readable durations for JavaScript and TypeScript

Use Niobe to write durations as `minutes(2) + seconds(30)` instead of `150_000`, convert milliseconds back to any unit, parse strings like `1h 30m`, read and write clock strings like `01:30:00`, and split a duration into its parts.

Install it with `npm install niobe`. It has no runtime dependencies and works in Node and browsers. Every value is a number of milliseconds. Its types (`node_modules/niobe/dist/index.d.ts`) are the most reliable reference for the installed version.

In the examples, `// =>` comments show the value a line returns, and comments under a line show the type TypeScript infers for it.

## Table of Contents

### Introduction

- [Getting started](https://simmo.github.io/niobe/guide/getting-started.md): Install Niobe and write your first readable durations.

### Essentials

- [Converting units](https://simmo.github.io/niobe/guide/conversion.md): Turn amounts of any time unit into milliseconds, and milliseconds back into any unit.
- [Constants](https://simmo.github.io/niobe/guide/constants.md): Constants for the length of each time unit, and for how many of one unit fit in the next.

### Formats

- [Duration strings](https://simmo.github.io/niobe/guide/duration-strings.md): Parse duration strings such as '1h 30m' into milliseconds with parseDuration.
- [Clock strings](https://simmo.github.io/niobe/guide/clock-strings.md): Read and write clock strings such as '01:30:00' with clockToMs and msToClock.
- [Parts](https://simmo.github.io/niobe/guide/parts.md): Split a duration into weeks, days, hours and smaller units with msToParts, and join them with partsToMs.

### Going further

- [FAQ](https://simmo.github.io/niobe/guide/faq.md): Answers to common questions about Niobe.

### API reference

- [Conversion](https://simmo.github.io/niobe/api/conversion.md): Reference for the unit converters, weeks to nanoseconds, and their from methods.
- [Utilities](https://simmo.github.io/niobe/api/utilities.md): Reference for parseDuration, clockToMs, msToClock, msToParts and partsToMs.
- [Constants](https://simmo.github.io/niobe/api/constants.md): Reference for every constant, including unit lengths in milliseconds, and how many of each unit fit in the next.
- [Types](https://simmo.github.io/niobe/api/types.md): Reference for the Parts and TimeUnit types.

### Other

- [Changelog](https://simmo.github.io/niobe/changelog.md): Every notable change to Niobe, by release.