JavaScript SDK'sı: işlevler

aura.functions bir FunctionsService'dir. Neredeyse hiçbir zaman kendin inşa etmiyorsun.

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

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

@aurabase/functions paketi @aurabase/aurabase-js ile yüklenir. Yalnızca kendi istemcinizi @aurabase/core adresinden oluşturuyorsanız tek başına yükleyin. Node.js 20 veya üstünü gerektirir ve ES modüllerini ve CommonJS'yi tür bildirimleriyle birlikte gönderir.

Her yöntem, hiçbir zaman atmayan bir { data, error } nesnesi olan Promise<AuraResponse<T>> değerini döndürür:

Değere ihtiyacınız olduğunda data yerine error test edin: ancak o zaman TypeScript bunun null olmadığını bilir.

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'de kodlanmıştır, dolayısıyla /, ? veya # içeren bir değer konumundan ayrılamaz. Bu tür karakterleri içeren bir ad bulunamıyor.

invoke önce süresi dolmuş kullanıcı oturumunu yeniler, varsa kullanıcıya JWT gönderir ve bir daha asla arama yapmayı denemez.

Nasıl kullanılır: Bir işlevi çağırın. Nasıl başarısız olur: Hatalar, zaman aşımları ve yeniden denemeler.

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

Her ikisinin de service_role anahtarına ihtiyacı var. get, adını veya kimliğini kabul eder; bir işlev bir kimlik gibi adlandırılırsa ad kazanır. Bir FunctionDef işlevin kaynak kodunu ve değişkenlerini içerir; bu nedenle genel anahtar 403 alır.

Bir işlevi dağıtmak, güncellemek veya silmek ya da gizli diziler yazmak için herhangi bir yöntem yoktur: HTTP API veya CLI kullanın.

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 boş olduğunda veya yalnızca boşluk olduğunda herhangi bir istek olmadan { code: 'bad_request', status: 400 } değerini döndürür ve aksi takdirde adı kısaltır.
• listJobs, status (pending, running, completed, failed, dead) üzerinde filtre uygular ve varsayılan olarak 50 olmak üzere 1 ile 500 arasında iş döndürür.
• Ölen işleri yeniden denemenin bir yöntemi yoktur: atılacak iletiler kuyruğuna bakın.

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'de 5 veya 6 alana sahiptir. deleteCronJob, adını alır ve bilinmeyen bir ad için 404 değerini döndürür. getCronJob veya updateCronJob yok.

@aurabase/aurabase-js ve @aurabase/functions tarafından dışa aktarıldı:

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

Her iki hata sınıfı da AuraError öğesini genişletir, dolayısıyla isAuraError(error) doğrudur. AuraError, status, code, message, details, retryAfter ve isNotFound, isUnauthorized, isForbidden ve isRateLimited alıcılarına sahiptir.

@aurabase/aurabase-js tarafından dışa aktarılan veri türleri: