Skip to content
JavaScript bindings for EdgeDB
TypeScript JavaScript Shell
Branch: master
Clone or download

The NodeJS driver for EdgeDB

Build Status NPM Join the community on Spectrum

edgedb is the official EdgeDB driver for JavaScript and TypeScript.

The library requires NodeJS 10 or later.


npm install edgedb --save


yarn add edgedb --save

Quick Start

Follow the EdgeDB tutorial to get EdgeDB installed and minimally configured.

Next, create the package.json file:

mkdir myproject
cd myproject
npm init

Next, install the "edgedb" library:

npm install edgedb --save

And here's a simple script to connect to an EdgeDB instance and run a simple query:

const edgedb = require("edgedb");

async function main() {
  const conn = await edgedb.connect({
    user: "edgedb",
    host: "",

  console.log(await conn.fetchOne("SELECT 1 + 1"));

  await conn.close();



A local installation of EdgeDB is required to run tests. Download EdgeDB from here or build it manually.

We use TypeScript, yarn, prettier, and tslint to develop edgedb-js. To run the test suite, run yarn test. To lint or format the code, run yarn lint / yarn format.


edgedb-js is developed and distributed under the Apache 2.0 license.

You can’t perform that action at this time.