1. API reference
  2. @samveys/libsql

@samveys/libsql

libSQL / Turso driver (sqld over HTTP, SQLite dialect)

Version
1.0.2Nov 5, 2026
Install
pnpm add @samveys/libsql
Import 
import { libsql, libsqlDialect, libsqlDriver } from '@samveys/libsql'

Function (1)

libsql Function

A libSQL connection config: `libsql({ url: 'http://127.0.0.1:8080' })`.

function libsql(options: LibsqlOptions): ConnectionConfig<LibsqlOptions>;

Exported from packages/libsql/src/index.ts

Value (2)

libsqlDialect Value

libSQL speaks SQLite's SQL, so it reuses the SQLite dialect unchanged.

const libsqlDialect: Dialect;

Exported from packages/libsql/src/index.ts

libsqlDriver Value

The libSQL driver. `@libsql/client` is imported on first connect.

const libsqlDriver: DatabaseDriver<LibsqlOptions>;

Exported from packages/libsql/src/index.ts

Interface (1)

LibsqlOptions Interface

No documentation comment.

interface LibsqlOptions {
    /** `http://`, `https://`, `libsql://` (Turso) or `ws://` URL of a libSQL server (sqld). */
    readonly url: string;
    /** Turso / sqld JWT. */
    readonly authToken?: string;
}

Exported from packages/libsql/src/index.ts