Username

This plugin provides advanced username validation and management for Better Auth. It allows users to sign in with a username and password and adds strong validation rules.

Installation

import { username, usernameClient } from "@encriva/better-auth-enchanced";

To use this plugin in your application, you need to register it in both client and server configurations.

Initialize plugin

auth.ts

export const auth = betterAuth({
  plugins: [
    username()
  ]
});

auth-client.ts

const authClient = createAuthClient({
  plugins: [
    usernameClient()
  ]
});

Usage

To sign in with username:

authClient.signIn.username({
  username: "clqu",
  password: "1234567890"
});

To update username:

// To update username
authClient.updateUser({
  username: (document.getElementById("username") as HTMLInputElement).value
});

API

Prop	Type	Default
`schema?`	`Record<string, any>`	`-`
`transform?`	`(username: string) => string`	`(username) => username`
`validator?`	`(username: string) => boolean \| Promise<boolean>`	`/^[a-zA-Z0-9_.]+$/`
`maxUsernameLength?`	`number`	`30`
`minUsernameLength?`	`number`	`3`

Error Codes

Code	Description
`INVALID_USERNAME_OR_PASSWORD`	Invalid username or password
`USERNAME_TOO_SHORT`	Username is too short
`USERNAME_TOO_LONG`	Username is too long
`INVALID_USERNAME`	Invalid username format
`USERNAME_IS_ALREADY_TAKEN`	Username is already taken
`EMAIL_NOT_VERIFIED`	Email address is not verified

Installation

Initialize plugin

Usage

API

Error Codes

On this page