Class: AuthError

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

Typed error classes. All thrown from the SDK extend AuthError so a consumer can try { ... } catch (e) { if (e instanceof AuthError) ... }.

Errors carry both a machine-readable code (stable across versions) and a cause chain when the failure originated lower in the stack (network error, crypto failure, etc.). The HTTP status, when relevant, is preserved on status so error UIs can branch without re-parsing.

Design notes:

We deliberately don’t expose every server error code as a class. The server uses a wide ErrCode enum; surfacing each as a class would couple the SDK to every server-side change. Instead we map the common HTTP families (4xx vs 5xx) to a few coarse buckets and stash the server’s code on the error for fine-grained branching.
RequiresTwoFactorError is NOT thrown as an exception in the normal flow — it’s an event-shaped response (LoginResult.requires_2fa true). The class exists for the case where a consumer chooses to model the 401-with-requires_2fa branch as an exception in their app.

Extends

Error

Extended by

Constructors

Constructor

new AuthError(message, opts?): AuthError

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

Parameters

message

string

opts?

cause?

unknown

code

string

serverCode?

string

status?

number

Returns

AuthError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

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

Inherited from

Error.cause

code

readonly code: string

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

message

message: string

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

Inherited from

Error.message

name

name: string

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

Inherited from

Error.name

serverCode?

readonly optional serverCode?: string

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

stack?

optional stack?: string

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

Inherited from

Error.stack

status?

readonly optional status?: number

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

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

Error.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

Error.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

Error.prepareStackTrace