Interface SpinSdk

Deprecated

Hierarchy

  • SpinSdk

Properties

Router: (() => routerType)

Type declaration

config: SpinConfig
kv: {
    open: ((name: string) => KvStore);
    openDefault: (() => KvStore);
}

Object that allows access to the Spin Key-Value Store

Type declaration

  • open: ((name: string) => KvStore)
      • (name: string): KvStore
      • Returns

        A KV store handle

        Parameters

        • name: string

          The name of the KV store to open

        Returns KvStore

  • openDefault: (() => KvStore)
      • (): KvStore
      • Returns

        The handle to the default KV store

        Returns KvStore

llm: {
    generateEmbeddings: ((model: string, sentences: string[]) => EmbeddingResult);
    infer: ((model: string, prompt: string) => InferenceResult);
    inferWithOptions: ((model: string, prompt: string, options: InternalInferencingOptions) => InferenceResult);
}

Type declaration

mysql: {
    execute: ((address: string, statement: string, params: RdbmsParam[]) => void);
    query: ((address: string, statement: string, params: RdbmsParam[]) => RdbmsReturn);
}

Type declaration

pg: {
    execute: ((address: string, statement: string, params: RdbmsParam[]) => void);
    query: ((address: string, statement: string, params: RdbmsParam[]) => RdbmsReturn);
}

Type declaration

redis: {
    del: ((address: string, key: string[]) => bigint);
    execute: ((address: string, command: string, args: (bigint | ArrayBuffer)[]) => undefined | string | bigint | ArrayBuffer);
    get: ((address: string, key: string) => ArrayBuffer);
    incr: ((address: string, key: string) => bigint);
    publish: ((address: string, channel: string, value: ArrayBuffer) => undefined);
    sadd: ((address: string, key: string, values: string[]) => bigint);
    set: ((address: string, key: string, value: ArrayBuffer) => undefined);
    smembers: ((address: string, key: string) => string[]);
    srem: ((address: string, key: string, values: string[]) => bigint);
}

Type declaration

  • del: ((address: string, key: string[]) => bigint)
      • (address: string, key: string[]): bigint
      • Parameters

        • address: string
        • key: string[]

        Returns bigint

  • execute: ((address: string, command: string, args: (bigint | ArrayBuffer)[]) => undefined | string | bigint | ArrayBuffer)
      • (address: string, command: string, args: (bigint | ArrayBuffer)[]): undefined | string | bigint | ArrayBuffer
      • Parameters

        • address: string
        • command: string
        • args: (bigint | ArrayBuffer)[]

        Returns undefined | string | bigint | ArrayBuffer

  • get: ((address: string, key: string) => ArrayBuffer)
      • (address: string, key: string): ArrayBuffer
      • Parameters

        • address: string
        • key: string

        Returns ArrayBuffer

  • incr: ((address: string, key: string) => bigint)
      • (address: string, key: string): bigint
      • Parameters

        • address: string
        • key: string

        Returns bigint

  • publish: ((address: string, channel: string, value: ArrayBuffer) => undefined)
      • (address: string, channel: string, value: ArrayBuffer): undefined
      • Parameters

        • address: string
        • channel: string
        • value: ArrayBuffer

        Returns undefined

  • sadd: ((address: string, key: string, values: string[]) => bigint)
      • (address: string, key: string, values: string[]): bigint
      • Parameters

        • address: string
        • key: string
        • values: string[]

        Returns bigint

  • set: ((address: string, key: string, value: ArrayBuffer) => undefined)
      • (address: string, key: string, value: ArrayBuffer): undefined
      • Parameters

        • address: string
        • key: string
        • value: ArrayBuffer

        Returns undefined

  • smembers: ((address: string, key: string) => string[])
      • (address: string, key: string): string[]
      • Parameters

        • address: string
        • key: string

        Returns string[]

  • srem: ((address: string, key: string, values: string[]) => bigint)
      • (address: string, key: string, values: string[]): bigint
      • Parameters

        • address: string
        • key: string
        • values: string[]

        Returns bigint

sqlite: {
    open: ((name: string) => SqliteStore);
    openDefault: (() => SqliteStore);
}

Type declaration

utils: {
    toBuffer: ((arg0: ArrayBufferView) => Buffer);
}

Type declaration

  • toBuffer: ((arg0: ArrayBufferView) => Buffer)
      • (arg0: ArrayBufferView): Buffer
      • Parameters

        • arg0: ArrayBufferView

        Returns Buffer

Generated using TypeDoc