Code Monkey home page Code Monkey logo

digital-unit-converter's Introduction

digital-unit-converter

Utility to simplify conversion of digital units of measurement

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.

DataUnit Term Abbreviation Unit Type Number of Bytes
BIT bit b - 0.125
BYTE byte B - 1
KILOBYTE kilobyte kB Decimal 103
KIBIBYTE kibibyte KiB Binary 210
MEGABYTE megabyte MB Decimal 106
MEBIBYTE mebibyte MiB Binary 220
GIGABYTE gigabyte GB Decimal 109
GIBIBYTE gibibyte GiB Binary 230

Static Members

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

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

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

Parameters:

Name Type Description
val number value to convert
unit DataUnit data unit of val

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:

Name Type Description
val number value to convert to bits

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:

Name Type Description
val number value to convert to bytes

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:

Name Type Description
val number value to convert to gibibytes

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:

Name Type Description
val number value to convert to gigabytes

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:

Name Type Description
val number value to convert to kibibytes

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:

Name Type Description
val number value to convert to kilobytes

Returns: number

converted kilobyte value

Defined in: index.ts:198


toMebibytes

toMebibytes(val: number): number

Convert a value in this unit mebibytes (MiB)

Parameters:

Name Type Description
val number value to convert to mebibytes

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:

Name Type Description
val number value to convert to megabytes

Returns: number

converted megabyte value

Defined in: index.ts:218

digital-unit-converter's People

Contributors

zduclos avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.