digital-unit-converter v1.0.1

digital-unit-converter

Utility to simplify conversion of digital units of measurement

• Digital Unit Converter
  • Installation
  • Importing
  • Examples
  • Supported Data Units
  • Static Members
  • Methods

Installation

Using npm

$ npm install digital-unit-converter --save

Using yarn

$ yarn add digital-unit-converter

Import module

CommonJS

const { DataUnit } = require('digital-unit-converter');

ES6

import { DataUnit } from 'digital-unit-converter';

Examples

JavaScript: convert 10 megabytes (MB) to bytes (B)

let converted = DataUnit.MEGABYTE.toBytes(10);
console.log(converted); // 10000000

// or use convert() instead
converted = DataUnit.BYTE.convert(10, DataUnit.MEGABYTE);
console.log(converted); // 10000000

TypeScript: convert 1 gibibyte (GiB) to mebibytes (MiB)

let converted: number = DataUnit.GIBIBYTE.toMebibytes(1);
console.log(converted); // 1024

// or use convert() instead
converted = DataUnit.MEBIBYTE.convert(1, DataUnit.GIBIBYTE);
console.log(converted); // 1024

Supported Data Units

The following data units are currently supported.

Static Members

• BIT
• BYTE
• GIBIBYTE
• GIGABYTE
• KIBIBYTE
• KILOBYTE
• MEBIBYTE
• MEGABYTE

BIT

▪ Static Readonly BIT: DataUnit

Bit (b). Data unit representing a binary digit

Defined in: index.ts:10

BYTE

▪ Static Readonly BYTE: DataUnit

Byte (B). Data unit representing 8 bits

Defined in: index.ts:25

GIBIBYTE

▪ Static Readonly GIBIBYTE: DataUnit

Gibibyte (GiB). Binary data unit representing 1,0243 bytes

Defined in: index.ts:115

GIGABYTE

▪ Static Readonly GIGABYTE: DataUnit

Gigabyte (GB). Decimal data unit representing 1,0003 bytes

Defined in: index.ts:100

KIBIBYTE

▪ Static Readonly KIBIBYTE: DataUnit

Kibibyte (KiB). Binary data unit representing 1,024 bytes

Defined in: index.ts:55

KILOBYTE

▪ Static Readonly KILOBYTE: DataUnit

Kilobyte (kB). Decimal data unit representing 1,000 bytes

Defined in: index.ts:40

MEBIBYTE

▪ Static Readonly MEBIBYTE: DataUnit

Mebibyte (MiB). Binary data unit representing 1,0242 bytes

Defined in: index.ts:85

MEGABYTE

▪ Static Readonly MEGABYTE: DataUnit

Megabyte (MB). Decimal data unit representing 1,0002 bytes

Defined in: index.ts:70

Methods

• convert
• toBits
• toBytes
• toGibibytes
• toGigabytes
• toKibibytes
• toKilobytes
• toMebibytes
• toMegabytes

convert

▸ convert(val: number, unit: DataUnit): number

Converts the value (val) in the specified data unit (unit) to this unit

Parameters:

Returns: number

converted value in this unit

Defined in: index.ts:259

toBits

▸ toBits(val: number): number

Convert a value in this unit to bits (b)

Parameters:

Returns: number

converted bit value

Defined in: index.ts:178

toBytes

▸ toBytes(val: number): number

Convert a value in this unit to bytes (B)

Parameters:

Returns: number

converted byte value

Defined in: index.ts:188

toGibibytes

▸ toGibibytes(val: number): number

Convert a value in this unit to gibibytes (GiB)

Parameters:

Returns: number

converted gibibyte value

Defined in: index.ts:248

toGigabytes

▸ toGigabytes(val: number): number

Convert a value in this unit to gigabytes (GB)

Parameters:

Returns: number

converted gigabyte value

Defined in: index.ts:238

toKibibytes

▸ toKibibytes(val: number): number

Convert a value in this unit to kibibytes (KiB)

Parameters:

Returns: number

converted kibibyte value

Defined in: index.ts:208

toKilobytes

▸ toKilobytes(val: number): number

Convert a value in this unit to kilobytes (kB)

Parameters:

Returns: number

converted kilobyte value

Defined in: index.ts:198

toMebibytes

▸ toMebibytes(val: number): number

Convert a value in this unit mebibytes (MiB)

Parameters:

Returns: number

converted mebibyte value

Defined in: index.ts:228

toMegabytes

▸ toMegabytes(val: number): number

Convert a value in this unit to megabytes (MB)

Parameters:

Returns: number

converted megabyte value

Defined in: index.ts:218