// Error codes

Every error Session kit throws or reports is an AuthError. Match on its code; the message is for people, and may change.

import { AuthError } from "@monarcode/session-kit";

export function isLocked(error: unknown): boolean {
  return error instanceof AuthError && error.code === "LOCKED";
}

How errors reach your app, and how to show them: Errors.

USER_VALIDATION_FAILEDCopy Anchor Link

The user couldn't be accepted. issues holds the schema's issues when it rejected the user, and cause holds the error when something else failed, such as an updateUser function or, in the browser of a server-rendered app, signing in on the server. Otherwise message says why, such as a user that isn't a plain JSON object.

INVALID_SESSIONCopy Anchor Link

Tokens or a saved session that can't be used, such as an access token that already expired at sign-in.

PERSISTENCE_FAILEDCopy Anchor Link

Storage couldn't be read, written or cleared. In the browser of a server-rendered app, signing out on the server failed.

REFRESH_FAILEDCopy Anchor Link

The refresh failed: your refresh callback threw, or there was no refresh option or refresh token to use. In the browser of a server-rendered app, reading the session or the access token from the server failed.

REVOKE_FAILEDCopy Anchor Link

Your revoke callback failed. It shows in state.error, and signOut() still resolves.

SESSION_CHANGEDCopy Anchor Link

The session changed while the call ran: a newer sign-in, a sign-out, or another tab replaced it.

UNAUTHENTICATEDCopy Anchor Link

The call needs someone signed in, and no one is.

LOCKEDCopy Anchor Link

The session is locked. Call unlock() first.

UNLOCK_FAILEDCopy Anchor Link

locking.open failed, so the session stays locked.

INVALID_OPTIONSCopy Anchor Link

An option or argument Session kit can't use, or a method called without the option it needs.