A modern, high performance Valkey client
npm install valkey
node-valkey is a modern, high performance Valkey client for Node.js.
| Name | Description |
|----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| valkey |   |
| valkey-client |    |
| valkey-bloom |    Valkey Bloom commands |
| valkey-graph |    Valkey Graph commands |
| valkey-json |    Valkey JSON commands |
| valkey-search |    ValkeySearch commands |
| valkey-time-series |    Valkey Time-Series commands |
Start a valkey via docker:
`` bash`
docker run -p 6379:6379 -it valkey/valkey:unstable
To install node-valkey, simply:
`bash`
npm install valkey
> :warning: The new interface is clean and cool, but if you have an existing codebase, you'll want to read the migration guide.
Looking for a high-level library to handle object mapping? See valkey-om-node!
`typescript
import { createClient } from 'valkey';
const client = await createClient()
.on('error', err => console.log('Valkey Client Error', err))
.connect();
await client.set('key', 'value');
const value = await client.get('key');
await client.disconnect();
`
The above code connects to localhost on port 6379. To connect to a different host or port, use a connection string in the format valkey[s]://[[username][:password]@][host][:port][/db-number]:
`typescript`
createClient({
url: 'valkey://alice:foobared@awesome.valkey.server:6380'
});
You can also use discrete parameters, UNIX sockets, and even TLS to connect. Details can be found in the client configuration guide.
To check if the client is connected and ready to send commands, use client.isReady which returns a boolean. client.isOpen is also available. This returns true when the client's underlying socket is open, and false when it isn't (for example when the client is still connecting or reconnecting after a network error).
There is built-in support for all the out-of-the-box Valkey commands. They are exposed using the raw Valkey command names (HSET, HGETALL, etc.) and a friendlier camel-cased version (hSet, hGetAll, etc.):
`typescript
// raw Valkey commands
await client.HSET('key', 'field', 'value');
await client.HGETALL('key');
// friendly JavaScript commands
await client.hSet('key', 'field', 'value');
await client.hGetAll('key');
`
Modifiers to commands are specified using a JavaScript object:
`typescript`
await client.set('key', 'value', {
EX: 10,
NX: true
});
Replies will be transformed into useful data structures:
`typescript`
await client.hGetAll('key'); // { field1: 'value1', field2: 'value2' }
await client.hVals('key'); // ['value1', 'value2']
Buffers are supported as well:
`typescript`
await client.hSet('key', 'field', Buffer.from('value')); // 'OK'
await client.hGetAll(
commandOptions({ returnBuffers: true }),
'key'
); // { field:
If you want to run commands and/or use arguments that Node Valkey doesn't know about (yet!) use .sendCommand():
`typescript
await client.sendCommand(['SET', 'key', 'value', 'NX']); // 'OK'
await client.sendCommand(['HGETALL', 'key']); // ['key1', 'field1', 'key2', 'field2']
`
Start a transaction by calling .multi(), then chaining your commands. When you're done, call .exec() and you'll get an array back with your results:
`typescript
await client.set('another-key', 'another-value');
const [setKeyReply, otherKeyValue] = await client
.multi()
.set('key', 'value')
.get('another-key')
.exec(); // ['OK', 'another-value']
`
You can also watch keys by calling .watch(). Your transaction will abort if any of the watched keys change.
To dig deeper into transactions, check out the Isolated Execution Guide.
Any command can be run on a new connection by specifying the isolated option. The newly created connection is closed when the command's Promise is fulfilled.
This pattern works especially well for blocking commands—such as BLPOP and BLMOVE:
`typescript
import { commandOptions } from 'valkey';
const blPopPromise = client.blPop(
commandOptions({ isolated: true }),
'key',
0
);
await client.lPush('key', ['1', '2']);
await blPopPromise; // '2'
`
To learn more about isolated execution, check out the guide.
See the Pub/Sub overview.
SCAN results can be looped over using async iterators:
`typescript`
for await (const key of client.scanIterator()) {
// use the key!
await client.get(key);
}
This works with HSCAN, SSCAN, and ZSCAN too:
`typescript`
for await (const { field, value } of client.hScanIterator('hash')) {}
for await (const member of client.sScanIterator('set')) {}
for await (const { score, value } of client.zScanIterator('sorted-set')) {}
You can override the default options by providing a configuration object:
`typescriptSCAN
client.scanIterator({
TYPE: 'string', // only`
MATCH: 'patter*',
COUNT: 100
});
Valkey provides a programming interface allowing code execution on the valkey server.
#### Functions
The following example retrieves a key in valkey, returning the value of the key, incremented by an integer. For example, if your key _foo_ has the value _17_ and we run add('foo', 25), it returns the answer to Life, the Universe and Everything.
`lua
#!lua name=library
valkey.register_function {
function_name = 'add',
callback = function(keys, args) return valkey.call('GET', keys[1]) + args[1] end,
flags = { 'no-writes' }
}
`
Here is the same example, but in a format that can be pasted into the valkey-cli.
`
FUNCTION LOAD "#!lua name=library\nvalkey.register_function{function_name=\"add\", callback=function(keys, args) return valkey.call('GET', keys[1])+args[1] end, flags={\"no-writes\"}}"
Load the prior valkey function on the _valkey server_ before running the example below.
`typescript
import { createClient } from 'valkey';
const client = createClient({
functions: {
library: {
add: {
NUMBER_OF_KEYS: 1,
transformArguments(key: string, toAdd: number): Array
return [key, toAdd.toString()];
},
transformReply(reply: number): number {
return reply;
}
}
}
}
});
await client.connect();
await client.set('key', '1');
await client.library.add('key', 2); // 3
`
#### Lua Scripts
The following is an end-to-end example of the prior concept.
`typescript
import { createClient, defineScript } from 'valkey';
const client = createClient({
scripts: {
add: defineScript({
NUMBER_OF_KEYS: 1,
SCRIPT:
'return valkey.call("GET", KEYS[1]) + ARGV[1];',
transformArguments(key: string, toAdd: number): Array
return [key, toAdd.toString()];
},
transformReply(reply: number): number {
return reply;
}
})
}
});
await client.connect();
await client.set('key', '1');
await client.add('key', 2); // 3
`
There are two functions that disconnect a client from the Valkey server. In most scenarios you should use .quit() to ensure that pending commands are sent to Valkey before closing a connection.
#### .QUIT()/.quit()
Gracefully close a client's connection to Valkey, by sending the QUIT command to the server. Before quitting, the client executes any remaining commands in its queue, and will receive replies from Valkey for each of them.
`typescript
const [ping, get, quit] = await Promise.all([
client.ping(),
client.get('key'),
client.quit()
]); // ['PONG', null, 'OK']
try {
await client.get('key');
} catch (err) {
// ClosedClient Error
}
`
#### .disconnect()
Forcibly close a client's connection to Valkey immediately. Calling disconnect will not send further pending commands to the Valkey server, or wait for or parse outstanding responses.
`typescript`
await client.disconnect();
Node Valkey will automatically pipeline requests that are made during the same "tick".
`typescript`
client.set('Tm9kZSBSZWRpcw==', 'users:1');
client.sAdd('users:1:tokens', 'Tm9kZSBSZWRpcw==');
Of course, if you don't do something with your Promises you're certain to get unhandled Promise exceptions. To take advantage of auto-pipelining and handle your Promises, use Promise.all().
`typescript`
await Promise.all([
client.set('Tm9kZSBSZWRpcw==', 'users:1'),
client.sAdd('users:1:tokens', 'Tm9kZSBSZWRpcw==')
]);
Check out the Clustering Guide when using Node Valkey to connect to a Valkey Cluster.
The Node Valkey client class is an Nodejs EventEmitter and it emits an event each time the network status changes:
| Name | When | Listener arguments |
|-------------------------|------------------------------------------------------------------------------------|------------------------------------------------------------|
| connect | Initiating a connection to the server | No arguments |ready
| | Client is ready to use | No arguments |end
| | Connection has been closed (via .quit() or .disconnect()) | No arguments |error
| | An error has occurred—usually a network issue such as "Socket closed unexpectedly" | (error: Error) |reconnecting
| | Client is trying to reconnect to the server | No arguments |sharded-channel-moved
| | See here | See here |
> :warning: You MUST listen to error events. If a client doesn't have at least one error listener registered and an error occurs, that error will be thrown and the Node.js process will exit. See the EventEmitter` docs for more details.
> The client will not emit any other events beyond those listed above.
Node Valkey is supported with the following versions of Valkey:
| Version | Supported |
|---------|--------------------|
| 7.0.z | :heavy_check_mark: |
> Node Valkey should work with older versions of Valkey, but it is not fully tested and we cannot offer support.
If you'd like to contribute, check out the contributing guide.
Thank you to all the people who already contributed to Node Valkey!
This repository is licensed under the "MIT" license. See LICENSE.