www.aleph1.co.uk Git - yaffs-website/blob - node_modules/maxmin/readme.md

   1 # maxmin [![Build Status](https://travis-ci.org/sindresorhus/maxmin.svg?branch=master)](https://travis-ci.org/sindresorhus/maxmin)
   2
   3 > Get a pretty output of the original, minified, gzipped size of a string or buffer
   4
   5 ![](screenshot.png)
   6
   7 Useful for logging the difference between original and minified file in e.g. a build-system.
   8
   9
  10 ## Install
  11
  12 ```
  13 $ npm install --save maxmin
  14 ```
  15
  16
  17 ## Usage
  18
  19 ```js
  20 const maxmin = require('maxmin');
  21
  22 const max = 'function smoothRangeRandom(min,max){var num=Math.floor(Math.random()*(max-min+1)+min);return this.prev=num===this.prev?++num:num};';
  23
  24 const min = '(function(b,c){var a=Math.floor(Math.random()*(c-b+1)+b);return this.a=a===this.a?++a:a})()';
  25
  26 console.log(maxmin(max, min, true));
  27 //=> '130 B → 91 B → 53 B (gzip)'
  28 ```
  29
  30 ## API
  31
  32 ### maxmin(max, min, [useGzip])
  33
  34 #### max
  35
  36 Type: `string`, `buffer`, `number`
  37
  38 Original string or its size in bytes.
  39
  40 #### min
  41
  42 Type: `string`, `buffer`, `number`
  43
  44 Minified string or its size in bytes.
  45
  46 #### useGzip
  47
  48 Type: `boolean`
  49 Default: `false`
  50
  51 Show gzipped size of `min`. Pretty slow. Not shown when `min` is a `number`.
  52
  53
  54 ## License
  55
  56 MIT © [Sindre Sorhus](http://sindresorhus.com)