Class RpcError

An error that occurred while calling a RPC method.

Hierarchy

  • Error
    • RpcError

Constructors

constructor

Properties

code message meta methodName? name serviceName? stack? prepareStackTrace? stackTraceLimit

Methods

toString captureStackTrace

Constructors

constructor

  • Parameters

    • message: string
    • Optional code: string
    • Optional meta: RpcMetadata

    Returns RpcError

Properties

code

code: string

A status code as string. The value depends on the RpcTransport being used.

For gRPC, it will be the string value of a StatusCode enum value https://github.com/grpc/grpc/blob/a19d8dcfb50caa81cddc25bc1a6afdd7a2f497b7/include/grpcpp/impl/codegen/status_code_enum.h#L24

For Twirp, it will be one of the Twirp error codes as string: https://twitchtv.github.io/twirp/docs/spec_v5.html#error-codes

message

message: string

meta

meta: RpcMetadata

Metadata related to the failed call.

Optional methodName

methodName?: string

The name of the RPC method that was called as declared in .proto

name

name: string

Optional serviceName

serviceName?: string

The name of the RPC service that was called as declared in .proto

It will be in the form of:

  • package name
  • dot "."
  • service name

If the service was declared without a package, the package name and dot are omitted.

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

toString

  • Returns string

Static captureStackTrace

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc