https://github.com/edwinm/kilomega

Get the right unit prefix like kilo of mega for a certain bit or byte amount.
https://github.com/edwinm/kilomega

Last synced: 3 days ago
JSON representation

Get the right unit prefix like kilo of mega for a certain bit or byte amount.

• Host: GitHub
• URL: https://github.com/edwinm/kilomega
• Owner: edwinm
• License: mit
• Created: 2019-04-05T15:53:42.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-02T09:29:48.000Z (11 months ago)
• Last Synced: 2024-10-07T13:35:42.276Z (about 1 month ago)
• Language: JavaScript
• Size: 1.54 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build status](https://api.travis-ci.com/edwinm/kilomega.svg?branch=master&status=unknown)](https://app.travis-ci.com/github/edwinm/kilomega) [![Coverage Status](https://coveralls.io/repos/github/edwinm/kilomega/badge.svg?branch=master)](https://coveralls.io/github/edwinm/kilomega?branch=master) [![Socket Badge](https://socket.dev/api/badge/npm/package/kilomega)](https://socket.dev/npm/package/kilomega) [![Snyk test results](https://snyk.io/test/github/edwinm/kilomega/badge.svg)](https://snyk.io/test/github/edwinm/kilomega) [![npm version](https://badge.fury.io/js/kilomega.svg)](https://www.npmjs.com/package/kilomega) [![GitHub](https://img.shields.io/github/license/edwinm/kilomega.svg)](https://github.com/edwinm/kilomega/blob/master/LICENSE) [![CodeFactor](https://www.codefactor.io/repository/github/edwinm/kilomega/badge)](https://www.codefactor.io/repository/github/edwinm/kilomega)

# kilomega

> Get the right unit prefix like kilo of mega for a certain bit or byte amount.

If you want to convert a number of bits or bytes to a readable notation,

like `18248932` to `"17.4 MB"`.

## Installation

```shell

$ npm install kilomega

```

## Usage

You can include kilomega in three different ways:

1) For browsers, when you use a bundler:

```js

import { kilomega } from 'kilomega';

```

2) For browsers, without the need to build or install kilomega:

```js

const { kilomega } = await import('https://cdn.jsdelivr.net/gh/edwinm/[email protected]/kilomega.js');

```

See [dynamic-import.js](example/dynamic-import.js) in the example directory.

3) Or, for use in Node.js:

```js

const { kilomega } = require('kilomega');

```

See [example.js](example/example.js) in the example directory.

Then call the kilomega function:

```js

const result = kilomega(489382653442);

// result is: {

// 		amount: 455.7731127757579,

// 		iecPrefix: "gibi",

// 		iecSymbol: "Gi",

// 		prefix: "giga",

// 		symbol: "G",

// 	}

```

(489382653442 bytes is 455.77 gigabytes)

A complete practical example with number formatting for the specified locale (en-US) and with a

specified number of digits (3):

```js

const { kilomega } = require("kilomega");

function displayAmount(bytes) {

	const bytesize = kilomega(bytes);

	const intl = new Intl.NumberFormat("en-US", { maximumSignificantDigits: 3 });

	return `${intl.format(bytesize.amount)} ${bytesize.symbol}B`;

}

const result = displayAmount(28946022);

//=> 27.6 MB

```

(28946022 bytes is 27.6 megabytes)

## API

### kilomega( amount )

Returns an with the converted amount and corresponding prefixes.

#### amount

Type: `number`

The number of bits or bytes.

#### output

Type: `{

	amount: number;

	iecPrefix: string;

	iecSymbol: string;

	prefix: string;

	symbol: string;

}`

The converted amount and the corresponding IS and IEC prefixes.

## Tests

```shell

npm test

```

## Related information

- [Wikipedia on binary prefix](https://en.wikipedia.org/wiki/Binary_prefix)

## License

MIT © 2023 [Edwin Martin](https://bitstorm.org/)