JavaScript SDK: функции

aura.functions — это FunctionsService. Вы почти никогда не строите его самостоятельно.

import { createClient } from '@aurabase/aurabase-js'

const aura = createClient('https://my-app.aurabase.cloud', 'aura_anon_…')
aura.functions.invoke('hello')

Пакет @aurabase/functions устанавливается вместе с @aurabase/aurabase-js. Установите его отдельно, только если вы создадите свой собственный клиент из @aurabase/core. Для него требуется Node.js 20 или новее, а модули ES и CommonJS поставляются с объявлениями типов.

Каждый метод возвращает Promise<AuraResponse<T>>, объект { data, error }, который никогда не выдает:

Проверяйте data вместо error, когда вам нужно значение: только тогда TypeScript узнает, что это не null.

invoke<T = unknown>(
  name: string,
  options?: {
    body?: unknown
    method?: string
    path?: string
    headers?: Record<string, string>
    signal?: AbortSignal
    timeout?: number
    responseType?: 'json' | 'text' | 'blob' | 'arrayBuffer'
  },
): Promise<AuraResponse<T>>

name закодирован в URL-адресе, поэтому значение, содержащее /, ? или #, не может покинуть свою позицию. Имя, содержащее такие символы, просто не встречается.

invoke сначала обновляет истекший сеанс пользователя, отправляет JWT пользователя, если он есть, и никогда не повторяет вызов.

Как это использовать: Вызовите функцию. Причины сбоя: Ошибки, тайм-ауты и повторные попытки.

list(): Promise<AuraResponse<FunctionDef[]>>
get(nameOrId: string): Promise<AuraResponse<FunctionDef>>

Обоим нужен ключ service_role. get принимает имя или идентификатор ; если функция названа как идентификатор, имя выигрывает. FunctionDef содержит исходный код и переменные функции, поэтому открытый ключ получает 403.

Не существует способа развернуть, обновить или удалить функцию или записать секреты: используйте HTTP API или CLI.

enqueueJob(
  functionName: string,
  options?: { payload?: unknown; delaySecs?: number; maxAttempts?: number },
): Promise<AuraResponse<Job>>

listJobs(options?: { status?: string; limit?: number }): Promise<AuraResponse<Job[]>>
getJob(jobId: string): Promise<AuraResponse<Job>>

• enqueueJob возвращает { code: 'bad_request', status: 400 } без какого-либо запроса, если functionName пусто или содержит только пробелы, в противном случае имя обрезается.
• listJobs фильтрует status (pending, running, completed, failed, dead) и возвращает от 1 до 500 заданий, 50 по умолчанию.
• Повторная попытка невыполненных заданий не имеет метода: см. очередь недоставленных сообщений .

listCronJobs(): Promise<AuraResponse<CronJob[]>>
createCronJob(
  name: string,
  schedule: string,
  functionName: string,
  options?: { payload?: unknown },
): Promise<AuraResponse<CronJob>>
deleteCronJob(name: string): Promise<AuraResponse<null>>

schedule имеет 5 или 6 полей в формате UTC. deleteCronJob принимает имя и возвращает 404 для неизвестного имени. Не существует getCronJob или updateCronJob.

Экспортировано @aurabase/aurabase-js и @aurabase/functions:

import {
  FunctionsHttpError,
  FunctionsRelayError,
  isRelayStatus,
  type FunctionsResponseType,
} from '@aurabase/aurabase-js'

Оба класса ошибок расширяют AuraError, поэтому isAuraError(error) истинно. AuraError имеет status, code, message, details, retryAfter и геттеры isNotFound, isUnauthorized, isForbidden и isRateLimited.

Типы данных, экспортируемые @aurabase/aurabase-js: