Installations

npm install bytes

Pull Requests

Open

3

Total

38

Closed

25

Merged

10

Issues

Open

3

Total

26

Closed

23

Releases

Unable to fetch releases

Developer

visionmedia

Developer Guide

BETA

Module System

Unable to determine the module system for this package.

Min. Node Version

>= 0.8

Typescript Support

No

Node Version

16.13.1

NPM Version

8.1.2 Statistics

462 Stars

169 Commits

57 Forks

9 Watching

2 Branches

23 Contributors

Updated on 26 Nov 2024

Bundle Size

1.15 kB

Minified

667.00 B

Minified + Gzipped

Bundlephobia

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

11,617,552,796

Last day

-8%

9,515,204

Compared to previous day

Last week

1.1%

55,800,241

Compared to previous week

Last month

0.5%

237,791,466

Compared to previous month

Last year

1%

2,735,238,747

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

4

eslint eslint-plugin-markdown mocha nyc

Versions

Bytes utility

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:

1$ npm install bytes

Usage

1var 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	`number`｜`string`	Number value to format or string value to parse
options	`Object`	Conversion options for `format`

Returns

Name	Type	Description
results	`string`｜`number`｜`null`	Return null upon error. Numeric value in bytes, or string value otherwise.

Example

1bytes(1024);
2// output: '1KB'
3
4bytes('1KB');
5// 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	`number`｜`null`	Maximum number of decimal places to include in output. Default value to `2`.
fixedDecimals	`boolean`｜`null`	Whether to always display the maximum number of decimal places. Default value to `false`
thousandsSeparator	`string`｜`null`	Example of values: `' '`, `','` and `'.'`... Default value to `''`.
unit	`string`｜`null`	The unit in which the result will be returned (B/KB/MB/GB/TB). Default value to `''` (which means auto detect).
unitSeparator	`string`｜`null`	Separator to use between number and unit. Default value to `''`.

Returns

Name	Type	Description
results	`string`｜`null`	Return null upon error. String value otherwise.

Example

1bytes.format(1024);
2// output: '1KB'
3
4bytes.format(1000);
5// output: '1000B'
6
7bytes.format(1000, {thousandsSeparator: ' '});
8// output: '1 000B'
9
10bytes.format(1024 * 1.7, {decimalPlaces: 0});
11// output: '2KB'
12
13bytes.format(1024, {unitSeparator: ' '});
14// 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	`string`｜`number`	String to parse, or number in bytes.

Returns

Name	Type	Description
results	`number`｜`null`	Return null upon error. Value in bytes otherwise.

Example

1bytes.parse('1KB');
2// output: 1024
3
4bytes.parse('1024');
5// output: 1024
6
7bytes.parse(1024);
8// output: 1024

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.4

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More