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를 제공합니다.

모든 메소드는 다음을 발생시키지 않는 객체 { data, error }인 Promise<AuraResponse<T>>를 반환합니다.

값이 필요할 때 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에서 내보낸 데이터 유형: