https://github.com/necm1/surrealdb-driver
https://github.com/necm1/surrealdb-driver
nodejs surrealdb typescript
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/necm1/surrealdb-driver
- Owner: necm1
- Created: 2022-10-02T00:17:31.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-16T15:35:59.000Z (almost 3 years ago)
- Last Synced: 2025-04-27T16:05:00.350Z (6 months ago)
- Topics: nodejs, surrealdb, typescript
- Language: TypeScript
- Homepage:
- Size: 59.6 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# surrealdb-driver
This package provides a asynchronously "RPC-Wrapper" / driver for SurrealDB using `ws`.
## Why?
Actually SurrealDB provides a "wrapper" / driver created by some users ([surrealdb.js](https://github.com/surrealdb/surrealdb.js)), but I didn't like the code at all.
That's why I started to create my own "wrapper" / driver with a better & readable code.
## Example
Example of how to `select` from `persons` table:
```
(async () => {
const surreal = new Surreal({
host: '127.0.0.1',
port: 8000,
user: 'user',
pass: 'password',
ns: 'myNamespace',
db: 'myDatabase',
ssl: false,
});
await surreal.signIn();
const persons = await surreal.select<
{company: string; id: string; name: string; skills: string[]}[]
>('persons');
persons.forEach((e) => console.log(e));
})();
```
Result:
```
{
company: 'SurrealDB',
id: 'users:x173nmutw0nzrt4fnixz',
name: 'Tobie',
skills: [ 'Rust', 'Go', 'JavaScript' ]
}
```