File size: 1,661 Bytes
4888678 |
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 |
# BSER Binary Serialization
BSER is a binary serialization scheme that can be used as an alternative to JSON.
BSER uses a framed encoding that makes it simpler to use to stream a sequence of
encoded values.
It is intended to be used for local-IPC only and strings are represented as binary
with no specific encoding; this matches the convention employed by most operating
system filename storage.
For more details about the serialization scheme see
[Watchman's docs](https://facebook.github.io/watchman/docs/bser.html).
## API
```js
var bser = require('bser');
```
### bser.loadFromBuffer
The is the synchronous decoder; given an input string or buffer,
decodes a single value and returns it. Throws an error if the
input is invalid.
```js
var obj = bser.loadFromBuffer(buf);
```
### bser.dumpToBuffer
Synchronously encodes a value as BSER.
```js
var encoded = bser.dumpToBuffer(['hello']);
console.log(bser.loadFromBuffer(encoded)); // ['hello']
```
### BunserBuf
The asynchronous decoder API is implemented in the BunserBuf object.
You may incrementally append data to this object and it will emit the
decoded values via its `value` event.
```js
var bunser = new bser.BunserBuf();
bunser.on('value', function(obj) {
console.log(obj);
});
```
Then in your socket `data` event:
```js
bunser.append(buf);
```
## Example
Read BSER from socket:
```js
var bunser = new bser.BunserBuf();
bunser.on('value', function(obj) {
console.log('data from socket', obj);
});
var socket = net.connect('/socket');
socket.on('data', function(buf) {
bunser.append(buf);
});
```
Write BSER to socket:
```js
socket.write(bser.dumpToBuffer(obj));
```
|