falkordb 4.6.13 → 5.0.0

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.
Files changed (3) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +6 -6
  3. package/package.json +3 -3
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2022-2023, Redis, inc.
3
+ Copyright (c) 2022-2023, Redis, inc., 2023 FalkorDB inc.
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
  [![Discord](https://img.shields.io/discord/697882427875393627.svg?style=social&logo=discord)](https://discord.com/invite/99y2Ubh6tg)
8
8
  [![Twitter](https://img.shields.io/twitter/follow/falkordb?style=social)](https://twitter.com/falkordb)
9
9
 
10
- falkordb is a modern, high performance [FalkorDB](https://www.falkordb.com) client for Node.js.
10
+ `falkordb`` is a modern, high performance [FalkorDB](https://www.falkordb.com) client for Node.js.
11
11
 
12
12
  ## Packages
13
13
 
@@ -51,7 +51,7 @@ The above code connects to localhost on port 6379. To connect to a different hos
51
51
 
52
52
  ```typescript
53
53
  createClient({
54
- url: 'redis://alice:foobared@awesome.redis.server:6380'
54
+ url: 'redis://alice:foobared@cloud.falkordb.io:6379'
55
55
  });
56
56
  ```
57
57
 
@@ -134,7 +134,7 @@ Any command can be run on a new connection by specifying the `isolated` option.
134
134
  This pattern works especially well for blocking commands—such as `BLPOP` and `BLMOVE`:
135
135
 
136
136
  ```typescript
137
- import { commandOptions } from 'redis';
137
+ import { commandOptions } from 'falkordb';
138
138
 
139
139
  const blPopPromise = client.blPop(
140
140
  commandOptions({ isolated: true }),
@@ -202,14 +202,14 @@ redis.register_function {
202
202
 
203
203
  Here is the same example, but in a format that can be pasted into the `redis-cli`.
204
204
 
205
- ```
205
+ ```bash
206
206
  FUNCTION LOAD "#!lua name=library\nredis.register_function{function_name=\"add\", callback=function(keys, args) return redis.call('GET', keys[1])+args[1] end, flags={\"no-writes\"}}"
207
207
  ```
208
208
 
209
209
  Load the prior redis function on the _redis server_ before running the example below.
210
210
 
211
211
  ```typescript
212
- import { createClient } from 'redis';
212
+ import { createClient } from 'falkordb';
213
213
 
214
214
  const client = createClient({
215
215
  functions: {
@@ -238,7 +238,7 @@ await client.library.add('key', 2); // 3
238
238
  The following is an end-to-end example of the prior concept.
239
239
 
240
240
  ```typescript
241
- import { createClient, defineScript } from 'redis';
241
+ import { createClient, defineScript } from 'falkordb';
242
242
 
243
243
  const client = createClient({
244
244
  scripts: {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "falkordb",
3
3
  "description": "A modern, high performance FalkorDB client",
4
- "version": "4.6.13",
4
+ "version": "5.0.0",
5
5
  "license": "MIT",
6
6
  "main": "./dist/index.js",
7
7
  "types": "./dist/index.d.ts",
@@ -23,8 +23,8 @@
23
23
  "gh-pages": "gh-pages -d ./documentation -e ./documentation -u 'github-actions-bot <support+actions@github.com>'"
24
24
  },
25
25
  "dependencies": {
26
- "@falkordb/client": "1.5.11",
27
- "@falkordb/graph": "1.1.0"
26
+ "@falkordb/client": "1.5.12",
27
+ "@falkordb/graph": "1.1.1"
28
28
  },
29
29
  "devDependencies": {
30
30
  "@tsconfig/node14": "^14.1.0",