Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

rpc-cli

gzhappysky7MIT1.2.1TypeScript support: included

A rpc client base on JSON-RPC 2.0 Specification.

example, typescript, library, starter, webpack, browserify, dts-bundle, package, jest, tsloader, boilerplate, ts-loader

readme

rpc-cli

A rpc client base on JSON-RPC 2.0 Specification.

Installation

npm install -save rpc-cli

Examples


import Client, { Options } from 'rpc-cli';


const options: Options = {
  url: 'http://*.*.*:8001/rpc.endpoint',
  onError: (error) => {
    console.log(error);
  }
};

const client = new Client(options);
const result = await client.invoke('operation.sum', { a: 2, b: 3 });
console.log(result); 

Client

const client = new Client(options);
const result = await client.invoke('operation.sum', { a: 2, b: 3 });

new Client(options) -> client

Instantiate a rpc client

Options

{
  // url is the rpc server URL that will be used for the request.
  url: string,
  // version is the rpc server version, default is 2.0.
  version?: string,
  // http cookie. eg. your can pass sessionid.
  cookies?: string,
  // Fired when a request could not be processed due to an error. 
  // eg. server throw a error or network error.
  onError?: onErrorType,
  // Fired when a request is send.
  onRequest: onRequestType,
  // Fired when a request is end.
  onResponse: onResponseType,
}