Class RequestorJsonRpc

constructor

• new RequestorJsonRpc(
      url_: string,
      config?: RequestorJsonRpcConfig,
      onError?: (err: unknown) => void | Promise<void>,
  ): RequestorJsonRpc

  Creates a Requestor using legacy positional arguments.

  Parameters

  • url_: string

    The URL of the JSON-RPC server.

  • Optionalconfig: RequestorJsonRpcConfig
  • OptionalonError: (err: unknown) => void | Promise<void>

  Returns RequestorJsonRpc

  Deprecated

  Use RequestorJsonRpc.new with a borrowed Transport or RequestorJsonRpc.open when creating Transports.

Optional ReadonlymaxConcurrent

Readonlytransport

url

• get url(): string

  Returns the URL of the JSON-RPC server.

  Returns string

  The URL of the JSON-RPC server.

  Deprecated

  URL belongs to Transport construction and is unavailable for Requestors created with RequestorJsonRpc.new.

Staticnew

• new(
      __namedParameters: {
          transport: JsonRpcTransport;
          maxConcurrent?: number;
          onError?: (err: unknown) => void | Promise<void>;
      },
  ): RequestorJsonRpc

  Creates a Requestor that borrows an existing Transport.

  Parameters

  • __namedParameters: {
        transport: JsonRpcTransport;
        maxConcurrent?: number;
        onError?: (err: unknown) => void | Promise<void>;
    }

  Returns RequestorJsonRpc

Staticopen

• open(
      __namedParameters: {
          urls: readonly [string, string];
          timeout?: number;
          maxConcurrent?: number;
          onError?: (err: unknown) => void | Promise<void>;
      },
  ): Owner<RequestorJsonRpc>

  Opens a Requestor with ownership of its default transports.

  Parameters

  • __namedParameters: {
        urls: readonly [string, string];
        timeout?: number;
        maxConcurrent?: number;
        onError?: (err: unknown) => void | Promise<void>;
    }

  Returns Owner<RequestorJsonRpc>

request

• request(
      rpcMethod: string,
      params: unknown[],
      inTransformers?: (((_: any) => unknown) | undefined)[],
      outTransformer?: (_: any) => unknown,
  ): Promise<unknown>

  request a JSON-RPC method.

  Parameters

  • rpcMethod: string

    The JSON-RPC method.

  • params: unknown[]

    Params for the method.

  • OptionalinTransformers: (((_: any) => unknown) | undefined)[]

    An array of input transformers.

  • OptionaloutTransformer: (_: any) => unknown

    An output transformer function.

  Returns Promise<unknown>

  Method response.

requestPayload

• requestPayload(payload: JsonRpcPayload): Promise<unknown>

  Parameters

  • payload: JsonRpcPayload

  Returns Promise<unknown>

buildPayload

• buildPayload(method: string, req: unknown[]): JsonRpcPayload

  Builds a JSON-RPC payload for the given method and parameters.

  Parameters

  • method: string

    The JSON-RPC method name.

  • req: unknown[]

    The parameters for the JSON-RPC method.

  Returns JsonRpcPayload

  The JSON-RPC payload.