Skip to main content

Class: OAuthError

Defined in: auth/src/auth/OAuthError.ts:14

An OAuth 2.0 error, per RFC 6749 §5.2 — a distinct wire shape ({error, error_description}) from this library's usual ApiError envelope, since the format here is spec-mandated rather than this library's own convention. Shared by every OAuth endpoint that reports errors this way: /token (RFC 6749 §5.2), and /revoke//introspect (RFC 7009 §2.2.1 / RFC 7662 §2.3, both of which reuse the same shape for a client-authentication failure).

Extends​

  • Error

Constructors​

Constructor​

new OAuthError(error, errorDescription?, status?): OAuthError

Defined in: auth/src/auth/OAuthError.ts:19

Parameters​

error​

string

errorDescription?​

string

status?​

number = 400

Returns​

OAuthError

Overrides​

Error.constructor

Properties​

error​

readonly error: string

Defined in: auth/src/auth/OAuthError.ts:15

errorDescription?​

readonly optional errorDescription?: string

Defined in: auth/src/auth/OAuthError.ts:16

message​

message: string

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

Inherited from​

Error.message

name​

name: string

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

Inherited from​

Error.name

stack?​

optional stack?: string

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

Inherited from​

Error.stack

status​

readonly status: number

Defined in: auth/src/auth/OAuthError.ts:17

stackTraceLimit​

static stackTraceLimit: number

Defined in: auth/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​

Error.stackTraceLimit

Methods​

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: auth/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​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

Error.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

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

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

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

Inherited from​

Error.prepareStackTrace