brendonmatos / duration

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

unduration

npm version npm downloads bundle Codecov

unduration is a tiny (0.2kb) library that aims to standardize the way we handle durations in JavaScript, aiming to replace things like:

defineHandler('/', {
  ttl: 1000 * 60 * 60 * 24,
  // OR worser
  ttl: 86_400_000
})

With:

defineHandler('/', {
  ttl: '1m',
  // OR
  ttl: {
    minutes: 1,
  }
})

Libraries tend to use different formats for durations, which makes it hard to use them together. unduration aims to solve this problem by providing a standard way to define durations, and utilities to use this standard.

Usage

Install package:

# npm
npm install unduration

# yarn
yarn add unduration

# pnpm
pnpm install unduration

# bun
bun install unduration

Import:

// ESM
import { defineDuration } from "unduration";

// CommonJS
const { defineDuration } = require("unduration");

Development

  • Clone this repository
  • Install latest LTS version of Node.js
  • Enable Corepack using corepack enable
  • Install dependencies using pnpm install
  • Run interactive tests using pnpm dev

License

Made with đź’›

Published under MIT License.

About

License:MIT License


Languages

Language:TypeScript 100.0%