@stackline/types-pg
Dependency-reviewed TypeScript definitions compatible with @types/pg 8.23.1.
Documentation | npm | Issues | Repository
Current package version: 1.0.3
Why this package?
Dependency-reviewed TypeScript definitions compatible with
@types/pg@8.23.1.
The declaration files are unchanged from DefinitelyTyped. This fork replaces
the historical pg-types@2.2.0 -> postgres-interval -> xtend dependency branch
with @stackline/pg-types, pins the remaining type dependencies, and verifies
the packed package in clean TypeScript consumers.
Compatibility
| Item | Value |
|---|---|
| Package | @stackline/types-pg@1.0.3 |
| Node.js runtime | >=16 |
| CommonJS / primary entry | ./index.js |
| Type declarations | index.d.ts |
- Declaration baseline:
@types/pg@8.23.1. - Runtime baseline:
pg@8.23.0and@stackline/pg@1.x. - TypeScript: 5.6 and newer, matching the source package metadata.
- CJS and ESM declaration entry points are preserved.
- Deep
pg/lib/*type imports are preserved through the alias installation.
See DEPENDENCY_REVIEW.md, COMPATIBILITY.md, and SECURITY.md.
Installation
Install
Use the historical @types/pg location so TypeScript discovery and existing
imports remain unchanged:
npm install pg@npm:@stackline/pg @types/pg@npm:@stackline/types-pg
Usage
Existing source continues to work:
import { Pool, type PoolConfig, type QueryResultRow } from "pg";
const config: PoolConfig = {
connectionString: process.env.DATABASE_URL,
max: 10,
};
interface UserRow extends QueryResultRow {
id: number;
name: string;
}
const pool = new Pool(config);
const result = await pool.query<UserRow>("select id, name from users");
The scoped package can also be imported explicitly for types:
npm install @stackline/types-pg
import type { PoolConfig } from "@stackline/types-pg";
Security
Review inputs and the package-specific compatibility limits before processing untrusted data. Report suspected vulnerabilities as described in the security policy.
Local Development
git clone https://github.com/alexandroit/stackline-types-pg.git
cd stackline-types-pg
npm ci
npm run verify
Release tooling uses Node.js 24.20.0 and npm 11.19.0. The consumer runtime contract remains the one documented above.
Consumer Smoke Test
Run the repository's existing consumer/package check after installing development dependencies:
npm run test:smoke
Release Checklist
Run npm run verify and inspect the package contents before release. Publish a new version through the GitHub Actions publishing workflow, using the SHA-512 digest of the reviewed tarball. Verify the exact published version, tarball integrity, and npm provenance after the run.
License
MIT. The DefinitelyTyped license and author credit are preserved in LICENSE, NOTICE, and UPSTREAM_README.md.
Credits and original authors
- Phips Peter.
- Stackline maintenance: Alexandro Paixao Marques and Stackline contributors.
Original copyright, license notices and contributor acknowledgements remain part of this distribution. Stackline maintenance does not replace authorship of the original work.
Community and Links
Use this repository's issue tracker for reproducible bugs and feature requests. Join r/Stackline for examples, usage questions and release discussions.