json-bufferify

This is a tiny module to help you convert between JSON data and ArrayBuffer, and you can use it in both Node.js and browsers.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
json-bufferify
2600.2.23 years ago6 years agoMinified + gzip package size for json-bufferify in KB

Popular Searches

Readme

This is a tiny module to help you convert between JSON data and ArrayBuffer, and you can use it in both Node.js and browsers.

Features

  • Convert JSON data to ArrayBuffer.
  • Revert JSON data from ArrayBuffer.

Installation

``` npm install json-bufferify ```

Usage

Step 0 - Import json-bufferify.

In Node.js ```javascript // CommonJS const bufferify = require('json-bufferify'); // ES6 Modules import bufferify from 'json-bufferify'; ``` In browsers ```html ``` In TypeScript ```typescript // Traditional style import bufferify = require('json-bufferify'); // ES6 Modules import bufferify from 'json-bufferify'; ``` In Egret Open "egretProperties.json" and Add the following code to "modules" node. ```json { 
"name": "json-bufferify",
"path": "D:/Work/modules/json-bufferify"
} ```

Step 1 - Convert JSON data to ArrayBuffer and send via WebSocket.

```javascript let ws = new WebSocket(url); ws.binaryType = 'arraybuffer'; ws.send(bufferify.encode(0, { 
sex: 0,
name: 'Bob',
age: 25
})); ```

Step 2 - Revert JSON data from ArrayBuffer.

```javascript ws.on('message', data => { 
console.log(bufferify.decode(0, {
name: 'string',
sex: 'number',
age: 'number'
}, data));
}); ```

APIs

bufferify.encode(offset, data)

Convert JSON data to ArrayBuffer and return the DataView.
  • offset - The start point of the DataView where to store the data.
  • data - The JSON data.

bufferify.decode(offset, template, source)

Revert JSON data from ArrayBuffer and return it.
  • offset - The start point of the DataView where to read the data.
  • template - The template of the JSON data.
  • source - The ArrayBuffer, or the Buffer in Node.js, or the DataView of the ArrayBuffer.

Examples

Convert/Revert an array.

```javascript let ws = new WebSocket(url); ws.binaryType = 'arraybuffer'; ws.send(bufferify.encode(0, 1, 2, 3, 4, 5, 6, 7, 8, 9)); ``` ```javascript ws.on('message', data => { 
console.log(bufferify.decode(0, ['number'], data));
}); ```

Convert/Revert a complex Object.

```javascript let ws = new WebSocket(url); ws.binaryType = 'arraybuffer'; ws.send(bufferify.encode(0, { 
obj: {
opcode: 8,
info: 'Hello'
},
arr: [1, 2, 3, 4, 5],
list: [{
name: 'Jerry',
id: '536598'
},
{
name: 'Tom',
id: '85947'
},
{
id: '459823',
name: 'Kevin'
}]
})); ``` ```javascript ws.on('message', data => { 
console.log(bufferify.decode(0, {
arr: ['number'],
obj: {
opcode: 'number',
info: 'string'
},
list: [{
id: 'string',
name: 'string'
}]
}, data));
}); ```

Compatibility

  • The latest LTS version of Node.js.
  • Modern browsers such as Chrome, Firefox, Edge(Chromium-based), Safari.

License NPM

This is licensed under the GNU LGPL, version 3 or later.