Security News
RubyGems.org Adds New Maintainer Role
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
handy-redis
Advanced tools
A redis client with first-class Promise and TypeScript support, and extensive documentation.
A wrapper around node_redis with Promise and TypeScript support.
node_redis doesn't support Promises out-of-the-box - you have to use util.promisify
on each command, or bluebird's promisifyAll
, which has the side effect of removing all TypeScript/intellisense support from the package.
This package is a wrapper around node_redis and exclusively uses Promises. It publishes TypeScript types generated from the official redis documentation and examples, so it's much easier to know what parameters a command expects, and how to use the return values.
npm install handy-redis redis
ES6/TypeScript:
import { createNodeRedisClient } from 'handy-redis';
(async function() {
const client = createNodeRedisClient();
// or, call createNodeRedisClient(opts) using opts for https://www.npmjs.com/package/redis#rediscreateclient
// or, call createNodeRedisClient(oldClient) where oldClient is an existing node_redis client.
await client.set('foo', 'bar');
const foo = await client.get('foo');
console.log(foo);
})();
Vanilla JS, no async/await:
const { createNodeRedisClient } = require('handy-redis');
const client = createNodeRedisClient();
client
.set('foo', 'bar')
.then(() => client.get('foo'))
.then(foo => console.log(foo));
The package is published with TypeScript types, with the redis documentation and response type attached to each command:
Note that the redis
package should be installed separately. If you need to use recent redis commands (e.g. lpos
(recent at time of writing, at least)), which is not included in the redis
package by default, you can use addNodeRedisCommand
:
import { addNodeRedisCommand, createNodeRedisClient } from 'handy-redis'
addNodeRedisCommand('lpos')
const client = createNodeRedisClient(...)
If there's a command without a type, a new version of this library will need to be released - raise an issue if you come across one.
Some features of node_redis are not duplicated in this library, such as watch
, pubsub and events generally. To use them, get the underlying client via .nodeRedis
:
import { createNodeRedisClient } from 'handy-redis'
const client = createNodeRedisClient(...)
client.nodeRedis.on('error', err => console.error(err))
client.nodeRedis.publish('a_channel', 'a message')
Some aliases exist for backwards-compatibility with v1.x:
createNodeRedisClient
(preferred) is aliased to createHandyClient
WrappedNodeRedisClient
(preferred) is aliased to IHandyRedis
client.nodeRedis
(preferred) is aliased to client.redis
See the snapshot tests for tons of usage examples.
Most members of node_redis's multi
type don't need to be promisified, because they execute synchronously. Only exec
is async. Usage example:
import { createNodeRedisClient } from 'handy-redis';
(async function() {
const client = createNodeRedisClient();
const result = await client.multi().set("z:foo", "987").keys("z:*").get("z:foo").exec();
console.log(result); // ["OK", ["z:foo"], "987"]
})();
The resolved value returned by exec
is a tuple type, which keeps track of the commands that have been queued. In the above example, the type will be [string, string[], string]
.
Note: multi
results are strongly-typed only when using typescript 4.0 and above - for lower typescript versions they will gracefully fall back to a union type (for the example above, it'll be Array<string | string[]>
).
client.batch()
also works, with the same API. See node_redis docs for details.
The client no longer has an execMulti
function. Use the .exec()
method on the multi instance.
Since the types are autogenerated from redis-doc, which doesn't adhere to a formal schema, they might be incomplete, or in some cases, wrong. The errors are easy enough to fix, but not easy to find, so if you think you've come across a case like this, please raise an issue.
Most of the package is generated by running sample commands from the redis documentation repo.
The client is generated from the redis-doc repo.
yarn codegen
generates code:
generate-schema
:
SET
might have args ['foo', 'bar', ['EX', 60]]
corresponding to the CLI command SET foo bar EX 60
generate-client
:
Multi
interface requires a key pointing to a property on a ResultTypes<Result, Context>
interface, with properties defined via module augmentation. By default, each command returns a promisified result type. See the node_redis multi implementation for an example which configures each command to return a chainable multi instance, using previous commands as the Context
.generate-tests
:
SET FOO BAR EX 60
is decoded into client.set('foo', 'bar', ['EX', 60])
At each stage, there are some patches to plug gaps and inconsistencies in redis-doc and node_redis.
From all the code-generation only the interface file is exported. When a client is created, each command on the node_redis client prototype is added as a method on handy-redis's client, a wrapped and promisified version of the equivalent node_redis method.
git clone https://github.com/mmkal/handy-redis
cd handy-redis
yarn
Make sure you have docker installed and docker-compose
is on your path, and start up a redis server in the background with yarn redis:up -d
.
To fully test the package as it is on your machine, the same way CI does:
yarn test
yarn test
runs the build, test and lint scripts. It removes all generated code before, and after checks that your git status is clean. This is to allow tracking changes to the generated client over time, to make what the published package contains more visible, and to make sure that generated code hasn't been modified without auditing first. You should not manually edit any files under a */generated/*
path. If yarn test
fails for you because you deliberately changed the way the codegen works, take a look at the git changes, check them in and run yarn test
again.
The build
script generates the client before using TypeScript to compile it. If you want to run the tests without rebuilding, linting etc., use yarn jest
.
There are some more scripts in package.json
which can be useful for local development.
Redis doc was added via git subtree add --prefix docs/redis-doc https://github.com/redis/redis-doc master --squash
following this guide. Here's how they say it can be updated:
git subtree pull --prefix docs/redis-doc https://github.com/redis/redis-doc master --squash
If a snapshot test fails, it's possible it just needs to be updated. Make sure your git status is clean and run yarn jest -u
.
Types are tested using expect-type.
FAQs
A redis client with first-class Promise and TypeScript support, and extensive documentation.
The npm package handy-redis receives a total of 0 weekly downloads. As such, handy-redis popularity was classified as not popular.
We found that handy-redis demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.