JavaScript SDK: funkcje

aura.functions to FunctionsService. Prawie nigdy nie budujesz go sam.

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

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

Pakiet @aurabase/functions jest instalowany z @aurabase/aurabase-js. Zainstaluj go samodzielnie tylko wtedy, gdy utworzysz własnego klienta z @aurabase/core. Wymaga Node.js 20 lub nowszego i dostarcza moduły ES i CommonJS z deklaracjami typów.

Każda metoda zwraca Promise<AuraResponse<T>>, obiekt { data, error }, który nigdy nie generuje:

Jeśli potrzebujesz wartości, przetestuj data zamiast error: tylko wtedy TypeScript będzie wiedział, że to nie jest 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 jest zakodowany w adresie URL, więc wartość zawierająca /, ? lub # nie może opuścić swojej pozycji. Nazwa zawierająca takie znaki po prostu nie została znaleziona.

invoke najpierw odświeża wygasłą sesję użytkownika, wysyła użytkownikowi JWT, jeśli taka istnieje, i nigdy nie ponawia próby połączenia.

Jak z tego skorzystać: Wywołaj funkcję. Jak to się nie powiedzie: Błędy, przekroczenia limitu czasu i ponowne próby.

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

Obydwa wymagają klucza service_role. get akceptuje nazwę lub identyfikator ; jeśli funkcja ma nazwę taką jak identyfikator, wygrywa nazwa. FunctionDef zawiera kod źródłowy i zmienne funkcji, dlatego klucz publiczny otrzymuje 403.

Nie ma metody wdrażania, aktualizowania lub usuwania funkcji lub zapisywania kluczy tajnych: użyj HTTP API lub 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 zwraca { code: 'bad_request', status: 400 } bez żadnego żądania, gdy functionName jest puste lub zawiera tylko spacje, w przeciwnym razie obcina nazwę.
• listJobs filtruje status (pending, running, completed, failed, dead) i zwraca od 1 do 500 zadań, domyślnie 50.
• Ponawianie martwych zadań nie ma żadnej metody: zobacz kolejkę utraconych wiadomości.

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

schedule ma 5 lub 6 pól w formacie UTC. deleteCronJob przyjmuje nazwę i zwraca 404 dla nieznanej nazwy. Nie ma getCronJob ani updateCronJob.

Eksportowane przez @aurabase/aurabase-js i @aurabase/functions:

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

Obie klasy błędów rozszerzają AuraError, więc isAuraError(error) ma wartość true. AuraError ma status, code, message, details, retryAfter i gettery isNotFound, isUnauthorized, isForbidden i isRateLimited.

Typy danych eksportowane przez @aurabase/aurabase-js: