ReflectionNotSupportedError

Defined in: src/client/introspect.ts:418

The server does not host vgi_rpc.Reflection.v1.

Thrown by listProtocols and describeProtocol when the server answers the reflection call with “not hosted” rather than with a listing: a TypeScript server built with enableDescribe: false (its default is true), a Python server built without enable_describe=True (its default), or one that predates reflection. Such a server still serves its own protocol, so this is a statement about discovery, not about the connection – the connection remains usable. No listing is ever inferred.

A subclass of RpcError carrying the server’s original error fields, so code that already catches RpcError keeps working.

Extends

• RpcError

Constructors

Constructor

new ReflectionNotSupportedError(
   errorType,
   errorMessage,
   remoteTraceback,
   model?
): ReflectionNotSupportedError;

Defined in: src/client/introspect.ts:419

Parameters

Parameter	Type
errorType	string
errorMessage	string
remoteTraceback	string
model	RpcErrorModel | undefined

Returns

ReflectionNotSupportedError

Overrides

RpcError.constructor

Properties

cause?

optional cause?: unknown;

Defined in: docs/node_modules/typescript/lib/lib.es2022.error.d.ts:24

The cause of the error.

Inherited from

RpcError.cause

---

errorCode

readonly errorCode: string;

Defined in: src/errors.ts:54

vgi_rpc.error_code as received, or "" when absent.

Inherited from

RpcError.errorCode

---

errorDetails

readonly errorDetails: readonly ErrorDetailJson[];

Defined in: src/errors.ts:58

vgi_rpc.error_details as received: every object, in wire order.

Inherited from

RpcError.errorDetails

---

errorKind

readonly errorKind: string;

Defined in: src/errors.ts:56

vgi_rpc.error_kind as received, or "" when absent.

Inherited from

RpcError.errorKind

---

errorMessage

readonly errorMessage: string;

Defined in: src/errors.ts:66

Human-readable message from the remote error.

Inherited from

RpcError.errorMessage

---

errorType

readonly errorType: string;

Defined in: src/errors.ts:64

Remote error class name (e.g. "ValueError").

Inherited from

RpcError.errorType

---

message

message: string;

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

RpcError.message

---

name

name: string;

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

RpcError.name

---

remoteTraceback

readonly remoteTraceback: string;

Defined in: src/errors.ts:69

Remote stack-trace text, or an empty string when unavailable – which is when the server turned tracebacks off.

Inherited from

RpcError.remoteTraceback

---

requestId

readonly requestId: string;

Defined in: src/errors.ts:60

vgi_rpc.request_id, or "".

Inherited from

RpcError.requestId

---

stack?

optional stack?: string;

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

RpcError.stack

---

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

RpcError.stackTraceLimit

Accessors

code

Get Signature

get code():
  | "CANCELLED"
  | "UNKNOWN"
  | "INVALID_ARGUMENT"
  | "DEADLINE_EXCEEDED"
  | "NOT_FOUND"
  | "ALREADY_EXISTS"
  | "PERMISSION_DENIED"
  | "RESOURCE_EXHAUSTED"
  | "FAILED_PRECONDITION"
  | "ABORTED"
  | "OUT_OF_RANGE"
  | "UNIMPLEMENTED"
  | "INTERNAL"
  | "UNAVAILABLE"
  | "DATA_LOSS"
  | "UNAUTHENTICATED";

Defined in: src/errors.ts:81

The canonical code; UNKNOWN when absent or unrecognised.

Returns

| "CANCELLED" | "UNKNOWN" | "INVALID_ARGUMENT" | "DEADLINE_EXCEEDED" | "NOT_FOUND" | "ALREADY_EXISTS" | "PERMISSION_DENIED" | "RESOURCE_EXHAUSTED" | "FAILED_PRECONDITION" | "ABORTED" | "OUT_OF_RANGE" | "UNIMPLEMENTED" | "INTERNAL" | "UNAVAILABLE" | "DATA_LOSS" | "UNAUTHENTICATED"

Inherited from

RpcError.code

Methods

badRequest()

badRequest(): BadRequest | null;

Defined in: src/errors.ts:115

The vgi_rpc.BadRequest detail, if present.

Returns

BadRequest | null

Inherited from

RpcError.badRequest

---

details()

details(): ErrorDetail[];

Defined in: src/errors.ts:93

The details this client understands, in wire order; unknown types skipped.

Returns

ErrorDetail[]

Inherited from

RpcError.details

---

errorInfo()

errorInfo(): ErrorInfo | null;

Defined in: src/errors.ts:107

The vgi_rpc.ErrorInfo detail, if present.

Returns

ErrorInfo | null

Inherited from

RpcError.errorInfo

---

help()

help(): Help | null;

Defined in: src/errors.ts:131

The vgi_rpc.Help detail, if present.

Returns

Help | null

Inherited from

RpcError.help

---

isRetryable()

isRetryable(): boolean;

Defined in: src/errors.ts:88

Whether retrying this call is warranted (WIRE_PROTOCOL.md §8): UNAVAILABLE always, RESOURCE_EXHAUSTED only with RetryInfo. When retryInfo is present a retry waits at least that long.

Returns

boolean

Inherited from

RpcError.isRetryable

---

localizedMessage()

localizedMessage():
  | LocalizedMessage
  | null;

Defined in: src/errors.ts:135

The vgi_rpc.LocalizedMessage detail, if present.

Returns

| LocalizedMessage | null

Inherited from

RpcError.localizedMessage

---

preconditionFailure()

preconditionFailure():
  | PreconditionFailure
  | null;

Defined in: src/errors.ts:119

The vgi_rpc.PreconditionFailure detail, if present.

Returns

| PreconditionFailure | null

Inherited from

RpcError.preconditionFailure

---

quotaFailure()

quotaFailure(): QuotaFailure | null;

Defined in: src/errors.ts:123

The vgi_rpc.QuotaFailure detail, if present.

Returns

QuotaFailure | null

Inherited from

RpcError.quotaFailure

---

resourceInfo()

resourceInfo(): ResourceInfo | null;

Defined in: src/errors.ts:127

The vgi_rpc.ResourceInfo detail, if present.

Returns

ResourceInfo | null

Inherited from

RpcError.resourceInfo

---

retryInfo()

retryInfo(): RetryInfo | null;

Defined in: src/errors.ts:111

The vgi_rpc.RetryInfo detail, if present.

Returns

RetryInfo | null

Inherited from

RpcError.retryInfo

---

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

RpcError.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

RpcError.captureStackTrace

---

fromRpcError()

static fromRpcError(error): ReflectionNotSupportedError;

Defined in: src/client/introspect.ts:430

Wrap the server’s “not hosted” answer, keeping every field.

Parameters

Parameter	Type
error	RpcError

Returns

ReflectionNotSupportedError

---

isError()

Call Signature

static isError(error): error is Error;

Defined in: docs/node_modules/typescript/lib/lib.esnext.error.d.ts:21

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

Parameter	Type
error	unknown

Returns

error is Error

Inherited from

RpcError.isError

Call Signature

static isError(value): value is Error;

Defined in: node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

Parameters

Parameter	Type	Description
value	unknown	The value to check

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

RpcError.isError

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

RpcError.prepareStackTrace