Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caomeiyouren/better-bytes
Better byte base conversion. Supports two base conversions: kilo binary byte (2^10) and kilobyte (10^3)。更好的字节进制换算。支持 千位二进制字节(2^10) 和 千字节(10^3) 两种进制换算
https://github.com/caomeiyouren/better-bytes
byte bytes kilo-binary-byte kilobyte parse parser utility
Last synced: 3 months ago
JSON representation
Better byte base conversion. Supports two base conversions: kilo binary byte (2^10) and kilobyte (10^3)。更好的字节进制换算。支持 千位二进制字节(2^10) 和 千字节(10^3) 两种进制换算
- Host: GitHub
- URL: https://github.com/caomeiyouren/better-bytes
- Owner: CaoMeiYouRen
- License: mit
- Created: 2024-04-27T09:52:23.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-10-31T21:04:20.000Z (3 months ago)
- Last Synced: 2024-11-01T09:06:15.280Z (3 months ago)
- Topics: byte, bytes, kilo-binary-byte, kilobyte, parse, parser, utility
- Language: TypeScript
- Homepage:
- Size: 1.22 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
better-bytes
> Better byte base conversion. Supports two base conversions: kilo binary byte (2^10) and kilobyte (10^3).
>
> Reference link: [Prefixes for binary multiples](https://physics.nist.gov/cuu/Units/binary.html) ; [Binary prefix](https://en.wikipedia.org/wiki/Binary_prefix#IEC_prefixes)
>
> 更好的字节进制换算。支持 千位二进制字节(2^10) 和 千字节(10^3) 两种进制换算
>
> 参考链接：[Prefixes for binary multiples](https://physics.nist.gov/cuu/Units/binary.html) ; [Binary prefix](https://en.wikipedia.org/wiki/Binary_prefix#IEC_prefixes)
## 🏠 Home/主页
[https://github.com/CaoMeiYouRen/better-bytes#readme](https://github.com/CaoMeiYouRen/better-bytes#readme)
## 📦 Dependency Requirements/依赖要求
- node >=16
## 🚀 Installation/安装
```sh
npm install better-bytes
```
## 👨💻 Usage/使用
```ts
import { format, parse } from 'better-bytes'
format(1024) // '1.00 KiB'
format(1073741824) // '1.00 GiB'
format(1125899906842624n) // '1.00 PiB'
format(1572864, { standard: 'kilobinary' }) // '1.50 MiB'
format(1500000, { standard: 'kilo' }) // '1.50 MB'
format(1234, { decimal: 3, standard: 'kilobinary' }) // '1.205 KiB'
format(1234, { decimal: 3, standard: 'kilo' }) // '1.234 KB
format(1.1) // Error: 'Data must be integer'
format(-1) // Error: 'Data must be greater than or equal to 0'
format('invalid') // Error: 'Data must be a number or bigint'
format(NaN) // Error: 'Data must be finite'
parse('1KiB') // 1024
parse('1GiB') // 1073741824
parse('1KB') // 1000
parse('1GB') // 1000000000
parse('1KB', { forceKilobinary: true }) // 1024
parse('1GB', { forceKilobinary: true }) // 1073741824
parse('1.5KiB') // 1536
parse('1.5KB') // 1500
parse('1024') // 1024
parse('1000.5') // 1000
parse('1.123456789012345GiB') // 1206302541
parse('1.123456789012345GB') // 1123456789
parse('9007199254740991YiB') // 10633823966279325802638835764831453184n
parse('9007199254740991YB') // 9007199254740991000000000000000000000n
parse('+1KiB') // 1024
parse('-1KiB') // null
parse('1XB') // null
parse('invalid') // null
parse('Infinity') // null
parse(123) // Error: Data must be a string
```
### format(data: number | bigint, options: Options = {}): string
Format the given value in bytes into a string.
将给定的字节值格式化为字符串。
**Arguments**
| Name | Type | Description |
| ------- | ------------------ | ----------------------------------------------- |
| data | `number`｜`bigint` | Number value to format. 要格式化的数值 |
| options | `object` | Conversion options for `format`. 格式化的选项。 |
**Options**
| Property | Type | Description |
| ------------- | --------------------- | ------------------------------------------------------------ |
| decimal | `number`｜`undefined` | Maximum number of decimal places to include in output. Default: `2`. 输出中包含的最大小数位数。默认值：`2`。 |
| standard | `kilobinary`｜`kilo` | base. kilobinary = 2^10 ; kilo = 10^3. Default: `kilobinary`. 进制规范。千位二进制=2^10；千位=10^3。默认值：`kilobinary` |
| unitSeparator | `string`｜`undefined` | Separator to use between number and unit. Default: `' '`. 用于数字和单位之间的分隔符。默认值：`' '` |
**Returns**
| Name | Type | Description |
| ------- | -------- | ------------------------------------------------------------ |
| results | `string` | Return string. For non number or bigint, as well as cases less than 0, exceptions are thrown. 返回 string。对于非 number 或 bigint，以及小于 0 的情况，均抛出异常。 |
### parse(data: string): number | bigint | null
Parse the string value into an integer in bytes. If no unit is given, it is assumed the value is in bytes.
将字符串值解析为以字节为单位的整数。如果没有给出单位，则假定该值以字节为单位。
**Arguments**
| Name | Type | Description |
| ------- | -------- | --------------------------------------- |
| data | `string` | String value to parse. 要解析的字符串。 |
| options | `object` | Parsed options. 解析的选项。 |
**Options**
| Property | Type | Description |
| --------------- | ---------------------- | ------------------------------------------------------------ |
| forceKilobinary | `boolean`｜`undefined` | If true, consider kilo as kilobinary, i.e. using 2^10 base. 如果为真，则将千位进制视为千位二进制，即使用 2^10 进制换算。 |
**Returns**
| Name | Type | Description |
| ------- | ------------------------ | ------------------------------------------------------------ |
| results | `number`｜`bigint`｜`null` | Returns null on error. Otherwise, return the value of number or bigint in bytes. 出错时返回 null。否则以字节为单位返回 number 或 bigint 的数值。 |
## 🛠️ Development/开发
```sh
npm run dev
```
## 🔧 Build/编译
```sh
npm run build
```
## 🧪 Test/测试
```sh
npm run test
```
## 🔍 Lint
```sh
npm run lint
```
## 💾 Commit
```sh
npm run commit
```
## 👤 Author/作者
**CaoMeiYouRen**
* Website: [https://blog.cmyr.ltd/](https://blog.cmyr.ltd/)
* GitHub: [@CaoMeiYouRen](https://github.com/CaoMeiYouRen)
## 🤝 Contribution/贡献
Welcome to contribute, ask questions or propose new features!
If you have any questions, please check the [issues page](https://github.com/CaoMeiYouRen/better-bytes/issues).
For contributions or new feature proposals, please refer to the [contributing guide](https://github.com/CaoMeiYouRen/better-bytes/blob/master/CONTRIBUTING.md).
欢迎 贡献、提问或提出新功能！
如有问题请查看 [issues page](https://github.com/CaoMeiYouRen/better-bytes/issues).
贡献或提出新功能可以查看[contributing guide](https://github.com/CaoMeiYouRen/better-bytes/blob/master/CONTRIBUTING.md).
## 💰 Support/支持
If you find this project useful, please give it a ⭐️. Thank you very much.
如果觉得这个项目有用的话请给一颗⭐️，非常感谢
## 📝 License
Copyright © 2024 [CaoMeiYouRen](https://github.com/CaoMeiYouRen).
This project is [MIT](https://github.com/CaoMeiYouRen/better-bytes/blob/master/LICENSE) licensed.
## 🖥️ Reference project/参考项目
- [bytes.js](https://github.com/visionmedia/bytes.js)
- [filesize.js](https://github.com/avoidwork/filesize.js)
***
_This README was generated with ❤️ by [cmyr-template-cli](https://github.com/CaoMeiYouRen/cmyr-template-cli)_