Client et services
Le point d'entrée du SDK : comment créer le client et quels services il expose.
6 min de lecture·Niveau référence·Révisé le 12 oct. 2026
Ce texte anglais a été généré automatiquement à partir de l’original français et n’a pas encore été relu.
Cette page a été traduite automatiquement. La version anglaise fait foi.
#
Fonctions
Fonctions exportées
| Fonction | Descriptif |
|---|---|
function createClient<Database = any>(baseUrl: string, apiKey: string, options?: AuraClientOptions): AuraClient<Database> | Créez une nouvelle instance client Aurabase. |
function createAdminClient<Database = any>(baseUrl: string, serviceRoleKey: string, options?: AuraClientOptions): AuraClient<Database> | Crée un client pour SERVER et utilise uniquement pour les opérations d'administration (client.authAdmin: lister/créer/bannir les utilisateurs, audit de lecture). |
#
Classe
AuraClient
Client principal Aurabase.
| Propriété | Descriptif |
|---|---|
readonly baseUrl: string | URL du projet (https://<slug>.aurabase.cloud), sans barre de fin. |
readonly apiKey: string | null | Clé API du projet (anon ou service_role) envoyée dans l'en-tête apikey ; null si aucun n’a été fourni. |
readonly fetchFn: typeof globalThis.fetch | Fonction fetch utilisée pour toutes les requêtes (celle de options.fetch, sinon globalThis.fetch). |
readonly authStore: BaseAuthStore | Magasin de session (jeton d'accès, jeton de rafraîchissement, utilisateur) : mémoire, localStorage ou cookies selon le contexte. |
readonly retryConfig: { enabled: boolean; maxRetries: number; } | Politique de reprise des demandes de lecture (GET, HEAD) en cas d'erreur passagère : activée ou non, et nombre maximum de reprises. |
readonly requestTimeoutMs?: number | Délai d'expiration par défaut (ms) pour les requêtes JSON sans signal. undefined → défaut noyau (30s). |
readonly onEvent?: (event: AuraObservabilityEvent) => void | Crochet d'observabilité - voir AuraClientOptions.onEvent. |
readonly debug?: boolean | Journaliser chaque AuraObservabilityEvent via console.debug — voir AuraClientOptions.debug. |
get auth(): AuthService | Service d'authentification : inscription, connexion, session, MFA, OAuth, identités. |
get authAdmin(): AuthAdminService | API d'administration d'authentification (utilisateurs, sessions, journal d'audit, modèles d'e-mails). |
get db(): DatabaseService<Database, Schema> | Service de base de données : requêtes sur les tables et vues, appels de fonctions SQL (rpc), SQL brut. |
get storage(): StorageService | Service de stockage : buckets, envois, téléchargements, URL signées et publiques, transformations d'images. |
get realtime(): RealtimeService | Service en temps réel : chaînes, changements Postgres, diffusion (broadcast) et présence. |
get functions(): FunctionsService | Service Edge Functions : invocation, et gestion des jobs et cron avec une clé service_role. |
get ai(): AiService | Service IA : conversation (chat), intégrations, RAG (ingest, requêtes, espaces de noms), recherche sémantique et sessions. |
get notifications(): NotificationsService | Service de notifications : envoi (email, SMS, push, webhook), historique, modèles et administration. |
| Méthode | Descriptif |
|---|---|
dispose(): void | Démonte le client : arrête l'actualisation proactive (ticker + visibilité + BroadcastChannel), déconnecte en temps réel, vide les écouteurs d'authentification. |
from<TableName extends string & keyof Schema['Tables'], Table extends Schema['Tables'][TableName]>(table: TableName): AuraQueryBuilder<Schema, Table, TableName, AuraClientOptionsT>from<ViewName extends string & keyof Schema['Views'], View extends Schema['Views'][ViewName]>(view: ViewName): AuraQueryBuilder<Schema, View, ViewName, AuraClientOptionsT>from(table: string): AuraQueryBuilder<any, any, any, AuraClientOptionsT> | Raccourci : interrogez une table ou une vue de base de données (API compatible Supabase). |
rpc<FnName extends string = string, Args extends Record<string, unknown> = Record<string, unknown>>(fn: FnName, args?: Args, options?: Parameters<DatabaseService<Database, Schema>['rpc']>[2]): ReturnType<DatabaseService<Database, Schema>['rpc']> | Raccourci : appeler une procédure stockée / fonction PostgreSQL via RPC (API compatible Supabase). |
channel(name: string, options?: ChannelConfig): AuraChannel | Raccourci : créez un canal en temps réel avec l'API compatible Supabase. |
removeChannel(channel: string | AuraChannel): void | Raccourci : supprimez un canal en temps réel par son nom ou par une instance AuraChannel. |
removeAllChannels(): void | Raccourci : supprimez toutes les chaînes en temps réel et désabonnez-vous. |
getChannels(): AuraChannel[] | Raccourci : répertorie tous les canaux en temps réel actifs. |
Page générée
Cette page est générée à partir des déclarations de type et des commentaires du SDK, elle ne peut donc pas dériver du code publié. Pour des exemples concrets, lisez les guides.
Dernière mise à jour · 12 oct. 2026