timeprettify

Lightweight duration formatter with multi-locale support.

Install

pnpm add timeprettify

Usage

import { format } from 'timeprettify'

format(3661) // '1 hour 1 minute'
format(3661, { locale: 'tm' }) // '1 sagat 1 minut'
format(3661, { locale: 'ru' }) // '1 час 1 минута'
format(3661, { style: 'short' }) // '1h 1min'
format(3661, { style: 'narrow' }) // '1h1m'
format(3661, { units: 1 }) // '1 hour'
format(3661, { locale: 'tr', style: 'short' }) // '1sa 1dk'

Options

| Option | Type | Default | Description | | -------- | ------------------------------- | -------- | --------------------------- | | locale | 'en' \| 'tr' \| 'ru' \| 'tm' | 'en' | Output language | | style | 'long' \| 'short' \| 'narrow' | 'long' | Format style | | units | number | 2 | Max number of units to show |

Styles

| Style | Example | | -------- | ------------------- | | long | 1 hour 30 minutes | | short | 1h 30min | | narrow | 1h30m |

createFormatter

Create a reusable formatter with preset options:

import { createFormatter } from 'timeprettify'

const formatTm = createFormatter({ locale: 'tm' })

formatTm(3600) // '1 sagat'
formatTm(90) // '1 minut 30 sekunt'
formatTm(3600, { style: 'short' }) // '1sek'

Locales

| Locale | Language | Plural forms | | ------ | -------- | ----------------------- | | en | English | singular / plural | | tr | Turkish | no plural | | tm | Turkmen | no plural | | ru | Russian | singular / few / plural |

License

MIT