providers
Anonymous

providers/Anonymous

Configure Anonymous provider given an AnonymousConfig.

import Anonymous from "@convex-dev/auth/providers/Anonymous";
import { convexAuth } from "@convex-dev/auth/server";
 
export const { auth, signIn, signOut, store } = convexAuth({
  providers: [Anonymous],
});

AnonymousConfig<DataModel>

The available options to an Anonymous provider for Convex Auth.

Properties

id?

optional id: string

Uniquely identifies the provider, allowing to use multiple different Anonymous providers.

Defined in

src/providers/Anonymous.ts:36 (opens in a new tab)

profile()?

Perform checks on provided params and customize the user information stored after sign in.

Parameters
ParameterTypeDescription

params

Record<string, undefined | Value>

The values passed to the signIn function.

ctx

GenericActionCtxWithAuthConfig<DataModel>

Convex ActionCtx in case you want to read from or write to the database.

Returns

WithoutSystemFields<DocumentByName<DataModel, "users">> & object

Defined in

src/providers/Anonymous.ts:41 (opens in a new tab)


Anonymous()

An anonymous authentication provider.

This provider doesn't require any user-provided information.

Parameters

ParameterType

config

AnonymousConfig<DataModel>

Returns

ConvexCredentialsConfig

Defined in

src/providers/Anonymous.ts:61 (opens in a new tab)