Class MfaRequiredError

Error thrown when the token exchange results in a mfa_required error

Hierarchy

GenericError
- MfaRequiredError

Index

Constructors

Properties

error error_description message mfa_token name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace fromPayload

Constructors

constructor

new MfaRequiredError(error, error_description, mfa_token): MfaRequiredError
Parameters
- error: string
- error_description: string
- mfa_token: string
Returns MfaRequiredError
Overrides GenericError.constructor
- Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:45

Properties

error

error: string

error_description

error_description: string

message

message: string

mfa_token

mfa_token: string

name

name: string

`Optional` stack

stack?: string

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

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

`Static` stackTraceLimit

stackTraceLimit: number

Methods

`Static` captureStackTrace

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

`Static` fromPayload

fromPayload(__namedParameters): GenericError
Parameters
- __namedParameters: {
  error: string;
  error_description: string;
  }
  - error: string
  - error_description: string
Returns GenericError
Inherited from GenericError.fromPayload
- Defined in node_modules/@auth0/auth0-spa-js/dist/typings/errors.d.ts:8