unites
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

Unites Build Status npm npm JavaScript Style Guide

Fast utility for calculate SI and Binary unit prefixes (Units of information). ⚡️

Install

Yarn

yarn add unites

NPM

npm install unites

UMD file is also available on unpkg:

<script src="https://unpkg.com/unites/unites.umd.min.js"></script>

You can use the library via window.unites.

Usage

Metric prefix (SI)

Calculates the Metric prefix (SI) and returns the size.

import { si } from 'unites'
 
si('1M').kilos()
// 1000
 
si(1, 'M').kilos()
// 1000

Binary prefix

Calculates the Binary prefix and returns the size.

import { binary } from 'unites'
 
binary('1G').megas()
// 1024
 
binary(1, 'G').megas()
// 1024

API

Unit prefixes

import { si, binary } from 'unites'
 
si (valuenumber | string, symbol?: string)Units
binary (valuenumber | string, symbol?: string)Units

Measurement units

si('1M').bytes()  // number
si('1M').kilos()  // number
si('1M').megas()  // number
si('1M').gigas()  // number
si('1M').teras()  // number
si('1M').petas()  // number
si('1M').exas()   // number
si('1M').yottas() // number
  1. Number values supported: Make sure that symbol param contains k, M, G, T, P, E, Z or Y.
  2. String values supported: 1k, 0.5M, 10G, 1T, 1.5P, 0E, 2Z or 0.0001Y

Contributions

Feel free to send some Pull request or issue.

License

MIT license

© 2018 José Luis Quintana

/unites/

    Package Sidebar

    Install

    npm i unites

    Weekly Downloads

    1

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    11.1 kB

    Total Files

    7

    Last publish

    Collaborators

    • joseluisq