JavaScript SDK: Funktionen

aura.functions ist ein FunctionsService. Man baut es fast nie selbst.

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

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

Das Paket @aurabase/functions wird mit @aurabase/aurabase-js installiert. Installieren Sie es nur dann alleine, wenn Sie Ihren eigenen Client aus @aurabase/core erstellen. Es erfordert Node.js 20 oder höher und liefert ES-Module und CommonJS mit Typdeklarationen.

Jede Methode gibt Promise<AuraResponse<T>> zurück, ein Objekt { data, error }, das niemals Folgendes auslöst:

Testen Sie data anstelle von error, wenn Sie den Wert benötigen: Nur dann weiß TypeScript, dass es sich nicht um null handelt.

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 ist in der URL codiert, sodass ein Wert, der /, ? oder # enthält, seine Position nicht verlassen kann. Ein Name, der solche Zeichen enthält, wird einfach nicht gefunden.

invoke aktualisiert zuerst eine abgelaufene Benutzersitzung, sendet das JWT des Benutzers, wenn es eine gibt, und wiederholt nie einen Anruf.

So verwenden Sie es: Rufen Sie eine Funktion auf. Wie es fehlschlägt: Fehler, Zeitüberschreitungen und Wiederholungsversuche.

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

Beide benötigen einen service_role-Schlüssel. get akzeptiert den -Namen oder die -ID; Wenn eine Funktion wie eine ID benannt wird, gewinnt der Name. Ein FunctionDef enthält den Quellcode und die Variablen der Funktion, weshalb ein öffentlicher Schlüssel 403 erhält.

Es gibt keine Methode zum Bereitstellen, Aktualisieren oder Löschen einer Funktion oder zum Schreiben von Geheimnissen: Verwenden Sie die HTTP-API oder die 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 gibt { code: 'bad_request', status: 400 } ohne Anfrage zurück, wenn functionName leer ist oder nur Leerzeichen enthält, und kürzt den Namen andernfalls.
• listJobs filtert nach status (pending, running, completed, failed, dead) und gibt zwischen 1 und 500 Jobs zurück, standardmäßig 50.
• Das Wiederholen abgebrochener Jobs hat keine Methode: Siehe Warteschlange für unzustellbare Nachrichten.

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

schedule hat 5 oder 6 Felder in UTC. deleteCronJob nimmt den -Namen an und gibt 404 für einen unbekannten Namen zurück. Es gibt kein getCronJob oder updateCronJob.

Exportiert von @aurabase/aurabase-js und @aurabase/functions:

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

Beide Fehlerklassen erweitern AuraError, sodass isAuraError(error) wahr ist. AuraError hat status, code, message, details, retryAfter und die Getter isNotFound, isUnauthorized, isForbidden und isRateLimited.

Datentypen, exportiert von @aurabase/aurabase-js: