instagres

library1.1.8jsnpmunverified

Instagres provided instant Postgres connection strings via Neon, no signup required, for local development. Version 1.1.8 is the last release. The package is deprecated and replaced by 'neondb'. Key differentiator was zero-setup ephemeral databases without authentication. Offers both CLI and library usage, with ESM and CJS support. No longer maintained; users should migrate to 'neondb'.

database

npm install instagres

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · INSTAGRES

instagres

databasejavascriptv1.1.8

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

instagres (default)

✓ import instagres from 'instagres'

✗ const instagres = require('instagres')

Default export is a function. CommonJS users must use require('instagres').default.

instagres (named)

✓ import { instagres } from 'instagres'

✗ import instagres from 'instagres' (if expecting default)

Named export also available, but default is typical.

instagres (CJS default)

✓ const { default: instagres } = require('instagres')

✗ require('instagres')

CommonJS must access .default since the package is ESM.

Shows how to retrieve an instant Postgres connection string using the instagres function with a required source parameter.

import instagres from 'instagres'; // Get an instant Postgres connection string const connectionString = await instagres({ source: 'my-app' }); console.log('Connection string:', connectionString);

Debug

Known issues

deprecatedPackage is deprecated; use neondb instead.

fix

Replace instagres with neondb.

affects: >=1.1.8

gotchaCommonJS users must use require('instagres').default, not require('instagres')

fix

Use const { default: instagres } = require('instagres');

affects: >=1.0.0

gotchaThe source parameter is required. If omitted, the function will throw an error.

fix

Always pass the source object: instagres({ source: 'my-project' })

affects: >=1.0.0

gotchaThe CLI commands (npx instagres etc.) are for the package itself, not for integrating into your project. For library usage, install the package.

fix

Use 'npm install instagres' for library usage.

affects: >=1.0.0

gotchaWhen using Deno, import from 'npm:instagres@^1.1.4' to avoid version issues.

fix

Use import instagres from 'npm:instagres@^1.1.4';

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: instagres is not a function

CommonJS require without .default

fix

Use const { default: instagres } = require('instagres');

Error: Missing required parameter: source

The source parameter is required but not provided.

fix

Call instagres with an object containing source: instagres({ source: 'my-project' })

Upgrade

Version history

1.1.8latest on npm

Audit

Dependencies

commanderoptionalused for CLI argument parsing

dotenvoptionalreads .env files

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/neondatabase-labs/instagres-js ↗

packageinstagres ↗

homepagehttps://github.com/neondatabase-labs/instagres-js#readme ↗