falkordb 4.6.11 → 4.6.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -22
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,50 +1,42 @@
|
|
|
1
|
-
#
|
|
1
|
+
# FalkorDB
|
|
2
2
|
|
|
3
|
-
[](https://github.com/falkordb/node-falkordb/actions/workflows/tests.yml)
|
|
4
|
+
[](https://codecov.io/gh/falkordb/node-falkordb)
|
|
5
|
+
[](https://github.com/falkordb/node-falkordb/blob/master/LICENSE)
|
|
6
6
|
|
|
7
|
-
[](https://discord.
|
|
8
|
-
[](https://www.youtube.com/redisinc)
|
|
10
|
-
[](https://twitter.com/redisinc)
|
|
7
|
+
[](https://discord.com/invite/99y2Ubh6tg)
|
|
8
|
+
[](https://twitter.com/falkordb)
|
|
11
9
|
|
|
12
|
-
|
|
10
|
+
falkordb is a modern, high performance [FalkorDB](https://www.falkordb.com) client for Node.js.
|
|
13
11
|
|
|
14
12
|
## Packages
|
|
15
13
|
|
|
16
14
|
| Name | Description |
|
|
17
15
|
|----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
18
|
-
| [falkordb](./) | [](https://www.npmjs.com/package/falkordb) [](https://www.npmjs.com/package/
|
|
16
|
+
| [falkordb](./) | [](https://www.npmjs.com/package/falkordb) [](https://www.npmjs.com/package/falkordb) |
|
|
19
17
|
| [@falkordb/client](./packages/client) | [](https://www.npmjs.com/package/@falkordb/client) [](https://www.npmjs.com/package/@falkordb/client) [](https://redis.js.org/documentation/client/) |
|
|
20
|
-
| [@falkordb/graph](./packages/graph) | [](https://www.npmjs.com/package/@falkordb/graph) [](https://www.npmjs.com/package/@falkordb/graph) [](https://redis.js.org/documentation/graph/) [
|
|
21
|
-
|
|
22
|
-
> :warning: In version 4.1.0 we moved our subpackages from `@node-redis` to `@falkordb`. If you're just using `npm install redis`, you don't need to do anything—it'll upgrade automatically. If you're using the subpackages directly, you'll need to point to the new scope (e.g. `@falkordb/client` instead of `@node-falkordb/client`).
|
|
18
|
+
| [@falkordb/graph](./packages/graph) | [](https://www.npmjs.com/package/@falkordb/graph) [](https://www.npmjs.com/package/@falkordb/graph) [](https://redis.js.org/documentation/graph/) [FalkorDB](https://www.falkordb.com) commands |
|
|
23
19
|
|
|
24
20
|
## Installation
|
|
25
21
|
|
|
26
|
-
Start a
|
|
22
|
+
Start a falkordb via docker:
|
|
27
23
|
|
|
28
24
|
``` bash
|
|
29
|
-
docker run -p 6379:6379 -it
|
|
25
|
+
docker run -p 6379:6379 -it falkordb/falkordb:latest
|
|
30
26
|
```
|
|
31
27
|
|
|
32
|
-
To install node
|
|
28
|
+
To install node falkordb, simply:
|
|
33
29
|
|
|
34
30
|
```bash
|
|
35
|
-
npm install
|
|
31
|
+
npm install falkordb
|
|
36
32
|
```
|
|
37
33
|
|
|
38
|
-
> :warning: The new interface is clean and cool, but if you have an existing codebase, you'll want to read the [migration guide](./docs/v3-to-v4.md).
|
|
39
|
-
|
|
40
|
-
Looking for a high-level library to handle object mapping? See [redis-om-node](https://github.com/redis/redis-om-node)!
|
|
41
|
-
|
|
42
34
|
## Usage
|
|
43
35
|
|
|
44
36
|
### Basic Example
|
|
45
37
|
|
|
46
38
|
```typescript
|
|
47
|
-
import { createClient } from '
|
|
39
|
+
import { createClient } from 'falkordb';
|
|
48
40
|
|
|
49
41
|
const client = await createClient()
|
|
50
42
|
.on('error', err => console.log('Redis Client Error', err))
|