@distilled.cloud/neon

Effect-native Neon SDK generated from the Neon OpenAPI specification. Manage serverless Postgres projects, branches, endpoints, databases, and roles with exhaustive error typing.

Installation

npm install @distilled.cloud/neon effect

Quick Start

import { Effect, Layer } from "effect";
import * as Stream from "effect/Stream";
import * as FetchHttpClient from "effect/unstable/http/FetchHttpClient";
import { listProjects } from "@distilled.cloud/neon/Operations";
import { CredentialsFromEnv } from "@distilled.cloud/neon";

const program = Effect.gen(function* () {
  const projects = yield* listProjects({});
  return projects.projects;
});

const NeonLive = Layer.mergeAll(FetchHttpClient.layer, CredentialsFromEnv);

program.pipe(Effect.provide(NeonLive), Effect.runPromise);

Configuration

Set the following environment variable:

NEON_API_KEY=your-api-key

Create an API key in the Neon console under Settings > API Keys.

Error Handling

import { getProject } from "@distilled.cloud/neon/Operations";

getProject({ project_id: "missing" }).pipe(
  Effect.catchTags({
    NotFound: () => Effect.succeed(null),
    UnknownNeonError: (e) => Effect.fail(new Error(`Unknown: ${e.message}`)),
  }),
);

License

MIT