Class OAuthHttpError

Represents on OAuth error that is being thrown. OAuth error responses have additional fields that need to be present in the JSON response, as described in RFC 6749, §4.1.2.1.

Hierarchy

HttpError
- OAuthHttpError

Index

Constructors

constructor

new OAuthHttpError(mandatoryFields: OAuthErrorFields, name?: string, statusCode?: number, message?: string, options?: HttpErrorOptions): OAuthHttpError
Parameters
- mandatoryFields: OAuthErrorFields
- Optional name: string
- Optional statusCode: number
- Optional message: string
- Optional options: HttpErrorOptions
Returns OAuthHttpError
Overrides HttpError.constructor
- Defined in src/util/errors/OAuthHttpError.ts:27

Properties

`Optional` `Readonly` cause

cause?: unknown

`Optional` `Readonly` details

details?: Dict<unknown>

`Readonly` errorCode

errorCode: string

`Readonly` mandatoryFields

mandatoryFields: OAuthErrorFields

message

message: string

name

name: string

`Optional` stack

stack?: string

`Readonly` statusCode

statusCode: number

`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

generateMetadata

generateMetadata(subject: string | Quad_Subject): Quad[]
Returns quads representing metadata relevant to this error.
Parameters
- subject: string | Quad_Subject
Returns Quad[]
Inherited from HttpError.generateMetadata
- Defined in src/util/errors/HttpError.ts:54

`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 HttpError.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4

`Static` isInstance

isInstance(error: unknown): error is OAuthHttpError
Parameters
- error: unknown
Returns error is OAuthHttpError
Overrides HttpError.isInstance
- Defined in src/util/errors/OAuthHttpError.ts:33

Class OAuthHttpError

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

mandatoryFields: OAuthErrorFields

Optional name: string

Optional statusCode: number

Optional message: string

Optional options: HttpErrorOptions

Returns OAuthHttpError

Properties

Optional Readonly cause

Optional Readonly details

Readonly errorCode

Readonly mandatoryFields

message

name

Optional stack

Readonly statusCode

Static Optional prepareStackTrace

Type declaration

See

Parameters

err: Error

stackTraces: CallSite[]

Returns any

Static stackTraceLimit

Methods

generateMetadata

Parameters

subject: string | Quad_Subject

Returns Quad[]

Static captureStackTrace

Parameters

targetObject: object

Optional constructorOpt: Function

Returns void

Static isInstance

Parameters

error: unknown

Returns error is OAuthHttpError

Settings

Member Visibility

Theme

`Optional` name: string

`Optional` statusCode: number

`Optional` message: string

`Optional` options: HttpErrorOptions

`Optional` `Readonly` cause

`Optional` `Readonly` details

`Readonly` errorCode

`Readonly` mandatoryFields

`Optional` stack

`Readonly` statusCode

`Static` `Optional` prepareStackTrace

`Static` stackTraceLimit

`Static` captureStackTrace

`Optional` constructorOpt: Function

`Static` isInstance