SDK ReferenceNode.js & WebFull API Reference

Node.js SDK — Full API Reference

Complete method listing for @aerostack/sdk.

sdk.db

MethodSignatureReturns
query(sql: string, params?: any[]) => Promise<{ results: T[] }>Array of rows
queryOne(sql: string, params?: any[]) => Promise<T | null>Single row or null
exec(sql: string) => Promise<void>Nothing
batch(stmts: { sql: string, params?: any[] }[]) => Promise<{ results: T[] }[]>Array of results

sdk.cache

MethodSignatureReturns
get(key: string) => Promise<T | null>Cached value or null
set(key: string, value: any, opts?: { ttl?: number, metadata?: any }) => Promise<void>Nothing
delete(key: string) => Promise<void>Nothing
has(key: string) => Promise<boolean>Boolean

sdk.storage

MethodSignatureReturns
upload(opts: { file: File | Blob, path?: string, contentType?: string }) => Promise<{ url, key, size, contentType }>Upload result
delete(key: string) => Promise<void>Nothing

sdk.ai

MethodSignatureReturns
complete(opts: { prompt, model?, maxTokens?, temperature?, system?, messages? }) => Promise<{ text, usage, finishReason }>Completion result
embed(text: string) => Promise<number[]>Embedding vector
streamCompletion(opts: { prompt, model?, maxTokens? }) => Promise<AsyncIterable<string>>Token stream

sdk.queue

MethodSignatureReturns
send(type: string, payload: any, opts?: { delaySeconds?, maxRetries? }) => Promise<void>Nothing

sdk.search

MethodSignatureReturns
query(vector: number[], opts: { table, limit?, threshold?, filter? }) => Promise<SearchResult[]>Similar items
upsert(id: string, vector: number[], metadata?: any) => Promise<void>Nothing
delete(id: string) => Promise<void>Nothing

sdk.socket

MethodSignatureReturns
emit(event: string, data: any, roomId: string) => voidNothing

sdk.secrets

MethodSignatureReturns
get(key: string) => Promise<string | null>Secret value or null

sdk.auth

MethodSignatureReturns
verifyToken(token: string) => Promise<User | null>User or null