ioredis util to delete keys by pattern on redis. Supports batches (pipeline) and lets the user decide to use `del` or `unlink` methods.
npm install @eturino/ioredis-del-by-pattern@eturino/ioredis-del-by-pattern
TypeDoc generated docs in here
ioredis util to delete keys by pattern on redis. Supports batches (pipeline) and lets the user decide to use del or unlink methods.
It uses a scanStream in ioredis to gather the matched keys to remove.
yarn add @eturino/ioredis-del-by-pattern or npm install @eturino/ioredis-del-by-pattern.
The exported function redisDelByPattern() returns a promise with the number of keys deleted in total, using the given pattern and redis client.
``typescript
import { redisDelByPattern } from "@eturino/ioredis-del-by-pattern";
const deletedKeysCount: number = await redisDelByPattern({
pattern: "delete-with-this-prefix-*",
redis // ioredis client
});
`
It supports the following params:
- redis: redis client. (REQUIRED)pattern
- : match in the redis scan stream. (REQUIRED)deletionMethod
- : determines the usage of DEL or UNLINK commands (Unlink by default).withPipeline
- : decide to use a pipeline to execute the commands or on each stream event (no pipeline by default).pipelineBatchLimit
- : 100 by default, in effect if withPipeline is true.enableLog
- : if true, actions will be logged using the given logFn.logFn
- : function to execute to log events. Defaults to (console.log).logWarnFn
- : function to execute to log events for warn. Defaults to (console.warn).logPrefix
- : prefix to the logFn (defaults to "[REDIS-DEL-BY-PATTERN] ").
`typescript
import { redisDelByPattern } from "@eturino/ioredis-del-by-pattern";
const deletedKeysCount: number = await redisDelByPattern({
pattern: ${prefix}-delete-me*,`
redis, // ioredis client
withPipeline: true,
deletionMethod: RedisDeletionMethod.unlink
});
The batched function implementation is heavily based on the article "Find and Delete multiple keys matching by a pattern in Redis: The right way
" by Ankit Jain
For commits, you should use commitizen
`sh
yarn global add commitizen
#commit your changes:
git cz
`
As typescript-starter docs state:
This project is tooled for conventional changelog to make managing releases easier. See the standard-version documentation for more information on the workflow, or CHANGELOG.md for an example.
`sh`bump package.json version, update CHANGELOG.md, git tag the release
yarn run version
You may find a tool like wip helpful for managing work in progress before you're ready to create a meaningful commit.
Once you are ready to create the first version, run the following (note that reset is destructive and will remove all files not in the git repo from the directory).
`shReset the repo to the latest commit and build everything
yarn run reset && yarn run test && yarn run doc:html
And after that, remember to publish the docs.
And finally push the new tags to github and publish the package to npm.
sh
Push to git
git push --follow-tags origin masterPublish to NPM (allowing public access, required if the package name is namespaced like
@somewhere/some-lib)
yarn publish --access public
`$3
sh
yarn run doc:html && yarn run doc:publish
`This will generate the docs and publish them in github pages.
$3
There is a single yarn command for preparing a new release. See One-step publish preparation script in TypeScript-Starter
sh
Prepare a standard release
yarn prepare-releasePush to git
git push --follow-tags origin masterPublish to NPM (allowing public access, required if the package name is namespaced like
@somewhere/some-lib)
yarn publish --access public
``