@mainframe/rpc-request
    TypeScript icon, indicating that this package has built-in type declarations

    0.2.0 • Public • Published

    rpc-request

    Class extending rpc-base to handle stateless JSON-RPC 2.0 calls.

    See transport-create-http, transport-http-browser and transport-http-node for possible transports and rpc-stream to handle stateful JSON-RPC 2.0 calls.

    Installation

    yarn add @mainframe/rpc-request

    Usage

    import RequestRPC from '@mainframe/rpc-request'
    import httpTransport from '@mainframe/transport-http-node'
     
    class MyAPI extends RequestRPC {
      constructor(url: string) {
        super(httpTransport(url))
      }
     
      getUser(id: string): Promise<{ name: string }> {
        return this.request('getUser', [id])
      }
    }
     
    const api = new MyAPI('http://my-api-url')
    api.getUser('1234')

    Types

    type FetchFunction = <D = any, R = any>(data: D) => Promise<R>

    API

    See the BaseRPC API for inherited methods and properties.

    new RequestRPC()

    Arguments

    1. fetch: FetchFunction: function making the server call using the JSON-RPC request Object and returning the response.

    .request()

    Arguments

    1. method: string
    2. params: T = any

    Returns Promise<R = any>

    License

    MIT

    Keywords

    none

    Install

    npm i @mainframe/rpc-request

    DownloadsWeekly Downloads

    4

    Version

    0.2.0

    License

    MIT

    Unpacked Size

    5.18 kB

    Total Files

    6

    Last publish

    Collaborators

    • aclarke
    • diogoperillo
    • howleysv
    • mosic
    • paul_lecam
    • sarahwiley