Socket
Socket
Sign inDemoInstall

bytes

Package Overview
Dependencies
0
Maintainers
2
Versions
18
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    bytes

Utility to parse a string bytes to bytes and vice-versa


Version published
Maintainers
2
Install size
9.41 kB
Created

Package description

What is bytes?

The 'bytes' npm package is a utility for parsing and formatting byte sizes. It allows users to easily convert between different units of bytes and parse strings with byte size information into numbers. It is useful for displaying file sizes in a human-readable format or for parsing user input into byte quantities.

What are bytes's main functionalities?

Parse byte size strings

This feature allows you to parse a string representing a byte size into an integer number of bytes. For example, passing '1000KB' will return 1000000.

"1000KB" // returns 1000000

Format bytes into strings

This feature allows you to format an integer number of bytes into a string with a unit. For example, passing 1024 will return '1KB'.

1024 // returns '1KB'

Specify the number of decimal places

This feature allows you to specify the number of decimal places when formatting bytes into a string. For example, passing an object with 1000 bytes and 1 decimal place will return '1.0KB'.

{ bytes: 1000, decimalPlaces: 1 } // returns '1.0KB'

Specify the unit of bytes

This feature allows you to specify the unit when formatting bytes. For example, passing an object with 1024 bytes and 'kB' as the unit will return '1kB'.

{ bytes: 1024, unit: 'kB' } // returns '1kB'

Other packages similar to bytes

Readme

Source

Bytes utility

NPM Version NPM Downloads Build Status

Utility to parse a string bytes (ex: 1TB) to bytes (1099511627776) and vice-versa.

Usage

var bytes = require('bytes');
bytes.format(number value, [options]): string|null

Format the given value in bytes into a string. If the value is negative, it is kept as such. If it is a float, it is rounded.

Arguments

NameTypeDescription
valuenumberValue in bytes
optionsObjectConversion options

Options

PropertyTypeDescription
decimalPlacesnumber|nullMaximum number of decimal places to include in output. Default value to 2.
fixedDecimalsboolean|nullWhether to always display the maximum number of decimal places. Default value to false
thousandsSeparatorstring|nullExample of values: ' ', ',' and .... Default value to ' '.

Returns

NameTypeDescription
resultsstring|nullReturn null upon error. String value otherwise.

Example

bytes(1024);
// output: '1kB'

bytes(1000);
// output: '1000B'

bytes(1000, {thousandsSeparator: ' '});
// output: '1 000B'

bytes(1024 * 1.7, {decimalPlaces: 0});
// output: '2kB'
bytes.parse(string value): number|null

Parse the string value into an integer in bytes. If no unit is given, it is assumed the value is in bytes.

Arguments

NameTypeDescription
valuestringString to parse.

Returns

NameTypeDescription
resultsnumber|nullReturn null upon error. Value in bytes otherwise.

Example

bytes('1kB');
// output: 1024

bytes('1024');
// output: 1024

Installation

npm install bytes --save
component install visionmedia/bytes.js

License

npm

Keywords

FAQs

Last updated on 14 Nov 2015

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc