JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

lei-proto

简单的Buffer编码/解析模块

安装

npm install lei-proto

使用

const parseProto = require('lei-proto');

const p = parseProto([
  ['a', 'uint', 1],
  ['b', 'int', 1],
  ['c', 'float'],
  ['d', 'double'],
  ['e', 'string', 1],
  ['f', 'buffer', 1]
]);

const b = p.encode(1, 2, 3.3, 4.4, 'a', new Buffer('b'));
// 或者
// const b = p.encodeEx({a: 1, b: 2, c: 3.3, d: 4.4, e: 'a', f: new Buffer('b')});
const c = p.decode(b);
console.log(b);
// => <Buffer 01 02 40 53 33 33 40 11 99 99 99 99 99 9a 61 62>
console.log(c);
// => { a: 1, b: 2, c: 3.299999952316284, d: 4.4, e: 'a', f: <Buffer 62> }

规则:['名称', '数据类型', 长度, '字节顺序BE/LE']

支持的数据类型:

  • uint 需要指定长度,字节顺序默认BE
  • int 需要指定长度,字节顺序默认BE
  • float 长度为4
  • double 长度为4
  • string 需要指定长度,当其为最后一项时可省略长度(表示不定长)
  • buffer 需要指定长度,当其为最后一项时可省略长度(表示不定长)

具体使用方法参考单元测试。

性能提示

  • Buffer.from(str) 接口比较慢,所以最后一项尽量不要使用不定长的 stringbuffer
  • 如果可能,尽量使用 buffer 而不使用 string 类型
  • 尽量缓存 Buffer 对象,避免多次创建

The MIT License

The MIT License (MIT)

Copyright (c) 2015-2018 Zongmin Lei <leizongmin@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.