Security News
RubyGems.org Adds New Maintainer Role
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
jsonrpc-dispatch
Advanced tools
JSONRPC is a module for managing JSONRPC requests and responses in JavaScript.
This implementation is agnostic of the transport mechanism to send and receive JSONRPC messages. This means it can be easily integrated with XMLHttpRequests, HTTPServer, and postMessage cross domain messaging. A few of the features included are:
Add jsonrpc-dispatch
to your package.json
npm install jsonrpc-dispatch --save
Require the JSONRPC constructor into the module.
import JSONRPC from 'jsonrpc-dispatch'
The JSONRPC takes 2 arguments: a dispatcher and an object mapping of methods it will take requests for.
const jsonrpc = new JSONRPC([dispatcher], [methods]);
name | type | description |
---|---|---|
dispatcher | function | A handler which is passed the JSONRPC message object to send. |
methods | object | A mapping of method names to function objects which the JSONRPC instance will handle requests for. The functions must return a promise. |
The below example creates a JSONRPC instance which supports a single API to add
parameters together. The result is sent through the dispatcher to the parent
frame using the postMessage
API.
const methods = {
add(x, y) {
// Always return a promise
return Promise.resolve(x + y);
}
};
const dispatcher = (message) => {
// Post a message to the parent frame
parent.postMessage(message, 'https://trustedDomain.com');
};
const jsonrpc = new JSONRPC(dispatcher, methods);
http://www.jsonrpc.org/specification#request_object
Sends a JSONRPC request to the provided dispatcher. The request takes 2 parameters
name | type | description |
---|---|---|
name | String | The method name to send the request for |
parameters | Array or Object | (Optional) The parameters to pass to the method call |
Returns an instance of a Promise which is resolved or rejected when the response is received.
jsonrpc.request('foobar', ['biz', 'baz']).then((result) => {
// TODO: do something with result
});
http://www.jsonrpc.org/specification#notification
Sends a JSONRPC notification request to the provided dispatcher. Notifications are similar to requests but do not have any responses and thus do not return a promise. Notifications take 2 parameters:
name | type | description |
---|---|---|
name | String | The method name to send the request for |
parameters | Array or Object | (Optional) The parameters to pass to the method call |
jsonrpc.notification('foobar', ['biz', 'baz']);
Processes incoming JSONRPC messages to be handled as requests, responses or notifications. Handle takes a single argument:
name | type | description |
---|---|---|
message | Object | A JSONRPC request or response object |
jsonrpc.handle({
id: '1',
method: 'add',
params: [1, 2],
jsonrpc: '2.0'
});
Here is an example usage using AJAX as a transport mechanism to call a JSONRPC service which handles adding 2 numbers together.
// 1. Create new JSONRPC instance which only makes requests.
// Pass a dispatcher to post the messages to a server using jQuery.
// Have the dispatcher pass the AJAX response to the jsonrpc#handle method.
const jsonrpc = new JSONRPC((message) => {
$.post('/jsonrpc-service', message, jsonrpc.handle.bind(jsonrpc), 'json')
})
// 2. Send a JSONRPC request then print out the result
jsonrpc.request('add', [1,2]).then((result) => {
console.log('1 + 2 = ', result)
});
See CONTRIBUTING.md
Copyright 2016 Cerner Innovation, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
FAQs
An unopinionated JSONRPC dispatcher for JavaScript
The npm package jsonrpc-dispatch receives a total of 2,998 weekly downloads. As such, jsonrpc-dispatch popularity was classified as popular.
We found that jsonrpc-dispatch demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.