index overview

Root API: simple, zero‑deps exports for resolving the libsqlite3 path. Resolves the correct .dylib/.so based on the current OS/arch.

Notes

• No runtime dependencies; uses process.platform / process.arch only.
• Musl is not supported in v1; an informative error is thrown with guidance.

Added in v0.0.0

Table of contents

• Types
  • Platform (type alias)
• utils
  • getLibSqlitePathSync
  • pathToLibSqlite

Types

Platform (type alias)

Supported platforms for this package.

Signature

export type Platform = "darwin-aarch64" | "darwin-x86_64" | "linux-x86_64" | "linux-aarch64"

Added in v0.0.0

utils

getLibSqlitePathSync

Get absolute path to libsqlite3 for a specific platform.

Signature

export declare function getLibSqlitePathSync(platform?: Platform): string

Example

import { getLibSqlitePathSync } from "@effect-native/libsqlite"
const p = getLibSqlitePathSync("darwin-x86_64")
console.log(p.endsWith("libsqlite3.dylib"))

Added in v0.0.0

pathToLibSqlite

Auto-detected absolute path to libsqlite3 for the current platform.

Signature

export declare const pathToLibSqlite: string

Example

import { pathToLibSqlite } from "@effect-native/libsqlite"
console.log(pathToLibSqlite.includes("libsqlite3")) // true

Added in v0.0.0