Skip to main content Link Search Menu Expand Document (external link)

Client overview

Added in v1.0.0


Table of contents


constructor

make

Signature

export declare const make: (options: SqliteClientConfig) => Effect.Effect<SqliteClient, never, Scope.Scope>

Added in v1.0.0

layers

layer

Signature

export declare const layer: (config: Config.Config.Wrap<SqliteClientConfig>) => Layer.Layer<any, ConfigError>

Added in v1.0.0

models

SqliteClient (interface)

Signature

export interface SqliteClient extends Client.Client {
  readonly [TypeId]: TypeId
  readonly config: SqliteClientConfig
  readonly export: Effect.Effect<Uint8Array, SqlError>

  /** Not supported in sqlite */
  readonly updateValues: never
}

Added in v1.0.0

SqliteClientConfig (type alias)

Signature

export type SqliteClientConfig =
  | {
      readonly mode?: "vfs"
      readonly dbName?: string
      readonly openMode?: OpenMode
      readonly transformResultNames?: (str: string) => string
      readonly transformQueryNames?: (str: string) => string
    }
  | {
      readonly mode: "opfs"
      readonly dbName: string
      readonly openMode?: OpenMode
      readonly transformResultNames?: (str: string) => string
      readonly transformQueryNames?: (str: string) => string
    }

Added in v1.0.0

tags

SqliteClient

Signature

export declare const SqliteClient: any

Added in v1.0.0

type ids

TypeId

Signature

export declare const TypeId: typeof TypeId

Added in v1.0.0

TypeId (type alias)

Signature

export type TypeId = typeof TypeId

Added in v1.0.0