Blame view

node_modules/bytes/Readme.md 3.8 KB
6a9ffbcc   liuqimichale   地图点击事件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
  # Bytes utility
  
  [![NPM Version][npm-image]][npm-url]
  [![NPM Downloads][downloads-image]][downloads-url]
  [![Build Status][travis-image]][travis-url]
  [![Test Coverage][coveralls-image]][coveralls-url]
  
  Utility to parse a string bytes (ex: `1TB`) to bytes (`1099511627776`) and vice-versa.
  
  ## Installation
  
  This is a [Node.js](https://nodejs.org/en/) module available through the
  [npm registry](https://www.npmjs.com/). Installation is done using the
  [`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
  
  ```bash
  $ npm install bytes
  ```
  
  ## Usage
  
  ```js
  var bytes = require('bytes');
  ```
  
  #### 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**
  
  ```js
  bytes(1024);
  // output: '1KB'
  
  bytes(1000);
  // output: '1000B'
  
  bytes(1000, {thousandsSeparator: ' '});
  // output: '1 000B'
  
  bytes(1024 * 1.7, {decimalPlaces: 0});
  // output: '2KB'
  
  bytes(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
  
  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**
  
  ```js
  bytes('1KB');
  // output: 1024
  
  bytes('1024');
  // output: 1024
  
  bytes(1024);
  // output: 1024
  ```
  
  ## License 
  
  [MIT](LICENSE)
  
  [downloads-image]: https://img.shields.io/npm/dm/bytes.svg
  [downloads-url]: https://npmjs.org/package/bytes
  [npm-image]: https://img.shields.io/npm/v/bytes.svg
  [npm-url]: https://npmjs.org/package/bytes
  [travis-image]: https://img.shields.io/travis/visionmedia/bytes.js/master.svg
  [travis-url]: https://travis-ci.org/visionmedia/bytes.js
  [coveralls-image]: https://img.shields.io/coveralls/visionmedia/bytes.js/master.svg
  [coveralls-url]: https://coveralls.io/r/visionmedia/bytes.js?branch=master