Skip to content
Migrating from NextAuth.js v4? Read our migration guide.
API reference
@auth/surrealdb-adapter

@auth/surrealdb-adapter

Official SurrealDB adapter for Auth.js / NextAuth.js.

Installation

npm install @auth/surrealdb-adapter surrealdb.js

AccountDoc<T>

type AccountDoc<T>: {
  access_token: string;
  expires_at: number;
  id: string;
  provider: string;
  providerAccountId: string;
  refresh_token: string;
  type: Extract<ProviderType, "oauth" | "oidc" | "email" | "webauthn">;
  userId: T;
};

Type parameters

Type parameterValue
Tstring

Type declaration

access_token?

optional access_token: string;

expires_at?

optional expires_at: number;

id

id: string;

provider

provider: string;

providerAccountId

providerAccountId: string;

refresh_token?

optional refresh_token: string;

type

type: Extract<ProviderType, "oauth" | "oidc" | "email" | "webauthn">;

userId

userId: T;

SessionDoc<T>

type SessionDoc<T>: Document & {
  userId: T;
};

Type declaration

userId

userId: T;

Type parameters

Type parameterValue
Tstring

UserDoc

type UserDoc: Document & {
  email: string;
};

Type declaration

email

email: string;

SurrealDBAdapter()

SurrealDBAdapter<T>(client): Adapter

Type parameters

Type parameter
T

Parameters

ParameterType
clientPromise<WebSocketStrategy | HTTPStrategy<T>>

Returns

Adapter


toId()

toId(surrealId): string

Parameters

ParameterType
surrealIdstring

Returns

string


toSurrealId()

toSurrealId(id): string

Parameters

ParameterType
idstring

Returns

string

Auth.js © Balázs Orbán and Team - 2024