SDK JavaScript: funzioni

aura.functions è un FunctionsService. Non te lo costruisci quasi mai da solo.

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

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

Il pacchetto @aurabase/functions viene installato con @aurabase/aurabase-js. Installalo da solo solo se componi il tuo client da @aurabase/core. Richiede Node.js 20 o successivo e fornisce moduli ES e CommonJS con dichiarazioni di tipo.

Ogni metodo restituisce Promise<AuraResponse<T>>, un oggetto { data, error } che non lancia mai:

Prova data anziché error quando hai bisogno del valore: solo allora TypeScript sa che non è 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 è codificato nell'URL, quindi un valore contenente /, ? o # non può lasciare la sua posizione. Un nome che contenga tali caratteri semplicemente non viene trovato.

invoke aggiorna prima una sessione utente scaduta, invia JWT dell'utente quando ce n'è una e non ritenta mai una chiamata.

Come usarlo: Invoca una funzione. Come fallisce: Errori, timeout e tentativi.

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

Entrambi necessitano di una chiave service_role. get accetta il nome o l'id; se una funzione ha un nome simile a un ID, il nome vince. Un FunctionDef contiene il codice sorgente e le variabili della funzione, motivo per cui una chiave pubblica riceve 403.

Non esiste un metodo per distribuire, aggiornare o eliminare una funzione o per scrivere segreti: utilizzare API HTTP o 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 restituisce { code: 'bad_request', status: 400 } senza alcuna richiesta quando functionName è vuoto o contiene solo spazi e altrimenti taglia il nome.
• listJobs filtra su status (pending, running, completed, failed, dead) e restituisce tra 1 e 500 lavori, 50 per impostazione predefinita.
• Il tentativo di riprovare i lavori morti non ha metodo: vedere la coda di messaggi non recapitati.

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

schedule ha 5 o 6 campi, in UTC. deleteCronJob accetta il nome e restituisce 404 per un nome sconosciuto. Non esiste getCronJob o updateCronJob.

Esportato da @aurabase/aurabase-js e @aurabase/functions:

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

Entrambe le classi di errore estendono AuraError, quindi isAuraError(error) è vero. AuraError ha status, code, message, details, retryAfter e i getter isNotFound, isUnauthorized, isForbidden e isRateLimited.

Tipi di dati esportati da @aurabase/aurabase-js: