APOLLO CODE

English

简体中文

English

简体中文

Appearance

apollo-code

apollo-code / shared/src / ProtocolViolationError

Class: ProtocolViolationError ​

Extends ​

Constructors ​

Constructor ​

new ProtocolViolationError(code, message, category?): ProtocolViolationError

Parameters ​

code ​

string

message ​

string

category? ​

"invalid_request" | "protocol" | "resource_exhausted"

Returns ​

ProtocolViolationError

Overrides ​

ApolloNormalizedError.constructor

Properties ​

category ​

readonly category: ApolloErrorCategory

Inherited from ​

ApolloNormalizedError.category

cause? ​

optional cause?: unknown

Inherited from ​

ApolloNormalizedError.cause

code ​

readonly code: string

Inherited from ​

ApolloNormalizedError.code

details ​

readonly details: JsonValue | undefined

Inherited from ​

ApolloNormalizedError.details

message ​

message: string

Inherited from ​

ApolloNormalizedError.message

name ​

name: string

Inherited from ​

ApolloNormalizedError.name

retryable ​

readonly retryable: boolean

Inherited from ​

ApolloNormalizedError.retryable

retryAfterMs ​

readonly retryAfterMs: number | undefined

Inherited from ​

ApolloNormalizedError.retryAfterMs

source ​

readonly source: ErrorSource

Inherited from ​

ApolloNormalizedError.source

stack? ​

optional stack?: string

Inherited from ​

ApolloNormalizedError.stack

status ​

readonly status: number | undefined

Inherited from ​

ApolloNormalizedError.status

stackTraceLimit ​

static stackTraceLimit: number

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 ​

ApolloNormalizedError.stackTraceLimit

Methods ​

toJSON() ​

toJSON(): Record<string, JsonValue | undefined>

Returns ​

Record<string, JsonValue | undefined>

Inherited from ​

ApolloNormalizedError.toJSON

captureStackTrace() ​

static captureStackTrace(targetObject, constructorOpt?): void

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

js
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:

js
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 ​

targetObject ​

object

constructorOpt? ​

Function

Returns ​

void

Inherited from ​

ApolloNormalizedError.captureStackTrace

isError() ​

static isError(error): error is Error

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

Parameters ​

error ​

unknown

Returns ​

error is Error

Inherited from ​

ApolloNormalizedError.isError

prepareStackTrace() ​

static prepareStackTrace(err, stackTraces): any

Parameters ​

err ​

Error

stackTraces ​

CallSite[]

Returns ​

any

See ​

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

Inherited from ​

ApolloNormalizedError.prepareStackTrace