tedeh/jayson

Jayson is a [JSON-RPC 2.0][jsonrpc-spec] and [1.0][jsonrpc1-spec] compliant server and client written in JavaScript for [node.js][node.js] that aims to be as simple as possible to use.
[jsonrpc-spec]: http://jsonrpc.org/spec.html
[jsonrpc1-spec]: http://json-rpc.org/wiki/specification
[node.js]: http://nodejs.org/
[jayson-npm]: https://www.npmjs.com/package/jayson
[badge-npm]: https://img.shields.io/npm/v/jayson.svg
[badge-downloads-month]: https://img.shields.io/npm/dm/jayson.svg
[![npm version][badge-npm]][jayson-npm]
[![npm][badge-downloads-month]][jayson-npm]
## Table of contents
Features
Example
Installation
Changelog
Requirements
Class Documentation
Running tests
Typescript
Usage
Client
Interface description
Browser usage
Notifications
Batches
Callback syntactic sugar
Events
Server
Interface description
Many interfaces at the same time
Using the server as a relay
Method routing
Method definition
Events
Errors
CORS
Context
Revivers and replacers
Named parameters
Promises
Batches
Browser client
FAQ
Recommended usage
Contributing
## Features
Servers that can listen to several interfaces at the same time
Supports both HTTP and TCP client and server connections
Server-side method routing
Relaying of requests to other servers
JSON reviving and replacing for transparent serialization of complex objects
CLI client
Promises
Fully tested to comply with the [official JSON-RPC 2.0 specification][jsonrpc-spec]
Also supports [JSON-RPC 1.0][jsonrpc1-spec]
## Example
A basic JSON-RPC 2.0 server via HTTP:
Server example in examples/simpleexample/server.js:
javascript
const jayson = require('jayson');
// create a server
const server = new jayson.server({
add: function (args, callback) {
callback(null, args[0] + args[1]);
},
});
server.http().listen(3000);
Client example in examples/simpleexample/client.js invoking add on the above server:
javascript
const jayson = require('jayson');
// create a client
const client = new jayson.client.http({
port: 3000,
});
// invoke "add"
client.request('add', [1, 1], function (err, response) {
if (err) {
throw err;
console.log(response.result); // 2
});
## Installation
Install the latest version of jayson from npm by executing npm install jayson in your shell. Do a global install with npm install --global jayson if you want the jayson client CLI in your PATH.
## Changelog (only notable milestones/changes)
5.0.0
Removed uuid package dependency. Now native (node or browser) crypto implementation is used to generate uuids. If your browser doesn't have it: provide your own generator as described below.
Removed stream-json package dependency. TCP and TLS messages must now end with the configured delimiter (\n by default); concatenated JSON without delimiters is no longer supported. This probably breaks backwards compatibility. If you require advanced parsing in TCP or TLS streams, see the section on recommended use.
4.1.0
New server option maxBatchLength
4.0.0
Remove lodash dependency which should halve bundle size. There might be minor incompatibilities if you pass funky object or array types to jayson methods.
3.6.4
Websocket client and server support
3.6.1
JSON-RPC 2.0 notifications no longer have id property unless overridden
3.3.3
Promise support for browser client