neon-sdk/README.md

TypeScript SDK for managing your Neon Serverless PostgreSQL projects

# `neon-sdk`

[![CI](https://github.com/paambaati/neon-js-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/paambaati/neon-js-sdk/actions/workflows/ci.yml)
[![NPM Version](https://img.shields.io/npm/v/neon-sdk.svg?logo=npm)](https://www.npmjs.com/package/neon-sdk)

Fully-typed, zero-dependency Node.js and Deno SDK for managing your [Neon](https://neon.tech/) 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.
> 
> [Learn more about Neon](https://neon.tech/docs/introduction/about)

## Usage

**Node.js (>= v18.x)**

1. Install `neon-sdk` as a dependency using the package manager of your choice.

    ```bash
    npm i neon-sdk
    ```

2. Initialize the client with your [Neon API token](https://neon.tech/docs/manage/api-keys#manage-api-keys-with-the-neon-api).

    ```typescript
    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);
    })()
    ```

<details><summary><strong>Node.js (>= v16.15.x)</strong></summary>

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
```
</details>

**Deno (>= v1.28.x)**

1. Simply import the `neon-sdk` from npm using the [`npm:` specifier](https://deno.land/manual@v1.30.3/node/npm_specifiers) and initialize the client with your [Neon API token](https://neon.tech/docs/manage/api-keys#manage-api-keys-with-the-neon-api).

    ```typescript
    // 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.

    ```bash
    deno run --allow-net=console.neon.tech neon.ts
    ```

## Developer Notes

This package is auto-generated from [Neon's OpenAPI reference](https://neon.tech/api-reference/v2/) using [`openapi-typescript-codegen`](https://www.npmjs.com/package/openapi-typescript-codegen).