JavaScript SDK: functies

aura.functions is een FunctionsService. Je bouwt het bijna nooit zelf.

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

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

Het pakket @aurabase/functions wordt geïnstalleerd met @aurabase/aurabase-js. Installeer het alleen alleen als u uw eigen client samenstelt vanuit @aurabase/core. Het vereist Node.js 20 of hoger en levert ES-modules en CommonJS met typeverklaringen.

Elke methode retourneert Promise<AuraResponse<T>>, een object { data, error } dat nooit gooit:

Test data in plaats van error wanneer u de waarde nodig heeft: alleen dan weet TypeScript dat het niet null is.

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 is gecodeerd in de URL, dus een waarde die /, ? of # bevat, kan zijn positie niet verlaten. Een naam die dergelijke tekens bevat, wordt eenvoudigweg niet gevonden.

invoke vernieuwt eerst een verlopen gebruikerssessie, verzendt de JWT van de gebruiker wanneer die er is, en probeert nooit opnieuw te bellen.

Zo gebruikt u het: Roep een functie op. Hoe het mislukt: Fouten, time-outs en nieuwe pogingen.

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

Beide hebben een service_role-sleutel nodig. get accepteert de naam of de id; als een functie een naam heeft als een id, wint de naam. Een FunctionDef bevat de broncode en de variabelen van de functie, daarom ontvangt een publieke sleutel 403.

Er is geen methode om een functie te implementeren, bij te werken of te verwijderen, of om geheimen te schrijven: gebruik de HTTP API of de 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 retourneert { code: 'bad_request', status: 400 } zonder enig verzoek wanneer functionName leeg is of alleen spaties bevat, en anders wordt de naam ingekort.
• listJobs filtert op status (pending, running, completed, failed, dead) en retourneert tussen 1 en 500 taken, standaard 50.
• Het opnieuw proberen van dode opdrachten heeft geen methode: zie de wachtrij voor dode letters.

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

schedule heeft 5 of 6 velden, in UTC. deleteCronJob neemt de naam en retourneert 404 voor een onbekende naam. Er is geen getCronJob of updateCronJob.

Geëxporteerd door @aurabase/aurabase-js en @aurabase/functions:

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

Beide foutklassen breiden AuraError uit, dus isAuraError(error) is waar. AuraError heeft status, code, message, details, retryAfter en de getters isNotFound, isUnauthorized, isForbidden en isRateLimited.

Gegevenstypen, geëxporteerd door @aurabase/aurabase-js: