Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
jsonrpcserver
Advanced tools
JSON-RPC Server (http://www.jsonrpc.org/specification) with endpoints implementation
Simple-to-use JSON-RPC Server with endpoints implementation (JSON-RPC Specification).
$ npm install jsonrpcserver --save
var logger = require('mylogger'),
API = require('myapi'),
JsonRpcServer = require('jsonrpcserver');
var rpcServerInstance = new JsonRpcServer(logger); //logger is an optional one
...
rpcServerInstance.register('/my/new/endpoint', {
"context": new API(),
"map": {
"testMethod": {
"handler": "test",
"params": [
{
"type": "string",
"required": true
}
]
},
"yetAnotherMethod": {
"handler": function(options, cb) {
(typeof cb == 'function') && cb(null, options);
},
"params": {
"first": {
"type": "number",
"required": true
},
"second": {
"type": "any",
"required": false,
"default": "Foo"
}
}
}
}
});
...
rpcServerInstance.init({
handler: 80,
timeout: 10
});
constructor (logger)
- create the serverlogger
- an optional parameter, it means reference to the logger instance; console will use by defaultregister (endpoint, map)
- register endpointYou can use register
method (as well as unload
) at any time in code, definition order (before or after init
) doesn't matter.
endpoint
- - endpoint URI, that will handle your requestsmap
- - API schema map, such as (type 'any'
could use for non-strict type validation):
/**
* @param map = {
* context: <object>,
* map: {
* methodName1: {
* handler: <functionName|callable>,
* //-- with named params ---
* params: {
* param1: {
* type: "string|number|boolean|object|array|any",
* required: true|false,
* default: <defaultValue>
* },
* ...
* }
* //-- or with array-like params --
* params: [
* {
* type: "string|number|boolean|object|array|any",
* required: true|false,
* default: <defaultValue>
* },
* ...
* ]
* },
* ...
* }
* }
*/
unload (endpoint)
- unload the endpointendpoint
- - endpoint URI that would be unloadedinit (configuration)
- instantiate the serverconfiguration
- - an optional parameter, that describe server configuration (look below, with defaults):
{
"handler": 80, // it may be port, unix-socket path or instance of HTTP/HTTPS server, by default 80 port
"https": false, // boolean flag sets true if we want set up the HTTPS server
"key": null, // the SSL-key path (for HTTPS only)
"cert": null, // the SSL-cert path (for HTTPS only)
"timeout": 60 // the request timeout in sec, by default 60
}
Not-implemented features:
MIT
FAQs
JSON-RPC Server (http://www.jsonrpc.org/specification) with endpoints implementation
The npm package jsonrpcserver receives a total of 1 weekly downloads. As such, jsonrpcserver popularity was classified as not popular.
We found that jsonrpcserver demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.