TypeScript SDK for managing your Neon Serverless PostgreSQL projects
MIT License
neon-sdk
Fully-typed, zero-dependency Node.js and Deno SDK for managing your Neon Serverless Postgres projects.
Note
Neon is a fully managed serverless PostgreSQL with a generous free tier. Neon separates storage and compute and offers modern developer features such as serverless, branching, bottomless storage, and more. Neon is open source and written in Rust.
Node.js (>= v18.x)
Install neon-sdk
as a dependency using the package manager of your choice.
npm i neon-sdk
Initialize the client with your Neon API token.
import { NeonClient } from 'neon-sdk';
const neonClient = new NeonClient({
TOKEN: '<INSERT NEON API KEY HERE>',
});
(async () => {
const projects = await neonClient.project.listProjects();
console.log(projects);
})()
You can use the same steps to use this package if you're on Node.js v16.15.x or above, with one minor change; when running your code, you will need to pass the --experimental-fetch
flag to node
.
For example –
node --experimental-fetch app.js
Deno (>= v1.28.x)
Simply import the neon-sdk
from npm using the npm:
specifier and initialize the client with your Neon API token.
// neon.ts
import { NeonClient } from "npm:neon-sdk";
const neonClient = new NeonClient({
TOKEN: "<INSERT NEON API KEY HERE>",
});
const projects = await neonClient.project.listProjects();
console.log(projects);
Make sure to allow net
permissions to console.neon.tech
for the code to run.
deno run --allow-net=console.neon.tech neon.ts
This package is auto-generated from Neon's OpenAPI reference using openapi-typescript-codegen
.