Giter VIP home page Giter VIP logo

lua-filesize's Introduction

lua-filesize, Lua library to generate a human readable string describing the file size

Build Status Coverage Status License

Inspired by filesize.js.

Installation

$ sudo luarocks install lua-filesize

Reference

This library installs a single module called filesize. It is represented with a function of the same name. Principally it takes an integer (filesize) and returns a human readable string describing the file size.

filesize() accepts an optional second argument options of type table, so you can customize the output.

  • base (number) Number base, default is 2

  • bits (boolean) Enables bit sizes, default is false

  • exponent (number) Specifies the SI suffix via exponent, e.g. 2 is MB for bytes, default is -1

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

  • round (number) Decimal place, default is 2

  • spacer (string) Character between the result and suffix, default is " "

  • suffixes (table) Dictionary of SI suffixes to replace for localization, defaults to english if no match is found

  • unix (boolean) Enables unix style human readable output, e.g. ls -lh, default is false

Examples

> filesize = require 'filesize'
> filesize(500)
"500 B"
> filesize(500, {bits = true})
"3.91 Kb"
> filesize(265318)
"259.1 KB"
> filesize(265318, {base = 10})
"265.32 kB"
> filesize(265318, {round = 0})
"259 KB"
> filesize(265318, {output = "array"})
{ 259.1, "KB" }
> filesize(265318, {output = "object"})
{
  value = 259.1,
  suffix = "KB",
}
> filesize(1, {suffixes = {B = "Б"}})
"1 Б"
> filesize(1024)
"1 KB"
> filesize(1024, {exponent = 0})
"1024 B"
> filesize(1024, {output = "exponent"})
1

lua-filesize's People

Contributors

starius avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

whitehusky

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.