Klient i usługi
Punkt wejścia SDK: jak utworzyć klienta i jakie usługi udostępnia.
6 min przeczytane·Poziom odniesienie·Zmieniono 12 paź 2026
Ten tekst w języku angielskim został wygenerowany automatycznie na podstawie francuskiego oryginału i nie był jeszcze recenzowany.
Ta strona została przetłumaczona automatycznie. Wersja angielska jest miarodajna.
#
Funkcje
Eksportowane funkcje
| Funkcjonować | Opis |
|---|---|
function createClient<Database = any>(baseUrl: string, apiKey: string, options?: AuraClientOptions): AuraClient<Database> | Utwórz nową instancję klienta Aurabase. |
function createAdminClient<Database = any>(baseUrl: string, serviceRoleKey: string, options?: AuraClientOptions): AuraClient<Database> | Tworzy klienta dla SERVER. Używaj tylko do operacji administracyjnych (client.authAdmin: lista/tworzenie/banowanie użytkowników, kontrola odczytu). |
#
Klasa
Klient Aura
Główny klient Aurabase.
| Nieruchomość | Opis |
|---|---|
readonly baseUrl: string | Adres URL projektu (https://<slug>.aurabase.cloud), bez kreski końcowej. |
readonly apiKey: string | null | Klucz API projektu (anon lub service_role) przesłany w nagłówku apikey; null, jeśli nie podano żadnego. |
readonly fetchFn: typeof globalThis.fetch | Funkcja fetch używana dla wszystkich zapytań (w przypadku options.fetch, w przeciwnym razie globalThis.fetch). |
readonly authStore: BaseAuthStore | Magazyn sesji (token dostępu, token odświeżania, użytkownik): pamięć, localStorage lub pliki cookie w zależności od kontekstu. |
readonly retryConfig: { enabled: boolean; maxRetries: number; } | Przeczytaj zasady wznowienia żądania (GET, HEAD) w przypadku błędu przejściowego: włączone lub nie, oraz maksymalna liczba wznowień. |
readonly requestTimeoutMs?: number | Domyślny limit czasu (ms) dla żądań JSON bez sygnału. undefined → awaria rdzenia (30 s). |
readonly onEvent?: (event: AuraObservabilityEvent) => void | Hak obserwowalności — patrz AuraClientOptions.onEvent. |
readonly debug?: boolean | Publikuj AuraObservabilityEvent przez console.debug — czytaj AuraClientOptions.debug. |
get auth(): AuthService | Usługa uwierzytelniania: rejestracja, połączenie, sesja, MFA, OAuth, tożsamości. |
get authAdmin(): AuthAdminService | API administrowania uwierzytelnianiem (użytkownicy, sesje, dziennik audytu, szablony wiadomości e-mail). |
get db(): DatabaseService<Database, Schema> | Usługa bazy danych: zapytania do tabel i widoków, wywołania funkcji SQL (rpc), surowy SQL. |
get storage(): StorageService | Usługa przechowywania: wiadra, wysyłanie, pobieranie, podpisane i publiczne adresy URL, transformacje obrazów. |
get realtime(): RealtimeService | Usługa w czasie rzeczywistym: kanały, zmiany Postgres, transmisja (broadcast) i obecność. |
get functions(): FunctionsService | Usługa Edge Functions: wywoływanie i zarządzanie zadaniami oraz cron za pomocą klucza service_role. |
get ai(): AiService | Usługa AI: konwersacja (chat), osadzanie, RAG (pozyskiwanie, zapytania, przestrzenie nazw), wyszukiwanie semantyczne i sesje. |
get notifications(): NotificationsService | Usługa powiadomień: wysyłanie (e-mail, SMS, push, webhook), historia, szablony i administracja. |
| Metoda | Opis |
|---|---|
dispose(): void | Odłącza klienta: zatrzymuje proaktywne odświeżanie (ticker + widoczność + BroadcastChannel), rozłącza w czasie rzeczywistym, opróżnia słuchacze uwierzytelniania. |
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> | Skrót: wykonaj zapytanie do tabeli lub widoku bazy danych (API zgodne z 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']> | Skrót: wywołaj procedurę składowaną / funkcję PostgreSQL poprzez RPC (API zgodne z Supabase). |
channel(name: string, options?: ChannelConfig): AuraChannel | Skrót: utwórz kanał czasu rzeczywistego za pomocą interfejsu API kompatybilnego z Supabase. |
removeChannel(channel: string | AuraChannel): void | Skrót: usuń kanał czasu rzeczywistego według nazwy lub instancji AuraChannel. |
removeAllChannels(): void | Skrót: usuń wszystkie kanały czasu rzeczywistego i anuluj subskrypcję. |
getChannels(): AuraChannel[] | Skrót: lista wszystkich aktywnych kanałów czasu rzeczywistego. |
Wygenerowana strona
Ta strona jest generowana na podstawie deklaracji typów i komentarzy pakietu SDK, więc nie może odbiegać od opublikowanego kodu. Aby poznać sprawdzone przykłady, przeczytaj przewodniki.
Ostatnia aktualizacja · 12 paź 2026