npm

Need private packages and team management tools?Check out npm Orgs. »

tiny-jsonrpc-client

1.1.0 • Public • Published

jsonrpc-client

A really, really simple JSON-RPC 2.0 client.

Installation

npm install --save jsonrpc-client

Usage

Simple usage

var jsonRpc = require('jsonrpc-client')
 
// Our API server is at http://example.org/api
jsonRpc.setUrl('http://example.org/api')
// Let's call the 'saySomething' method that takes two parameters, 'to' and 'message'
jsonRpc.call('saySomething', {to: 'Alice', message: 'Hi, Bob!'})
.then(function success(result) {
  // The 'saySomething' method has a field 'output'
  console.log('output', result.output)
}, function failure(err) {
  // oops, something went wrong!
  console.error('Oops! Error code ' + err.code + '' + err.message)
  // additional data might be in 'err.data'
})

Using cookies

If the API is using a cookie to keep track of the session, you can use setUseCookies(true):

var jsonRpc = require('jsonrpc-client')
 
var SessionCookie = null // store session cookie for later
 
// Our API server is at http://example.org/api
jsonRpc.setUrl('http://example.org/api')
// Let's call the 'saySomething' method that takes two parameters, 'to' and 'message'
jsonRpc.call('login', {username: 'alice', password: 'monkey'})
.then(function success(loginResult) {
  // The 'getMessages' method has a field 'messages' and requires the cookie from login
  jsonRpc.call('getMessages', {}).then(function(msgResult) {
    console.log('Messages: ', result.messages)    
  })
  SessionCookie = jsonRpc.getCookie() // gets our session cookie for later use (see below)
}, function failure(err) {
  // oops, something went wrong!
  console.error('Oops! Error code ' + err.code + '' + err.message)
  // additional data might be in 'err.data'
})

You can also get hold of the cookie using getCookie and setCookie to set a cookie

var jsonRpc = require('jsonrpc-client')
 
// Our API server is at http://example.org/api
jsonRpc.setUrl('http://example.org/api')
 
jsonRpc.setCookie(SessionCookie) // the cookie from the example above, holding our session information
 
// Let's call the 'getMessages' method again without a login but using the cookie
jsonRpc.call('getMessages', {})
.then(function success(result) {
  // The 'getMessages' method has a field 'messages' and requires the cookie from login
  console.log('Messages: ', result.messages)
}, function failure(err) {
  // oops, something went wrong!
  console.error('Oops! Error code ' + err.code + '' + err.message)
  // additional data might be in 'err.data'
})

Keywords

install

npm i tiny-jsonrpc-client

Downloadsweekly downloads

3

version

1.1.0

license

ISC

last publish

collaborators

  • avatar
Report a vulnerability