Skip to content
Vendidit Auth

Class: RequiresTwoFactorError

Class: RequiresTwoFactorError

Defined in: auth-client/src/core/errors.ts:130

Returned-as-flag flavor: when login succeeded except 2FA is required. The SDK’s default Login flow does NOT throw this — it resolves with { requires_2fa: true }. The class is here for consumers that want to model the case as an exception.

Extends

Constructors

Constructor

new RequiresTwoFactorError(message?): RequiresTwoFactorError

Defined in: auth-client/src/core/errors.ts:131

Parameters

message?

string = 'two-factor authentication required'

Returns

RequiresTwoFactorError

Overrides

AuthError.constructor

Properties

cause?

optional cause?: unknown

Defined in: auth-docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

AuthError.cause

code

readonly code: string

Defined in: auth-client/src/core/errors.ts:25

Inherited from

AuthError.code

message

message: string

Defined in: auth-docs/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

AuthError.message

name

name: string

Defined in: auth-docs/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

AuthError.name

serverCode?

readonly optional serverCode?: string

Defined in: auth-client/src/core/errors.ts:27

Inherited from

AuthError.serverCode

stack?

optional stack?: string

Defined in: auth-docs/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

AuthError.stack

status?

readonly optional status?: number

Defined in: auth-client/src/core/errors.ts:26

Inherited from

AuthError.status

stackTraceLimit

static stackTraceLimit: number

Defined in: auth-client/node_modules/.pnpm/@types+node@22.19.19/node_modules/@types/node/globals.d.ts:68

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

AuthError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: auth-client/node_modules/.pnpm/@types+node@22.19.19/node_modules/@types/node/globals.d.ts:52

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

AuthError.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: auth-client/node_modules/.pnpm/@types+node@22.19.19/node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

AuthError.prepareStackTrace