Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

filesize

Package Overview
Dependencies
0
Maintainers
1
Versions
110
Issues
File Explorer

Advanced tools

filesize

JavaScript library to generate a human readable String describing the file size

    10.0.5latest

Version published
Maintainers
1
Weekly downloads
9,947,051
decreased by-9.36%

Weekly downloads

Changelog

Source

10.0.5

Readme

Source

filesize.js

downloads CDNJS version

filesize.js provides a simple way to get a human readable file size string from a number (float or integer) or string.

import {filesize} from "filesize"; filesize(265318, {base: 2, standard: "jedec"}); // "259.1 KB"

Optional settings

filesize() accepts an optional descriptor Object as a second argument, so you can customize the output.

base

(number) Number base, default is 10

bits

(boolean) Enables bit sizes, default is false

exponent

(number) Specifies the symbol via exponent, e.g. 2 is MB for base 2, default is -1

fullform

(boolean) Enables full form of unit of measure, default is false

fullforms

(array) Array of full form overrides, default is []

locale (overrides 'separator')

(string || boolean) BCP 47 language tag to specify a locale, or true to use default locale, default is ""

localeOptions (overrides 'separator', requires string for 'locale' option)

(object) Dictionary of options defined by ECMA-402 (Number.prototype.toLocaleString). Requires locale option to be explicitly passed as a string, otherwise is ignored.

output

(string) Output of function (array, exponent, object, or string), default is string

pad

(boolean) Decimal place end padding, default is false

precision

(number) Sets precision of numerical output, default is 0

round

(number) Decimal place, default is 2

roundingMethod

(string) Rounding method, can be round, floor, or ceil, default is round

separator

(string) Decimal separator character, default is .

spacer

(string) Character between the result and symbol, default is " "

standard

(string) Standard unit of measure, can be iec or jedec, default is iec; can be overruled by base

symbols

(object) Dictionary of IEC/JEDEC symbols to replace for localization, defaults to english if no match is found

Partial Application

partial() takes the second parameter of filesize() and returns a new function with the configuration applied upon execution. This can be used to reduce Object creation if you call filesize() without caching the descriptor in lexical scope.

import {partial} from "filesize"; const size = partial({base: 2, standard: "jedec"}); size(265318); // "259.1 KB"

License

Copyright (c) 2022 Jason Mulligan Licensed under the BSD-3 license.

Keywords

FAQs

What is filesize?

JavaScript library to generate a human readable String describing the file size

Is filesize popular?

The npm package filesize receives a total of 9,405,118 weekly downloads. As such, filesize popularity was classified as popular.

Is filesize well maintained?

We found that filesize demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 29 Sep 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc