34094956b7
- Removed session creation and Lightning payment logic - Refactored security system: * no more restrictions * all systems enabled on session creation - Improved QR code exchange for mobile devices
54 lines
1.9 KiB
Markdown
54 lines
1.9 KiB
Markdown
cbor-js
|
|
=======
|
|
|
|
The Concise Binary Object Representation (CBOR) data format ([RFC 7049](http://tools.ietf.org/html/rfc7049)) implemented in pure JavaScript.
|
|
|
|
[](https://travis-ci.org/paroga/cbor-js)
|
|
[](https://coveralls.io/r/paroga/cbor-js?branch=master)
|
|
[](https://david-dm.org/paroga/cbor-js#info=dependencies&view=table)
|
|
[](https://david-dm.org/paroga/cbor-js#info=devDependencies&view=table)
|
|
[](https://saucelabs.com/u/paroga-cbor-js)
|
|
|
|
[](https://saucelabs.com/u/paroga-cbor-js)
|
|
|
|
API
|
|
---
|
|
|
|
The `CBOR`-object provides the following two functions:
|
|
|
|
CBOR.**decode**(*data*)
|
|
> Take the ArrayBuffer object *data* and return it decoded as a JavaScript object.
|
|
|
|
CBOR.**encode**(*data*)
|
|
> Take the JavaScript object *data* and return it encoded as a ArrayBuffer object.
|
|
|
|
Usage
|
|
-----
|
|
|
|
Include `cbor.js` in your or HTML page:
|
|
```html
|
|
<script src="path/to/cbor.js" type="text/javascript"></script>
|
|
```
|
|
|
|
Then you can use it via the `CBOR`-object in your code:
|
|
```javascript
|
|
var initial = { Hello: "World" };
|
|
var encoded = CBOR.encode(initial);
|
|
var decoded = CBOR.decode(encoded);
|
|
```
|
|
After running this example `initial` and `decoded` represent the same value.
|
|
|
|
### Combination with WebSocket
|
|
|
|
The API was designed to play well with the `WebSocket` object in the browser:
|
|
```javascript
|
|
var websocket = new WebSocket(url);
|
|
websocket.binaryType = "arraybuffer";
|
|
...
|
|
websocket.onmessage = function(event) {
|
|
var message = CBOR.decode(event.data);
|
|
};
|
|
...
|
|
websocket.send(CBOR.encode(message));
|
|
```
|