JavaScript SDK:関数

aura.functions は FunctionsServiceです。自分で構築することはほとんどありません。

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

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

パッケージ @aurabase/functions は @aurabase/aurabase-jsとともにインストールされます。 @aurabase/coreから独自のクライアントを作成する場合にのみ、単独でインストールしてください。 Node.js 20 以降が必要で、ES モジュールと CommonJS が型宣言とともに同梱されます。

すべてのメソッドは Promise<AuraResponse<T>>を返します。これは、決してスローされないオブジェクト { data, error } です。

値が必要な場合は、 error ではなく data をテストします。そのとき初めて、 TypeScript は、それが 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 は URL 内でエンコードされているため、 /、 ? または # を含む値はその位置を離れることはできません。そのような文字を含む名前は単純に見つかりません。

invoke は、最初に期限切れのユーザー セッションを更新し、ユーザーの JWT があればそれを送信し、呼び出しを再試行しません。

使用方法: 関数を呼び出します。失敗の仕組み: エラー、タイムアウト、および再試行。

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

どちらも service_role キーが必要です。 get は名前または ID を受け入れます。関数に ID のような名前が付けられている場合は、名前が優先されます。 FunctionDef には、関数のソース コードと変数が含まれているため、公開キーは 403を受け取ります。

関数をデプロイ、更新、削除したり、シークレットを書き込んだりする方法はありません。 HTTP API または 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 は、functionName が空またはスペースのみの場合はリクエストなしで { code: 'bad_request', status: 400 } を返し、それ以外の場合は名前をトリミングします。
• listJobs は status (pending、 running、 completed、 failed、 dead) でフィルターし、1 ～ 500 のジョブ (デフォルトでは 50) を返します。
• デッド ジョブを再試行する方法はありません。 デッドレター キューを参照してください。

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

schedule には、UTC で 5 つまたは 6 つのフィールドがあります。 deleteCronJob は名前を受け取り、不明な名前の場合は 404 を返します。 getCronJob または updateCronJobはありません。

@aurabase/aurabase-js および @aurabase/functionsによってエクスポート:

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

どちらのエラー クラスも AuraErrorを拡張しているため、 isAuraError(error) は true です。 AuraError には、 status、 code、 message、 details、 retryAfter、およびゲッター isNotFound、 isUnauthorized、 isForbidden 、 isRateLimitedがあります。

@aurabase/aurabase-jsによってエクスポートされるデータ型: