https://github.com/paambaati/neon-js-sdk

TypeScript SDK for managing your Neon Serverless PostgreSQL projects
https://github.com/paambaati/neon-js-sdk

deno javascript neon nodejs sdk typescript

Last synced: 2 months ago
JSON representation

TypeScript SDK for managing your Neon Serverless PostgreSQL projects

• Host: GitHub
• URL: https://github.com/paambaati/neon-js-sdk
• Owner: paambaati
• License: mit
• Created: 2023-02-09T13:09:34.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-01T01:37:21.000Z (2 months ago)
• Last Synced: 2024-12-01T02:27:42.069Z (2 months ago)
• Topics: deno, javascript, neon, nodejs, sdk, typescript
• Language: TypeScript
• Homepage:
• Size: 1.21 MB
• Stars: 18
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `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: '',

    });

    (async () => {

        const projects = await neonClient.project.listProjects();

        console.log(projects);

    })()

    ```

Node.js (>= v16.15.x)

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)**

1. Simply import the `neon-sdk` from npm using the [`npm:` specifier](https://deno.land/[email protected]/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: "",

    });

    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).