ioredis
π A robust, performance-focused, and full-featured Redis client for Node.js.
File Explorer
Download Latest Version (.zip)- SKILL.md
- doc-coverage-checklist.md
- SKILL.md
- SKILL.md
- evaluation-framework.md
- SKILL.md
- SKILL.md
- error-cases.md
- redis-runtime-patterns.md
- repo-import-patterns.md
- reporting-format.md
- validation-matrix.md
- typescript_probe.ts
- SKILL.md
- skills
- manual.yml
- push-requests.yml
- release.yml
- stale-issues.yml
- test.yml
- test_with_cov.yml
- CONTRIBUTING.md
- FUNDING.yml
- stale.yml
- generate.ts
- insert.ts
- autopipelining-cluster.ts
- autopipelining-single.ts
- dropBuffer.ts
- errorStack.ts
- argumentTypes.js
- generate-version.js
- index.js
- overrides.js
- returnTypes.js
- sortArguments.js
- template.ts
- typeMaps.js
- highlight.css
- icons.js
- icons.svg
- main.js
- navigation.js
- search.js
- style.css
- AbstractConnector.html
- Cluster.html
- Command.html
- Pipeline.html
- Redis.html
- ScanStream.html
- SentinelConnector.html
- SentinelIterator.html
- BatchOperationContext.html
- ChainableCommander.html
- ClusterOptions.html
- CommandTraceContext.html
- CommonRedisOptions.html
- ConnectTraceContext.html
- HimportFieldset.html
- RedisCommander.html
- ScanStreamOptions.html
- SentinelAddress.html
- SentinelConnectionOptions.html
- Callback.html
- ClientContext.html
- ClusterNode.html
- ClusterStatus.html
- DNSLookupFunction.html
- DNSResolveSrvFunction.html
- NatMap.html
- NodeRole.html
- RedisKey.html
- RedisOptions.html
- RedisStatus.html
- RedisValue.html
- Result.html
- StandaloneConnectionOptions.html
- ReplyError.html
- .nojekyll
- hierarchy.html
- index.html
- www
- style.css
- index.js
- users.js
- error.jade
- index.jade
- layout.jade
- users.jade
- app.js
- package-lock.json
- package.json
- README.md
- redis.js
- package-lock.json
- package.json
- scripts.ts
- basic_operations.js
- custom_connector.js
- hash.js
- himport.js
- list.js
- module.js
- redis_streams.js
- set.js
- stream.js
- string.js
- ttl.js
- zset.js
- ClusterOptions.ts
- ClusterSubscriber.ts
- ClusterSubscriberGroup.ts
- ConnectionPool.ts
- DelayQueue.ts
- index.ts
- ShardedSubscriber.ts
- util.ts
- FailoverDetector.ts
- index.ts
- SentinelIterator.ts
- types.ts
- AbstractConnector.ts
- ConnectorConstructor.ts
- index.ts
- StandaloneConnector.ts
- TLSProfiles.ts
- ClusterAllFailedError.ts
- index.ts
- MaxRetriesPerRequestError.ts
- HimportCoordinator.ts
- types.ts
- event_handler.ts
- RedisOptions.ts
- decoder.ts
- errors.ts
- types.ts
- verbatim-string.ts
- applyMixin.ts
- argumentParsers.ts
- Commander.ts
- debug.ts
- defaults.ts
- index.ts
- isArguments.ts
- lodash.ts
- RedisCommander.ts
- version.ts
- autoPipelining.ts
- Command.ts
- DataHandler.ts
- index.ts
- Pipeline.ts
- Redis.ts
- replyTransformers.ts
- ScanStream.ts
- Script.ts
- SubscriptionSet.ts
- tracing.ts
- transaction.ts
- types.ts
- medis.png
- redis-tryfree.png
- ts-screenshot.png
- upstash.png
- asking.ts
- cluster.ts
- resp3.ts
- Dockerfile
- main.sh
- basic.ts
- cluster_subscriber_group.ts
- ask.ts
- autopipelining.ts
- clusterdown.ts
- ClusterSubscriber.ts
- connect.ts
- disconnection.ts
- dnsLookup.ts
- duplicate.ts
- himport.ts
- index.ts
- maxRedirections.ts
- moved.ts
- nat.ts
- node_reconnect.ts
- pipeline.ts
- pub_sub.ts
- quit.ts
- resolveSrv.ts
- scripting.ts
- spub_ssub.ts
- tls.ts
- transaction.ts
- tryagain.ts
- acl.ts
- append.ts
- array.ts
- auth.ts
- bitcount.ts
- bitfield.ts
- bitfield_ro.ts
- bitop.ts
- bitpos.ts
- blmove.ts
- blmovem.ts
- blmpop.ts
- blpop.ts
- brpop.ts
- brpoplpush.ts
- bzmpop.ts
- bzpopmax.ts
- bzpopmin.ts
- client.ts
- command.ts
- config.ts
- copy.ts
- dbsize.ts
- decr.ts
- decrby.ts
- del.ts
- dump.ts
- echo.ts
- eval.ts
- eval_ro.ts
- evalsha.ts
- evalsha_ro.ts
- exists.ts
- expire.ts
- expireat.ts
- expiretime.ts
- fcall.ts
- fcall_ro.ts
- function.ts
- geoadd.ts
- geodist.ts
- geohash.ts
- geopos.ts
- georadius.ts
- georadius_ro.ts
- georadiusbymember.ts
- georadiusbymember_ro.ts
- geosearch.ts
- geosearchstore.ts
- get.ts
- getbit.ts
- getdel.ts
- getex.ts
- getrange.ts
- getset.ts
- hdel.ts
- hello.ts
- hexists.ts
- hexpire.ts
- hexpireat.ts
- hexpiretime.ts
- hget.ts
- hgetall.ts
- hgetdel.ts
- hgetex.ts
- himport.ts
- hincrby.ts
- hincrbyfloat.ts
- hkeys.ts
- hlen.ts
- hmget.ts
- hmset.ts
- hpersist.ts
- hpexpire.ts
- hpexpireat.ts
- hpexpiretime.ts
- hpttl.ts
- hrandfield.ts
- hscan.ts
- hset.ts
- hsetex.ts
- hsetnx.ts
- hstrlen.ts
- httl.ts
- hvals.ts
- incr.ts
- incrby.ts
- incrbyfloat.ts
- increx.ts
- info.ts
- keys.ts
- lastsave.ts
- latency.ts
- lcs.ts
- lindex.ts
- linsert.ts
- llen.ts
- lmove.ts
- lmovem.ts
- lmpop.ts
- lolwut.ts
- lpop.ts
- lpos.ts
- lpush.ts
- lpushx.ts
- lrange.ts
- lrem.ts
- lset.ts
- ltrim.ts
- memory.ts
- mget.ts
- module.ts
- move.ts
- mset.ts
- msetex.ts
- msetnx.ts
- object.ts
- persist.ts
- pexpire.ts
- pexpireat.ts
- pexpiretime.ts
- pfadd.ts
- pfcount.ts
- pfmerge.ts
- ping.ts
- psubscribe.ts
- pttl.ts
- publish.ts
- pubsub.ts
- punsubscribe.ts
- randomkey.ts
- readonly.ts
- readwrite.ts
- rename.ts
- renamenx.ts
- restore.ts
- role.ts
- rpop.ts
- rpoplpush.ts
- rpush.ts
- rpushx.ts
- sadd.ts
- scan.ts
- scard.ts
- script.ts
- sdiff.ts
- sdiffcard.ts
- sdiffstore.ts
- select.ts
- set.ts
- setbit.ts
- setex.ts
- setnx.ts
- setrange.ts
- sinter.ts
- sintercard.ts
- sinterstore.ts
- sismember.ts
- slowlog.ts
- smembers.ts
- smismember.ts
- smove.ts
- sort.ts
- sort_ro.ts
- spop.ts
- spublish.ts
- srandmember.ts
- srem.ts
- sscan.ts
- ssubscribe.ts
- strlen.ts
- subscribe.ts
- substr.ts
- sunion.ts
- sunioncard.ts
- sunionstore.ts
- sunsubscribe.ts
- time.ts
- touch.ts
- ttl.ts
- type.ts
- unlink.ts
- unsubscribe.ts
- vector_set.ts
- wait.ts
- xack.ts
- xadd.ts
- xautoclaim.ts
- xclaim.ts
- xdel.ts
- xdelex.ts
- xgroup.ts
- xinfo.ts
- xlen.ts
- xnack.ts
- xpending.ts
- xrange.ts
- xread.ts
- xreadgroup.ts
- xrevrange.ts
- xsetid.ts
- xtrim.ts
- zadd.ts
- zcard.ts
- zcount.ts
- zdiff.ts
- zdiffstore.ts
- zincrby.ts
- zinter.ts
- zintercard.ts
- zinterstore.ts
- zlexcount.ts
- zmpop.ts
- zmscore.ts
- zpopmax.ts
- zpopmin.ts
- zrandmember.ts
- zrange.ts
- zrangebylex.ts
- zrangebyscore.ts
- zrangestore.ts
- zrank.ts
- zrem.ts
- zremrangebylex.ts
- zremrangebyrank.ts
- zremrangebyscore.ts
- zrevrange.ts
- zrevrangebylex.ts
- zrevrangebyscore.ts
- zrevrank.ts
- zscan.ts
- zscore.ts
- zunion.ts
- zunionstore.ts
- auth.ts
- autopipelining.ts
- blocking_timeout.ts
- client_info.ts
- commandTimeout.ts
- connection.ts
- disconnection.ts
- duplicate.ts
- elasticache.ts
- exports.ts
- fatal_error.ts
- hash_field_subkey_notifications.ts
- hgetall.ts
- lazy_connect.ts
- maxRetriesPerRequest.ts
- monitor.ts
- pipeline.ts
- protocol_downgrade.ts
- pub_sub.ts
- ready_check.ts
- reconnect_on_error.ts
- reply_mapping.ts
- scan_stream.ts
- scripting.ts
- select.ts
- send_command.ts
- sentinel.ts
- sentinel_nat.ts
- show_friendly_error_stack.ts
- socketTimeout.ts
- spub_ssub.ts
- string_numbers.ts
- tls.ts
- tracing.ts
- transaction.ts
- transformer.ts
- watch-exec.ts
- global.ts
- mock_server.ts
- respConfigs.ts
- util.ts
- basic.test.ts
- connection-lifecycle.test.ts
- failure-recovery.multi.test.ts
- failure-recovery.single.test.ts
- command-runner.ts
- fault-injector.ts
- message-tracker.ts
- test.util.ts
- commands.test-d.ts
- events.test-.ts
- exports.test-d.ts
- options.test-d.ts
- pipeline.test-d.ts
- resp3.test-d.ts
- transformers.test-d.ts
- ConnectionPool.ts
- index.ts
- SentinelIterator.ts
- connector.ts
- decoder.ts
- autoPipelining.ts
- command.ts
- commander.ts
- DataHandler.ts
- debug.ts
- HimportCoordinator.ts
- index.ts
- pipeline.ts
- redis.ts
- replyTransformers.ts
- utils.ts
- docker-compose.yml
- .eslintrc.json
- .gitignore
- .prettierignore
- .releaserc.json
- AGENTS.md
- CHANGELOG.md
- CLAUDE.md
- CODE_OF_CONDUCT.md
- LICENSE
- logo.svg
- package-lock.json
- package.json
- README.md
- SECURITY.md
- tsconfig.json
# Installation Guide
1. Get the code
git clone https://github.com/redis/ioredis
Downloads the entire project code from GitHub to your computer.
cd ioredis
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
npm install ioredis
Downloads and installs the libraries listed in package.json.
npm install --save-dev @types/node
Downloads and installs the libraries listed in package.json.
npm test
Type this command into your terminal and run it.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)