Skip to main content

usePinAuth

Hook principal que orquesta todo el flujo de autenticación por PIN.

Uso

Parámetros

PinAuthOptions
required
Opciones de configuración

PinAuthOptions

string
required
URL del backend de Camarauth
string
required
Número de WhatsApp para enviar el PIN
number
default:"6"
Longitud del PIN a generar
number
default:"180"
Segundos antes de que expire el PIN
number
default:"3"
Máximo de regeneraciones automáticas
boolean
default:"false"
Generar PIN automáticamente al conectar
string
default:"'PIN:'"
Prefijo del mensaje de WhatsApp
(pin: string, emojis: string[]) => void
Callback cuando se genera un PIN
(user: User) => void
Callback cuando la autenticación es exitosa
(error: CamarauthError) => void
Callback cuando hay un error
() => void
Callback cuando el PIN expira
() => void
Callback cuando se alcanza el máximo de regeneraciones

Valor de retorno

Retorna un objeto PinAuthState:
string | null
PIN actual
string[]
Array de emojis del PIN
string
PIN como string de emojis
number
Segundos restantes
string
Tiempo formateado (MM:SS)
boolean
Si el PIN expiró
number
Número de regeneraciones
boolean
Si se alcanzó el máximo
AuthStatus
Estado actual: ‘idle’ | ‘polling’ | ‘success’ | ‘error’ | ‘expired’
boolean
Si está cargando o conectando
User | null
Datos del usuario autenticado
CamarauthError | null
Error actual si existe
Link de WhatsApp con mensaje
string | null
URL del QR code
string
Mensaje completo para WhatsApp

Métodos

() => void
Generar un nuevo PIN
() => void
Cancelar autenticación actual
() => void
Resetear todo el estado

Ejemplo completo

Véase también