driver.d.cts 1.2 KB

1234567891011121314151617181920212223242526272829
  1. import { type Database, type Options, type RunResult } from 'better-sqlite3';
  2. import { entityKind } from "../entity.cjs";
  3. import { BaseSQLiteDatabase } from "../sqlite-core/db.cjs";
  4. import { type DrizzleConfig } from "../utils.cjs";
  5. export type DrizzleBetterSQLite3DatabaseConfig = ({
  6. source?: string | Buffer;
  7. } & Options) | string | undefined;
  8. export declare class BetterSQLite3Database<TSchema extends Record<string, unknown> = Record<string, never>> extends BaseSQLiteDatabase<'sync', RunResult, TSchema> {
  9. static readonly [entityKind]: string;
  10. }
  11. export declare function drizzle<TSchema extends Record<string, unknown> = Record<string, never>>(...params: [] | [
  12. Database | string
  13. ] | [
  14. Database | string,
  15. DrizzleConfig<TSchema>
  16. ] | [
  17. (DrizzleConfig<TSchema> & ({
  18. connection?: DrizzleBetterSQLite3DatabaseConfig;
  19. } | {
  20. client: Database;
  21. }))
  22. ]): BetterSQLite3Database<TSchema> & {
  23. $client: Database;
  24. };
  25. export declare namespace drizzle {
  26. function mock<TSchema extends Record<string, unknown> = Record<string, never>>(config?: DrizzleConfig<TSchema>): BetterSQLite3Database<TSchema> & {
  27. $client: '$client is not available on drizzle.mock()';
  28. };
  29. }