İçeriğe geç
Aurabase Logosu
aura tabanı

JavaScript SDK'sı

@aurabase/aurabase-js — Node, Bun, Deno, Next.js, React, SvelteKit, Vue için yazılan istemci. Veritabanı, Kimlik Doğrulama, Gerçek Zamanlı, Depolama ve İşlevleri kapsar.

Referans10 dk. okuSeviye referans15 Nis 2026 tarihinde revize edildi

Bu sayfa otomatik olarak çevrildi. İngilizce versiyonu yetkilidir.

Bir paket, dört yönetici#

terminalbash
pnpm add @aurabase/aurabase-js
İpucu

SDK, oturum çerezlerinin otomatik yönetimi ve kesilme önleyici yığınlama ile Next.js (Uygulama Yönlendiricisi, Sunucu Eylemleri, Ara Yazılım), Remix, Nuxt ve SvelteKit için doğrudan @aurabase/aurabase-js/ssr dışa aktarımını içerir.

İstemciyi oluştur#

src/lib/aurabase.tstypescript
import { createClient } from '@aurabase/aurabase-js'
import type { Database } from './aurabase.types'

export const aura = createClient<Database>(
  process.env.NEXT_PUBLIC_AURABASE_URL!,
  process.env.NEXT_PUBLIC_AURABASE_ANON_KEY!,
  { auth: { persistSession: true } }
)

Yerel Sunucu Tarafı İşleme desteği#

SSR mimarileri için (Next.js Uygulama Yönlendiricisi, Ara Yazılım, Sunucu Eylemleri, SvelteKit), createServerClient öğesini @aurabase/aurabase-js/ssr öğesinden içe aktarın. Kullanıcı oturumu, büyük belirteçler için çoklu parça desteğiyle otomatik olarak güvenli httpOnly çerezlerinde saklanır:

src/middleware.tstypescript
import { createServerClient } from '@aurabase/aurabase-js/ssr'
import { NextResponse, type NextRequest } from 'next/server'

export async function middleware(request: NextRequest) {
  let response = NextResponse.next({ request })
  const aura = createServerClient(
    process.env.NEXT_PUBLIC_AURABASE_URL!,
    process.env.NEXT_PUBLIC_AURABASE_ANON_KEY!,
    {
      cookies: {
        getAll() { return request.cookies.getAll() },
        setAll(cookies) {
          cookies.forEach(({ name, value, options }) => {
            request.cookies.set(name, value)
            response.cookies.set(name, value, options)
          })
        },
      },
    })
  await aura.auth.getSession()
  return response
}

Şemanızdan Codegen#

npx @aurabase/gen --out lib/aurabase.types.ts (veya geçerli klasöre types.ts yazan aura db generate), şemanızın tamamından (tablolar, görünümler, numaralandırmalar, RPC işlevleri) türler dosyasını oluşturur. Tüm sorgularınızı yazmak üzere createClient<Database>'e bağlanmak için.

package.jsonjson
{
  "scripts": {
    "types:gen": "npx @aurabase/gen --out src/aurabase.types.ts",
    "migrate": "aura db push && pnpm types:gen"
  }
}

Hizmete göre#

Veritabanı

  • .from(table).select(cols?) → SelectBuilder<T>
  • .from(table).insert(row) → Promise<{ data, error }>
  • .from(table).update(patch) → UpdateBuilder<T>
  • .from(table).delete() → DeleteBuilder<T>
  • .rpc(fn, args) → Promise<{ data, error }>
  • .nosql.collection(name) → NoSqlCollectionClient (find(), insertOne(), aggregate(), createIndex())

Yetki

  • .auth.signUp({ email, password, options? }) → Promise<AuraResponse<LoginResponse>>
  • .auth.signInWithPassword({ email, password }) → Promise<AuraResponse<LoginResponse>>
  • .auth.signInWithOAuth(provider, opts?) | ({ provider, ... }) → Promise<AuraResponse<{ url }>>
  • .auth.getSession() → Promise<{ data: { session }, error }>
  • .auth.signOut() → Promise<AuraResponse<void>>
  • .auth.mfa.enroll() | .auth.mfaEnroll() → Promise<AuraResponse<MfaEnrollResponse>>

Gerçek zamanlı

  • .channel(name, config?) → Channel
  • channel.on(event, filter, cb) → Channel
  • channel.subscribe() → Channel
  • channel.send({ type, event, payload }) → Promise<void>
  • channel.unsubscribe() → Promise<void>

Depolama

  • .storage.from(bucket).upload(path, file, opts?) → Promise<{ data, error }>
  • .storage.from(bucket).download(path) → Promise<Blob>
  • .storage.from(bucket).getPublicUrl(path, opts?) → { publicUrl }
  • .storage.from(bucket).createSignedUrl(path, expiresIn) → Promise<{ signedUrl }>
  • .storage.from(bucket).remove(paths[]) → Promise<{ data, error }>

Fonksiyonlar

  • .functions.invoke(name, { body?, method?, path?, headers?, responseType?, signal?, timeout? }) → Promise<{ data, error }>
  • .functions.list() → Promise<{ data: FunctionDef[], error }>
  • .functions.get(nameOrId) → Promise<{ data: FunctionDef, error }>
  • .functions.listJobs({ status?, limit? }) → Promise<{ data: Job[], error }>
  • .functions.getJob(jobId) → Promise<{ data: Job, error }>
  • .functions.enqueueJob(functionName, { payload?, delaySecs?, maxAttempts? }) → Promise<{ data: Job, error }>
  • .functions.listCronJobs() → Promise<{ data: CronJob[], error }>
  • .functions.createCronJob(name, schedule, functionName, { payload? }) → Promise<{ data: CronJob, error }>
  • .functions.deleteCronJob(name) → Promise<{ data, error }>

Yalnızca invoke genel (anon) anahtarına açıktır. list, get, listJobs, getJob, enqueueJob, listCronJobs, createCronJob ve deleteCronJob bir service_role anahtarı gerektirir ve sunucunuza aittir: FunctionDef işlevin kaynak kodunu ve ortam değişkenlerini taşır, dolayısıyla bu çağrılar 403 ile ortak anahtara yanıt verir. invoke hataları FunctionsHttpError (işlev bir hatayla yanıt verdi, herhangi bir durum) veya FunctionsRelayError (platform başarısız oldu: ağ, 502, 503, 504) olarak bildirir; her ikisi de @aurabase/aurabase-js tarafından dışa aktarılır.

Tek biçimli şekil { veri, hata }#

Her zaman uyumsuz yöntem { data, error } değerini döndürür. error başarı durumunda null olur, aksi takdirde code, message, status ve details ile bir AuraError örneği (ayrıca AurabaseError takma adı altında dışa aktarılır). Şemanız Number.MAX_SAFE_INTEGER ötesinde 64 bit bigint değerleri kullanıyorsa, createClient seçeneklerinde { parseBigIntAsString: true } iletin.

errors.tstypescript
import { AurabaseError } from '@aurabase/aurabase-js'

const { data, error } = await aura.from('users').select('*').single()

if (error) {
  if (error.code === 'PGRST116') notFound()
  throw error // AuraError / AurabaseError örneği
}

Daha ileri gitmek için#