@juzi/wechaty/src/io-peer/json-rpc-peer.d.ts

Wechaty is a RPA SDK for Chatbot Makers.

/**
 * Add typescript definitions #60
 *  https://github.com/JsCommunity/json-rpc-peer/pull/60
 */
declare module 'json-rpc-peer' {

  /// <reference types='json-rpc-protocol' />
  /// <reference types='node' />
  import { Writable }     from 'stream'
  import { EventEmitter } from 'events'
  import {
    JsonRpcPayload,
    JsonRpcParamsSchema,
  }                       from 'json-rpc-protocol'

  // export as namespace JsonRpcPeer

  export * from 'json-rpc-protocol'

  export class Peer extends EventEmitter implements Writable {

    constructor(onmessage?: (message: JsonRpcPayload, data: any) => Promise<any>)

    public exec(
      message: string | object,
      data?: any
    ): Promise<undefined | string | JsonRpcPayload | JsonRpcPayload[]>

    /**
     * Fails all pending requests.
     */
    public failPendingRequests(reason?: string)

    /**
     * This function should be called to send a request to the other end.
     */
    public request(method: string, params?: JsonRpcParamsSchema): Promise<any>

    /**
     * This function should be called to send a notification to the other end.
     */
    public notify(method: string, params?: JsonRpcParamsSchema)

    public push(chunk: any, encoding?: string)

    public pipe<T extends Writable>(writable: T): T

    // NodeJS.WritableStream

    writable: boolean
    write(
      buffer: Uint8Array | string,
      cb?: (err?: Error | null) => void
    ): boolean

    write(
      str: string,
      encoding?: string,
      cb?: (err?: Error | null) => void
    ): boolean

    end(cb?: () => void): void
    end(data: string | Uint8Array, cb?: () => void): void
    end(str: string, encoding?: string, cb?: () => void): void

  }

}