API Reference
Welcome to the Svelte Guardian API reference. This section provides detailed documentation for all components, functions, and types available in the library.
Core APIs
- guardianAuth() - Main initialization function
- signIn() - Sign in function
- signOut() - Sign out function
- createUser() - User creation function
Configuration
- Configuration Options - All available configuration options
- Types and Interfaces - TypeScript types and interfaces
- Environment Variables - Required and optional environment variables
Client-Side Helpers
- Authentication Helpers - Client-side authentication utilities
- Form Actions - SvelteKit form actions
- Stores - Svelte stores for authentication state
Security
- Email Verification - Email verification APIs
- Password Reset - Password reset APIs
- Two-Factor Authentication - 2FA APIs
- Rate Limiting - Rate limiting APIs
Database
- Adapters - Database adapters
- Schema - Database schema
- Custom Adapters - Creating custom database adapters
- Email Providers - Available email providers
- Email Templates - Customizing email templates
- Custom Providers - Creating custom email providers
Middleware
- Authentication Middleware - Authentication middleware
- Rate Limiting Middleware - Rate limiting middleware
- Route Protection - Route protection middleware
- Security Headers - Security headers middleware