buffer-factory
Version:
Make it no pain to create a Buffer object by encapsulate Buffer.from an new Buffer().
44 lines (29 loc) • 2.68 kB
Markdown
[](https://travis-ci.org/imnemo/buffer-factory)
[](https://coveralls.io/github/imnemo/buffer-factory?branch=master)
<a href="https://www.npmjs.com/package/buffer-factory" alt="NPM total downloads"><img src="https://img.shields.io/npm/dt/buffer-factory.svg"></a>
<a href="https://www.npmjs.com/package/buffer-factory" alt="NPM latest version"><img src="https://img.shields.io/npm/v/buffer-factory.svg"></a>
<a href="https://npms.io/search?q=buffer-factory" alt="NPM latest version"><img src="https://badges.npms.io/buffer-factory.svg"></a>
<a href="https://npm.runkit.com/buffer-factory"><img src="https://badge.runkitcdn.com/buffer-factory.svg" alt="Try buffer-factory on RunKit"/></a>
[](https://deepscan.io/dashboard#view=project&tid=273&pid=1293&bid=3476)
<a href="https://github.com/imnemo/buffer-factory" alt="Github stars"><img src="https://img.shields.io/github/stars/imnemo/buffer-factory.svg?style=social&label=Star"></a>
<a href="https://github.com/imnemo/buffer-factory" alt="Github forks"><img src="https://img.shields.io/github/forks/imnemo/buffer-factory.svg?style=social&label=Fork"></a>
<a href="https://github.com/imnemo/buffer-factory" alt="Github contributors"><img src="https://img.shields.io/github/contributors/imnemo/buffer-factory.svg"></a>
# Buffer Factory - ([README in English](./README.md))
`node-factory`封装了`new Buffer(args...)`和Buffer.from(args...)，使得创建一个Buffer对象时，不必考虑Node版本问题，避免出错，也可使代码更好的向下兼容。
本模块有较充分的单元测试和完善的使用文档。
# 使用
## 安装
`npm i buffer-factory`
## 调用
```javascript
const bufferFactory = require('buffer-factory')
bufferFactory.create('2b', 'hex');
// 已废弃
bufferFactory('2b', 'hex');
```
## 实现原理
`Buffer.from` is preffered to be used when it's accessible.
`Buffer.from` is added from v5.10.0, as the api document shows. But some node version, v4.2.6 for example, `Buffer.from` is a function, however, there is an error when you call `Buffer.from(string, encoding)`(error like `hex is not function`). So I also take the node version into account.
For low versions of Node.js, this module use `new Buffer(...)`.
You're free to pass in the same params as `Buffer.from(...)` and `new Buffer(...)`, I will handle the rest for you.
You're also free to check `index.js` for the implementation code :).