Клиент и услуги
Точка входа в SDK: как создать клиент и какие сервисы он предоставляет.
6 мин читать·Уровень ссылка·Пересмотрено 12 окт. 2026 г.
Этот текст на английском языке был создан автоматически на основе французского оригинала и еще не проверялся.
Эта страница была переведена автоматически. Английская версия является авторитетной.
#
Функции
Экспортированные функции
| Функция | Описание |
|---|---|
function createClient<Database = any>(baseUrl: string, apiKey: string, options?: AuraClientOptions): AuraClient<Database> | Создайте новый экземпляр клиента Aurabase. |
function createAdminClient<Database = any>(baseUrl: string, serviceRoleKey: string, options?: AuraClientOptions): AuraClient<Database> | Создает клиент для SERVER, использует только для операций администрирования (client.authAdmin: список/создание/запрет пользователей, чтение аудита). |
#
Сорт
АураКлиент
Основной клиент Aurabase.
| Свойство | Описание |
|---|---|
readonly baseUrl: string | URL-адрес проекта (https://<slug>.aurabase.cloud) без завершающей черты. |
readonly apiKey: string | null | Ключ API проекта (anon или service_role), отправленный в заголовке apikey; null, если ничего не было указано. |
readonly fetchFn: typeof globalThis.fetch | Функция fetch используется для всех запросов (для options.fetch, в противном случае для globalThis.fetch). |
readonly authStore: BaseAuthStore | Хранилище сеансов (токен доступа, токен обновления, пользователь): память, localStorage или файлы cookie в зависимости от контекста. |
readonly retryConfig: { enabled: boolean; maxRetries: number; } | Чтение политики возобновления запроса (GET, HEAD) при временной ошибке: включено или нет, а также максимальное количество возобновлений. |
readonly requestTimeoutMs?: number | Тайм-аут по умолчанию (мс) для запросов JSON без сигнала. undefined → ошибка ядра (30 с). |
readonly onEvent?: (event: AuraObservabilityEvent) => void | Хук наблюдаемости — см. AuraClientOptions.onEvent. |
readonly debug?: boolean | Вести журнал AuraObservabilityEvent через console.debug — voir AuraClientOptions.debug. |
get auth(): AuthService | Служба аутентификации: регистрация, подключение, сеанс, MFA, OAuth, удостоверения. |
get authAdmin(): AuthAdminService | API администрирования аутентификации (пользователи, сеансы, журнал аудита, шаблоны электронной почты). |
get db(): DatabaseService<Database, Schema> | Служба базы данных: запросы к таблицам и представлениям, вызовы функций SQL (rpc), необработанный SQL. |
get storage(): StorageService | Служба хранения: корзины, отправка, загрузка, подписанные и общедоступные URL-адреса, преобразование изображений. |
get realtime(): RealtimeService | Сервис в реальном времени: каналы, изменения Postgres, трансляция (broadcast) и присутствие. |
get functions(): FunctionsService | Сервис Edge Functions: вызов и управление заданиями и cron с помощью ключа service_role. |
get ai(): AiService | Служба AI: разговор (chat), встраивания, RAG (захват, запросы, пространства имен), семантический поиск и сеансы. |
get notifications(): NotificationsService | Служба уведомлений: отправка (электронная почта, SMS, push, вебхук), история, шаблоны и администрирование. |
| Метод | Описание |
|---|---|
dispose(): void | Отключает клиент: останавливает упреждающее обновление (тикер + видимость + BroadcastChannel), отключает режим реального времени, очищает прослушиватели аутентификации. |
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> | Ярлык: запросить таблицу или представление базы данных (API, совместимый с 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']> | Ярлык: вызов хранимой процедуры/функции PostgreSQL через RPC (API, совместимый с Supabase). |
channel(name: string, options?: ChannelConfig): AuraChannel | Ярлык: создайте канал реального времени с API-интерфейсом, совместимым с Supabase. |
removeChannel(channel: string | AuraChannel): void | Ярлык: удалите канал реального времени по имени или экземпляру AuraChannel. |
removeAllChannels(): void | Ярлык: удалить все каналы реального времени и отказаться от подписки. |
getChannels(): AuraChannel[] | Ярлык: список всех активных каналов реального времени. |
Сгенерированная страница
Эта страница создается на основе объявлений типов и комментариев SDK, поэтому она не может отличаться от опубликованного кода. Рабочие примеры можно найти в руководствах.
Последнее обновление · 12 окт. 2026 г.