Class OAuth2Error

A generic error that conforms [rfc6749] OAuth2 error.

see https://datatracker.ietf.org/doc/html/rfc6749#section-5.2

Hierarchy

Error
- OAuth2Error

Index

Constructors

Properties

error error_description message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace create

Constructors

constructor

new OAuth2Error(error: string, error_description: string): OAuth2Error
Parameters
- error: string
- error_description: string
Returns OAuth2Error
Overrides Error.constructor
- Defined in src/errors.ts:7

Properties

error

error: string

error_description

error_description: string

message

message: string

name

name: string

`Optional` stack

stack?: string

`Static` `Optional` prepareStackTrace

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

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Optional override for formatting stack traces
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

`Static` stackTraceLimit

stackTraceLimit: number

Methods

`Static` captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4

`Static` create

create(__namedParameters: {
error: string;
error_description: string;
}): OAuth2Error
Parameters
- __namedParameters: {
  error: string;
  error_description: string;
  }
  - error: string
  - error_description: string
Returns OAuth2Error
- Defined in src/errors.ts:13