Type-safe Postgres in TypeScript

Import the full power of PostgreSQL as a TypeScript library.

Quick Start

# Install Typegres
npm install typegres
Copy

import { typegres, Text, Int4, values, Bool } from "typegres";

const db = typegres({ type: "pglite" });

const users = values(
  { name: Text.new("Alice"), age: Int4.new(25), isActive: Bool.new(true) },
  { name: Text.new("Bob"), age: Int4.new(30), isActive: Bool.new(false) },
  { name: Text.new("Charlie"), age: Int4.new(17), isActive: Bool.new(true) }
);

const rows = await users
  .select((u) => ({ upper: u.name.upper(), isAdult: u.age[">"](18) }))
  .where((u) => u.isActive)
  .execute(db);

console.log(rows);
// Output: [{ upper: 'ALICE', isAdult: true }, { upper: 'CHARLIE', isAdult: false }]
Copy

See the quickstart guide for more details: https://typegres.com/docs/quickstart/

✅ Autocomplete for every PG function, 100% compile-time types

Docs & Demo

• Docs: https://typegres.com/docs/quickstart/
• API Reference: https://typegres.com/api/
• Playground: https://typegres.com/play/

Key Features & Design Goals

While traditional ORMs and query builders abstract over multiple SQL dialects, Typegres goes all-in on PostgreSQL to provide the most powerful and type-safe experience possible. In a single import, you can access the full power of Postgres with complete TypeScript type safety.

• Postgres-only – every builtin function & operator, nothing poly-glot
• TypeScript-native – full generics, autocomplete, inference
• Zero ORM bloat – SQL you can read
• TypeScript safety – mistakes caught by the compiler, not production

Focus on learning Postgres itself — Typegres just gives you autocomplete, type-checking, and all other benefits of TypeScript.

Advanced example

const result = await users
  .select((u) => ({
    firstName: u.name.regexpSubstr("[A-Z][a-z]+").upper(),
    lastName: u.name.regexpSubstr("[a-z]+$").lower(),
    isAdult: u.age[">"](18),
  }))
  .where((u) => u.isActive)
  .execute(db);

// result type: Array<{ firstName: string; lastName: string; isAdult: boolean }>
Copy

Roadmap

• [x] Generated PG types, operators, functions
• [x] Query-builder PoC
• [x] Interactive playground
• [ ] Full support for UPDATE / INSERT
• [ ] Custom keywords (IS NULL, AND, OR)
• [ ] Refined typing for advanced types (JSONB, arrays, custom enums)
• [ ] Table generator + migrations
• [ ] Inline docs & hover help

Project Structure

• src/ - Main library source code
• src/gen/ - Auto-generated PostgreSQL types and functions
• site/ - Documentation website and interactive playground

Development

Requirements:

• nix package manager
• (optional) direnv for automatic environment setup

To contribute, clone the repository (run nix develop if you don't have direnv set up) and run:

# Install dependencies
npm install
# Start custom PostgreSQL instance:
./start_postgres.sh
# Run the codegen script to generate types and functions
npm run codegen
# Run tests
npm test
# Type check the code
npm run typecheck
# Build the library
npm run build
Copy

License

MIT © Ryan Rasti