npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

bytes

v3.1.2

Published

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

Downloads

242,533,542

Readme

Bytes utility

NPM Version NPM Downloads Build Status Test Coverage

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

Installation

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

$ npm install bytes

Usage

var bytes = require('bytes');

bytes(number|string value, [options]): number|string|null

Default export function. Delegates to either bytes.format or bytes.parse based on the type of value.

Arguments

| Name | Type | Description | |---------|----------|--------------------| | value | numberstring | Number value to format or string value to parse | | options | Object | Conversion options for format |

Returns

| Name | Type | Description | |---------|------------------|-------------------------------------------------| | results | stringnumbernull | Return null upon error. Numeric value in bytes, or string value otherwise. |

Example

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

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

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

| Name | Type | Description | |---------|----------|--------------------| | value | number | Value in bytes | | options | Object | Conversion options |

Options

| Property | Type | Description | |-------------------|--------|-----------------------------------------------------------------------------------------| | decimalPlaces | numbernull | Maximum number of decimal places to include in output. Default value to 2. | | fixedDecimals | booleannull | Whether to always display the maximum number of decimal places. Default value to false | | thousandsSeparator | stringnull | Example of values: ' ', ',' and '.'... Default value to ''. | | unit | stringnull | The unit in which the result will be returned (B/KB/MB/GB/TB). Default value to '' (which means auto detect). | | unitSeparator | stringnull | Separator to use between number and unit. Default value to ''. |

Returns

| Name | Type | Description | |---------|------------------|-------------------------------------------------| | results | stringnull | Return null upon error. String value otherwise. |

Example

bytes.format(1024);
// output: '1KB'

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

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

bytes.format(1024 * 1.7, {decimalPlaces: 0});
// output: '2KB'

bytes.format(1024, {unitSeparator: ' '});
// output: '1 KB'

bytes.parse(string|number value): number|null

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

Supported units and abbreviations are as follows and are case-insensitive:

  • b for bytes
  • kb for kilobytes
  • mb for megabytes
  • gb for gigabytes
  • tb for terabytes
  • pb for petabytes

The units are in powers of two, not ten. This means 1kb = 1024b according to this parser.

Arguments

| Name | Type | Description | |---------------|--------|--------------------| | value | stringnumber | String to parse, or number in bytes. |

Returns

| Name | Type | Description | |---------|-------------|-------------------------| | results | numbernull | Return null upon error. Value in bytes otherwise. |

Example

bytes.parse('1KB');
// output: 1024

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

bytes.parse(1024);
// output: 1024

License

MIT