SDK JavaScript : fonctions

aura.functions est un FunctionsService. Vous ne le construisez presque jamais vous-même.

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

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

Le package @aurabase/functions est installé avec @aurabase/aurabase-js. Installez-le seul uniquement si vous composez votre propre client à partir de @aurabase/core. Il nécessite Node.js 20 ou version ultérieure et est livré avec des modules ES et CommonJS avec des déclarations de type.

Chaque méthode renvoie Promise<AuraResponse<T>>, un objet { data, error } qui ne renvoie jamais :

Testez data plutôt que error lorsque vous avez besoin de la valeur : ce n'est qu'alors que TypeScript sait que ce n'est pas 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 est codé dans l'URL, donc une valeur contenant /, ? ou # ne peut pas quitter sa position. Un nom contenant de tels caractères est tout simplement introuvable.

invoke actualise d'abord une session utilisateur expirée, envoie le JWT de l'utilisateur lorsqu'il y en a un et ne réessaye jamais d'appel.

Comment l'utiliser : Invoque une fonction. Comment cela échoue : Erreurs, délais d'attente et tentatives.

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

Les deux nécessitent une clé service_role. get accepte le nom ou l'identifiant ; si une fonction est nommée comme un identifiant, le nom l'emporte. Un FunctionDef contient le code source et les variables de la fonction, c'est pourquoi une clé publique reçoit 403.

Il n'existe aucune méthode pour déployer, mettre à jour ou supprimer une fonction, ou pour écrire des secrets : utilisez l'API HTTP ou la 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 renvoie { code: 'bad_request', status: 400 } sans aucune demande lorsque functionName est vide ou uniquement des espaces, et coupe le nom dans le cas contraire.
• listJobs filtre sur status (pending, running, completed, failed, dead) et renvoie entre 1 et 500 tâches, 50 par défaut.
• Il n'existe aucune méthode pour réessayer des tâches mortes : consultez la file d'attente de lettres mortes .

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

schedule a 5 ou 6 champs, en UTC. deleteCronJob prend le nom et renvoie 404 pour un nom inconnu. Il n'y a pas de getCronJob ou updateCronJob.

Exporté par @aurabase/aurabase-js et @aurabase/functions:

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

Les deux classes d'erreur s'étendent AuraError, donc isAuraError(error) est vrai. AuraError a status, code, message, details, retryAfter et les getters isNotFound, isUnauthorized, isForbidden et isRateLimited.

Types de données, exportés par @aurabase/aurabase-js: