@tai-kun/surrealdb NPM | npm.io

2.2.0 • Published 8 months ago

Install

Weekly downloads

-

License

Apache-2.0

Repository

Last release

8 months ago

A modular SurrealDB client working in major JavaScript runtimes.

!NOTE The main branch is currently under development for SurrealDB v2. You can find the repository for SurrealDB v1 here.

Document (JA/EN/KO/zh-CN)

https://tai-kun.github.io/surrealdb.js/getting-started/

Install

npm i @tai-kun/surrealdb

Quick Start

import { Surreal } from "@tai-kun/surrealdb";

const db = new Surreal();
await db.connect("<your_surrealdb_server>"); // e.g. ws://localhost:8000

try {
  await db.signin({ user: "root", pass: "root" });
  await db.use("sample_namespace", "sample_database");
  const results = await db.query<[number]>(/*surql*/ `RETURN 42;`);
  console.log(results); // [ 42 ]
} finally {
  await db.close();
}

Customization

import { initSurreal } from "@tai-kun/surrealdb";
import Client from "@tai-kun/surrealdb/standard-client";
import HttpEngine from "@tai-kun/surrealdb/http-engine";
import JsonFormatter from "@tai-kun/surrealdb/json-formatter";

const { Surreal } = initSurreal({
  Client: Client,
  engines: {
    http: config => new HttpEngine({
      ...config,
      // fetch: <your custom fetch function>
    }),
    https: "http",
  },
  formatter: new JsonFormatter(),
});

Requirements

SurrealDB >=2.1.0

The repository for SurrealDB v1 is here.

Recommended environment

Env	Version
Node.js	`20.x`,`22.x` *1
Deno	`1.x`, `2.x` *2
Bun	`1.x`
Chromium	`>=104` *3
Firefox	`>=100` *4
WebKit	`>=15.4` *5

1: Probably works with 18.x
2: Probably works with ^1.44.3
3: Probably works with >=78
4: Probably works with >=68
*5: Probably works with >=14

Fully Tested

Env	Version
Node.js	`20.x`,`22.x`,`23.x`
Deno	`1.x`,`2.x`
Bun	`1.x`
Chromium	`>=104`

Partial Tested

Env	Version
Node.js	`18.x`
Firefox	`>=100`
WebKit	`>=15.4`

License

surreal surrealdb

@types/big.js big.js isows type-fest

8 months ago

9 months ago

9 months ago

9 months ago

9 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

2.0.0-next.20240912T113732

10 months ago

10 months ago

2.0.0-next.20240912T110913

10 months ago

2.0.0-next.20240912T110213

10 months ago

2.0.0-next.20240912T083225

10 months ago

2.0.0-next.20240912T081832

10 months ago

2.0.0-next.20240911T104622

10 months ago

2.0.0-next.20240911T092605

10 months ago

10 months ago

2.0.0-next.20240911T070200

10 months ago

10 months ago

2.0.0-next.20240911T060839

10 months ago

10 months ago

2.0.0-next.20240911T031033

10 months ago

2.0.0-next.20240911T023519

10 months ago

11 months ago

2.0.0-next.20240902T021149

11 months ago

2.0.0-next.20240902T013549

11 months ago

2.0.0-next.20240902T001756

11 months ago

2.0.0-next.20240901T234450

11 months ago

2.0.0-next.20240901T234427

11 months ago

2.0.0-next.20240901T055724

11 months ago

2.0.0-next.20240901T035423

11 months ago

2.0.0-next.20240901T025809

11 months ago

2.0.0-next.20240831T050148

11 months ago

2.0.0-next.20240831T040524

11 months ago

2.0.0-next.20240831T040215

11 months ago

2.0.0-next.20240831T024853

11 months ago

2.0.0-next.20240831T004831

11 months ago

2.0.0-next.20240829T012036

11 months ago

2.0.0-next.20240828T041833

11 months ago

2.0.0-next.20240828T025108

11 months ago

2.0.0-next.20240828T015804

11 months ago

2.0.0-next.20240828T004003

11 months ago

2.0.0-next.20240827T054401

11 months ago

2.0.0-next.20240827T054346

11 months ago

2.0.0-next.20240827T031233

11 months ago

2.0.0-next.20240827T025057

11 months ago

2.0.0-next.20240827T024030

11 months ago

2.0.0-next.20240827T023741

11 months ago

2.0.0-next.20240827T014636

11 months ago

2.0.0-next.20240826T235635

11 months ago

2.0.0-next.20240823T023834

11 months ago

11 months ago

2.0.0-next.20240823T012035

11 months ago

1.5.0-next.20240822T230107

11 months ago

11 months ago

1.5.0-next.20240822T020752

11 months ago

1.5.0-next.20240821T102806

11 months ago

1.5.0-next.20240821T012351

11 months ago

1.5.0-next.20240820T063801

11 months ago

1.5.0-next.20240820T024212

11 months ago

1.5.0-next.20240820T000509

11 months ago

1.5.0-next.20240819T235522

11 months ago

1.5.0-next.20240819T092610

11 months ago

1.5.0-next.20240819T091415

11 months ago

1.5.0-next.20240819T090343

11 months ago

1.5.0-next.20240819T082844

11 months ago

1.5.0-next.20240819T074536

11 months ago

1.5.0-next.20240819T012712

11 months ago

1.5.0-next.20240816T065410

11 months ago

1.5.0-next.20240816T063735

11 months ago

1.5.0-next.20240816T063359

11 months ago

1.5.0-next.20240816T062142

11 months ago

1.5.0-next.20240816T061949

11 months ago

1.5.0-next.20240816T033939

11 months ago

11 months ago

1.5.0-next.20240816T014226

11 months ago

1.5.0-next.20240816T013335

11 months ago

1.5.0-next.20240816T012216

11 months ago

1.5.0-next.20240814T012506

11 months ago

1.5.0-next.20240814T005410

11 months ago

11 months ago

1.5.0-next.20240813T080451

11 months ago

1.4.0-next.20240813T075310

11 months ago

1.4.0-next.20240807T053856

11 months ago

1.4.0-next.20240807T043933

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

0.2.0-canary.20240630T101909

1 year ago

0.2.0-canary.20240630T094356

1 year ago

0.2.0-canary.20240630T031355

1 year ago

0.2.0-canary.20240630T030231

1 year ago

0.2.0-canary.20240630T004200

1 year ago

0.2.0-canary.20240630T002530

1 year ago

0.2.0-canary.20240629T233842

1 year ago

0.2.0-canary.20240629T232923

1 year ago

0.2.0-canary.20240629T121029

1 year ago

0.2.0-canary.20240629T112610

1 year ago

0.2.0-canary.20240629T110955

1 year ago

0.1.0-canary.20240629T110740

1 year ago

1 year ago

0.1.0-canary.20240619T065655

1 year ago

0.1.0-canary.20240619T061322

1 year ago

0.1.0-canary.20240619T055935

1 year ago

0.1.0-canary.20240618T111857

1 year ago

0.1.0-canary.20240531T231605

1 year ago