@postgresql-typed/postgres

@PostgreSQL-Typed/postgres

A type-safe PostgreSQL client for Node.js (Using the postgres module)

Table of Contents

Installation
Usage
Ecosystem
License

Installation

Install @postgresql-typed/postgres and @postgresql-typed/cli (For generating types)

npm install --save @postgresql-typed/postgres
npm install --save-dev @postgresql-typed/cli

Usage

A documentation website is coming soon for the entire PostgreSQL-Typed ecosystem to explain how to use the system and all of its features.

# Generate types
npx pgt gen

import { Client, isReady } from "@postgresql-typed/postgres";

import { Databases, DatabasesData } from "./__generated__/index.js";

const client = await new Client<Databases>(
	DatabasesData,
	process.env.DATABASE_URI
).testConnection();

if (!isReady(client)) {
	throw new Error("Client not ready");
}

const table = client.table("<your table path>");

const result = await table.select.execute("*");
if (!result.success) {
	throw new Error("Failed to select");
}

console.log(result.data.rows);

Ecosystem

This package is part of the PostgreSQL-Typed ecosystem.

License

Mozilla Public License 2.0