From f5709988b98d8d6c2050b7a2d9cd4e35c232117f Mon Sep 17 00:00:00 2001 From: documentation-bot Date: Wed, 29 Dec 2021 01:22:53 +0000 Subject: [PATCH] Updates --- .../client/classes/lib_client.default.html | 18 +++++++++--------- .../lib_client_commands_queue.default.html | 2 +- .../lib_client_multi_command.default.html | 2 +- .../classes/lib_client_socket.default.html | 10 +++++----- .../client/classes/lib_cluster.default.html | 16 ++++++++-------- .../lib_cluster_cluster_slots.default.html | 2 +- .../lib_cluster_multi_command.default.html | 2 +- .../client/classes/lib_errors.AbortError.html | 2 +- .../client/classes/lib_errors.AuthError.html | 2 +- .../classes/lib_errors.ClientClosedError.html | 2 +- .../lib_errors.ConnectionTimeoutError.html | 2 +- .../lib_errors.DisconnectsClientError.html | 2 +- ...b_errors.SocketClosedUnexpectedlyError.html | 2 +- .../client/classes/lib_errors.WatchError.html | 2 +- .../classes/lib_multi_command.default.html | 2 +- ...commands_queue.PubSubSubscribeCommands.html | 2 +- ...mmands_queue.PubSubUnsubscribeCommands.html | 2 +- ...commands_CLIENT_KILL.ClientKillFilters.html | 2 +- ...USTER_NODES.RedisClusterNodeLinkStates.html | 2 +- ...ands_CLUSTER_SETSLOT.ClusterSlotStates.html | 2 +- .../lib_commands_FLUSHALL.RedisFlushModes.html | 2 +- ...generic_transformers.CommandCategories.html | 2 +- ...ands_generic_transformers.CommandFlags.html | 2 +- ...ands_generic_transformers.GeoReplyWith.html | 2 +- .../lib_client.ClientCommandOptions.html | 2 +- .../lib_client.RedisClientOptions.html | 2 +- ...ent_commands_queue.QueueCommandOptions.html | 2 +- ...client_socket.RedisSocketCommonOptions.html | 2 +- ...ib_client_socket.RedisTlsSocketOptions.html | 10 +++++----- .../lib_cluster.RedisClusterOptions.html | 2 +- .../lib_cluster_cluster_slots.ClusterNode.html | 2 +- .../interfaces/lib_commands.RedisCommand.html | 2 +- .../interfaces/lib_commands.RedisPlugins.html | 2 +- .../lib_commands_AUTH.AuthOptions.html | 2 +- ...s_CLUSTER_NODES.RedisClusterMasterNode.html | 2 +- ..._CLUSTER_NODES.RedisClusterReplicaNode.html | 2 +- .../lib_commands_HSCAN.HScanTuple.html | 2 +- .../lib_commands_LPOS.LPosOptions.html | 2 +- .../lib_commands_SCAN.ScanCommandOptions.html | 2 +- .../lib_commands_SCAN.ScanReply.html | 2 +- ..._commands_XAUTOCLAIM.XAutoClaimOptions.html | 2 +- .../lib_commands_XCLAIM.XClaimOptions.html | 2 +- ..._commands_XREADGROUP.XReadGroupOptions.html | 2 +- ...b_commands_XREADGROUP.XReadGroupStream.html | 2 +- ...ommands_ZRANGEBYLEX.ZRangeByLexOptions.html | 2 +- ...nds_ZRANGEBYSCORE.ZRangeByScoreOptions.html | 2 +- ...mands_generic_transformers.EvalOptions.html | 2 +- ...ds_generic_transformers.GeoCoordinates.html | 2 +- ...eneric_transformers.GeoReplyWithMember.html | 2 +- ..._generic_transformers.GeoSearchOptions.html | 2 +- ...mands_generic_transformers.ScanOptions.html | 2 +- ...eneric_transformers.StreamMessageReply.html | 2 +- ..._commands_generic_transformers.ZMember.html | 2 +- .../lib_lua_script.RedisScriptConfig.html | 2 +- .../client/interfaces/lib_lua_script.SHA1.html | 2 +- ..._multi_command.RedisMultiQueuedCommand.html | 2 +- documentation/client/modules/index.html | 2 +- documentation/client/modules/lib_client.html | 2 +- .../modules/lib_client_commands_queue.html | 2 +- .../modules/lib_client_multi_command.html | 2 +- .../client/modules/lib_client_socket.html | 2 +- documentation/client/modules/lib_cluster.html | 2 +- .../modules/lib_cluster_multi_command.html | 2 +- .../client/modules/lib_command_options.html | 2 +- .../client/modules/lib_commander.html | 2 +- documentation/client/modules/lib_commands.html | 2 +- .../client/modules/lib_commands_ACL_CAT.html | 2 +- .../modules/lib_commands_ACL_DELUSER.html | 2 +- .../modules/lib_commands_ACL_GENPASS.html | 2 +- .../modules/lib_commands_ACL_GETUSER.html | 2 +- .../client/modules/lib_commands_ACL_LIST.html | 2 +- .../client/modules/lib_commands_ACL_LOAD.html | 2 +- .../client/modules/lib_commands_ACL_LOG.html | 2 +- .../modules/lib_commands_ACL_LOG_RESET.html | 2 +- .../client/modules/lib_commands_ACL_SAVE.html | 2 +- .../modules/lib_commands_ACL_SETUSER.html | 2 +- .../client/modules/lib_commands_ACL_USERS.html | 2 +- .../modules/lib_commands_ACL_WHOAMI.html | 2 +- .../client/modules/lib_commands_APPEND.html | 2 +- .../client/modules/lib_commands_ASKING.html | 2 +- .../client/modules/lib_commands_AUTH.html | 2 +- .../modules/lib_commands_BGREWRITEAOF.html | 2 +- .../client/modules/lib_commands_BGSAVE.html | 2 +- .../client/modules/lib_commands_BITCOUNT.html | 2 +- .../client/modules/lib_commands_BITFIELD.html | 2 +- .../client/modules/lib_commands_BITOP.html | 2 +- .../client/modules/lib_commands_BITPOS.html | 2 +- .../client/modules/lib_commands_BLMOVE.html | 2 +- .../client/modules/lib_commands_BLPOP.html | 2 +- .../client/modules/lib_commands_BRPOP.html | 2 +- .../modules/lib_commands_BRPOPLPUSH.html | 2 +- .../client/modules/lib_commands_BZPOPMAX.html | 2 +- .../client/modules/lib_commands_BZPOPMIN.html | 2 +- .../modules/lib_commands_CLIENT_CACHING.html | 2 +- .../modules/lib_commands_CLIENT_GETNAME.html | 2 +- .../modules/lib_commands_CLIENT_GETREDIR.html | 2 +- .../client/modules/lib_commands_CLIENT_ID.html | 2 +- .../modules/lib_commands_CLIENT_INFO.html | 2 +- .../modules/lib_commands_CLIENT_KILL.html | 2 +- .../modules/lib_commands_CLIENT_SETNAME.html | 2 +- .../modules/lib_commands_CLUSTER_ADDSLOTS.html | 2 +- .../lib_commands_CLUSTER_FLUSHSLOTS.html | 2 +- .../lib_commands_CLUSTER_GETKEYSINSLOT.html | 2 +- .../modules/lib_commands_CLUSTER_INFO.html | 2 +- .../modules/lib_commands_CLUSTER_MEET.html | 2 +- .../modules/lib_commands_CLUSTER_NODES.html | 2 +- .../modules/lib_commands_CLUSTER_RESET.html | 2 +- .../modules/lib_commands_CLUSTER_SETSLOT.html | 2 +- .../modules/lib_commands_CLUSTER_SLOTS.html | 2 +- .../client/modules/lib_commands_COMMAND.html | 2 +- .../modules/lib_commands_COMMAND_COUNT.html | 2 +- .../modules/lib_commands_COMMAND_GETKEYS.html | 2 +- .../modules/lib_commands_COMMAND_INFO.html | 2 +- .../modules/lib_commands_CONFIG_GET.html | 2 +- .../modules/lib_commands_CONFIG_RESETSTAT.html | 2 +- .../modules/lib_commands_CONFIG_REWRITE.html | 2 +- .../modules/lib_commands_CONFIG_SET.html | 2 +- .../client/modules/lib_commands_COPY.html | 2 +- .../client/modules/lib_commands_DBSIZE.html | 2 +- .../client/modules/lib_commands_DECR.html | 2 +- .../client/modules/lib_commands_DECRBY.html | 2 +- .../client/modules/lib_commands_DEL.html | 2 +- .../client/modules/lib_commands_DISCARD.html | 2 +- .../client/modules/lib_commands_DUMP.html | 2 +- .../client/modules/lib_commands_ECHO.html | 2 +- .../client/modules/lib_commands_EVAL.html | 2 +- .../client/modules/lib_commands_EVALSHA.html | 2 +- .../client/modules/lib_commands_EXISTS.html | 2 +- .../client/modules/lib_commands_EXPIRE.html | 2 +- .../client/modules/lib_commands_EXPIREAT.html | 2 +- .../client/modules/lib_commands_FAILOVER.html | 2 +- .../client/modules/lib_commands_FLUSHALL.html | 2 +- .../client/modules/lib_commands_FLUSHDB.html | 2 +- .../client/modules/lib_commands_GEOADD.html | 2 +- .../client/modules/lib_commands_GEODIST.html | 2 +- .../client/modules/lib_commands_GEOHASH.html | 2 +- .../client/modules/lib_commands_GEOPOS.html | 2 +- .../client/modules/lib_commands_GEOSEARCH.html | 2 +- .../modules/lib_commands_GEOSEARCHSTORE.html | 2 +- .../modules/lib_commands_GEOSEARCH_WITH.html | 2 +- .../client/modules/lib_commands_GET.html | 2 +- .../client/modules/lib_commands_GETBIT.html | 2 +- .../client/modules/lib_commands_GETDEL.html | 2 +- .../client/modules/lib_commands_GETEX.html | 2 +- .../client/modules/lib_commands_GETRANGE.html | 2 +- .../client/modules/lib_commands_GETSET.html | 2 +- .../client/modules/lib_commands_HDEL.html | 2 +- .../client/modules/lib_commands_HELLO.html | 2 +- .../client/modules/lib_commands_HEXISTS.html | 2 +- .../client/modules/lib_commands_HGET.html | 2 +- .../client/modules/lib_commands_HGETALL.html | 2 +- .../client/modules/lib_commands_HINCRBY.html | 2 +- .../modules/lib_commands_HINCRBYFLOAT.html | 2 +- .../client/modules/lib_commands_HKEYS.html | 2 +- .../client/modules/lib_commands_HLEN.html | 2 +- .../client/modules/lib_commands_HMGET.html | 2 +- .../modules/lib_commands_HRANDFIELD.html | 2 +- .../modules/lib_commands_HRANDFIELD_COUNT.html | 2 +- ...b_commands_HRANDFIELD_COUNT_WITHVALUES.html | 2 +- .../client/modules/lib_commands_HSCAN.html | 2 +- .../client/modules/lib_commands_HSET.html | 2 +- .../client/modules/lib_commands_HSETNX.html | 2 +- .../client/modules/lib_commands_HSTRLEN.html | 2 +- .../client/modules/lib_commands_HVALS.html | 2 +- .../client/modules/lib_commands_INCR.html | 2 +- .../client/modules/lib_commands_INCRBY.html | 2 +- .../modules/lib_commands_INCRBYFLOAT.html | 2 +- .../client/modules/lib_commands_INFO.html | 2 +- .../client/modules/lib_commands_KEYS.html | 2 +- .../client/modules/lib_commands_LASTSAVE.html | 2 +- .../client/modules/lib_commands_LINDEX.html | 2 +- .../client/modules/lib_commands_LINSERT.html | 2 +- .../client/modules/lib_commands_LLEN.html | 2 +- .../client/modules/lib_commands_LMOVE.html | 2 +- .../client/modules/lib_commands_LOLWUT.html | 2 +- .../client/modules/lib_commands_LPOP.html | 2 +- .../modules/lib_commands_LPOP_COUNT.html | 2 +- .../client/modules/lib_commands_LPOS.html | 2 +- .../modules/lib_commands_LPOS_COUNT.html | 2 +- .../client/modules/lib_commands_LPUSH.html | 2 +- .../client/modules/lib_commands_LPUSHX.html | 2 +- .../client/modules/lib_commands_LRANGE.html | 2 +- .../client/modules/lib_commands_LREM.html | 2 +- .../client/modules/lib_commands_LSET.html | 2 +- .../client/modules/lib_commands_LTRIM.html | 2 +- .../modules/lib_commands_MEMORY_DOCTOR.html | 2 +- .../lib_commands_MEMORY_MALLOC_STATS.html | 2 +- .../modules/lib_commands_MEMORY_PURGE.html | 2 +- .../modules/lib_commands_MEMORY_STATS.html | 2 +- .../modules/lib_commands_MEMORY_USAGE.html | 2 +- .../client/modules/lib_commands_MGET.html | 2 +- .../client/modules/lib_commands_MIGRATE.html | 2 +- .../modules/lib_commands_MODULE_LIST.html | 2 +- .../modules/lib_commands_MODULE_LOAD.html | 2 +- .../modules/lib_commands_MODULE_UNLOAD.html | 2 +- .../client/modules/lib_commands_MOVE.html | 2 +- .../client/modules/lib_commands_MSET.html | 2 +- .../client/modules/lib_commands_MSETNX.html | 2 +- .../client/modules/lib_commands_PERSIST.html | 2 +- .../client/modules/lib_commands_PEXPIRE.html | 2 +- .../client/modules/lib_commands_PEXPIREAT.html | 2 +- .../client/modules/lib_commands_PFADD.html | 2 +- .../client/modules/lib_commands_PFCOUNT.html | 2 +- .../client/modules/lib_commands_PFMERGE.html | 2 +- .../client/modules/lib_commands_PING.html | 2 +- .../client/modules/lib_commands_PSETEX.html | 2 +- .../client/modules/lib_commands_PTTL.html | 2 +- .../client/modules/lib_commands_PUBLISH.html | 2 +- .../modules/lib_commands_PUBSUB_CHANNELS.html | 2 +- .../modules/lib_commands_PUBSUB_NUMPAT.html | 2 +- .../modules/lib_commands_PUBSUB_NUMSUB.html | 2 +- .../client/modules/lib_commands_RANDOMKEY.html | 2 +- .../client/modules/lib_commands_READONLY.html | 2 +- .../client/modules/lib_commands_READWRITE.html | 2 +- .../client/modules/lib_commands_RENAME.html | 2 +- .../client/modules/lib_commands_RENAMENX.html | 2 +- .../client/modules/lib_commands_REPLICAOF.html | 2 +- .../modules/lib_commands_RESTORE_ASKING.html | 2 +- .../client/modules/lib_commands_ROLE.html | 2 +- .../client/modules/lib_commands_RPOP.html | 2 +- .../client/modules/lib_commands_RPOPLPUSH.html | 2 +- .../modules/lib_commands_RPOP_COUNT.html | 2 +- .../client/modules/lib_commands_RPUSH.html | 2 +- .../client/modules/lib_commands_RPUSHX.html | 2 +- .../client/modules/lib_commands_SADD.html | 2 +- .../client/modules/lib_commands_SAVE.html | 2 +- .../client/modules/lib_commands_SCAN.html | 2 +- .../client/modules/lib_commands_SCARD.html | 2 +- .../modules/lib_commands_SCRIPT_DEBUG.html | 2 +- .../modules/lib_commands_SCRIPT_EXISTS.html | 2 +- .../modules/lib_commands_SCRIPT_FLUSH.html | 2 +- .../modules/lib_commands_SCRIPT_KILL.html | 2 +- .../modules/lib_commands_SCRIPT_LOAD.html | 2 +- .../client/modules/lib_commands_SDIFF.html | 2 +- .../modules/lib_commands_SDIFFSTORE.html | 2 +- .../client/modules/lib_commands_SET.html | 2 +- .../client/modules/lib_commands_SETBIT.html | 2 +- .../client/modules/lib_commands_SETEX.html | 2 +- .../client/modules/lib_commands_SETNX.html | 2 +- .../client/modules/lib_commands_SETRANGE.html | 2 +- .../client/modules/lib_commands_SHUTDOWN.html | 2 +- .../client/modules/lib_commands_SINTER.html | 2 +- .../modules/lib_commands_SINTERSTORE.html | 2 +- .../client/modules/lib_commands_SISMEMBER.html | 2 +- .../client/modules/lib_commands_SMEMBERS.html | 2 +- .../modules/lib_commands_SMISMEMBER.html | 2 +- .../client/modules/lib_commands_SMOVE.html | 2 +- .../client/modules/lib_commands_SORT.html | 2 +- .../client/modules/lib_commands_SPOP.html | 2 +- .../modules/lib_commands_SRANDMEMBER.html | 2 +- .../lib_commands_SRANDMEMBER_COUNT.html | 2 +- .../client/modules/lib_commands_SREM.html | 2 +- .../client/modules/lib_commands_SSCAN.html | 2 +- .../client/modules/lib_commands_STRLEN.html | 2 +- .../client/modules/lib_commands_SUNION.html | 2 +- .../modules/lib_commands_SUNIONSTORE.html | 2 +- .../client/modules/lib_commands_SWAPDB.html | 2 +- .../client/modules/lib_commands_TIME.html | 2 +- .../client/modules/lib_commands_TOUCH.html | 2 +- .../client/modules/lib_commands_TTL.html | 2 +- .../client/modules/lib_commands_TYPE.html | 2 +- .../client/modules/lib_commands_UNLINK.html | 2 +- .../client/modules/lib_commands_UNWATCH.html | 2 +- .../client/modules/lib_commands_WAIT.html | 2 +- .../client/modules/lib_commands_WATCH.html | 2 +- .../client/modules/lib_commands_XACK.html | 2 +- .../client/modules/lib_commands_XADD.html | 2 +- .../modules/lib_commands_XAUTOCLAIM.html | 2 +- .../lib_commands_XAUTOCLAIM_JUSTID.html | 2 +- .../client/modules/lib_commands_XCLAIM.html | 2 +- .../modules/lib_commands_XCLAIM_JUSTID.html | 2 +- .../client/modules/lib_commands_XDEL.html | 2 +- .../modules/lib_commands_XGROUP_CREATE.html | 2 +- .../lib_commands_XGROUP_CREATECONSUMER.html | 2 +- .../lib_commands_XGROUP_DELCONSUMER.html | 2 +- .../modules/lib_commands_XGROUP_DESTROY.html | 2 +- .../modules/lib_commands_XGROUP_SETID.html | 2 +- .../modules/lib_commands_XINFO_CONSUMERS.html | 2 +- .../modules/lib_commands_XINFO_GROUPS.html | 2 +- .../modules/lib_commands_XINFO_STREAM.html | 2 +- .../client/modules/lib_commands_XLEN.html | 2 +- .../client/modules/lib_commands_XPENDING.html | 2 +- .../modules/lib_commands_XPENDING_RANGE.html | 2 +- .../client/modules/lib_commands_XRANGE.html | 2 +- .../client/modules/lib_commands_XREAD.html | 2 +- .../modules/lib_commands_XREADGROUP.html | 2 +- .../client/modules/lib_commands_XREVRANGE.html | 2 +- .../client/modules/lib_commands_XTRIM.html | 2 +- .../client/modules/lib_commands_ZADD.html | 2 +- .../client/modules/lib_commands_ZCARD.html | 2 +- .../client/modules/lib_commands_ZCOUNT.html | 2 +- .../client/modules/lib_commands_ZDIFF.html | 2 +- .../modules/lib_commands_ZDIFFSTORE.html | 2 +- .../modules/lib_commands_ZDIFF_WITHSCORES.html | 2 +- .../client/modules/lib_commands_ZINCRBY.html | 2 +- .../client/modules/lib_commands_ZINTER.html | 2 +- .../modules/lib_commands_ZINTERSTORE.html | 2 +- .../lib_commands_ZINTER_WITHSCORES.html | 2 +- .../client/modules/lib_commands_ZLEXCOUNT.html | 2 +- .../client/modules/lib_commands_ZMSCORE.html | 2 +- .../client/modules/lib_commands_ZPOPMAX.html | 2 +- .../modules/lib_commands_ZPOPMAX_COUNT.html | 2 +- .../client/modules/lib_commands_ZPOPMIN.html | 2 +- .../modules/lib_commands_ZPOPMIN_COUNT.html | 2 +- .../modules/lib_commands_ZRANDMEMBER.html | 2 +- .../lib_commands_ZRANDMEMBER_COUNT.html | 2 +- ..._commands_ZRANDMEMBER_COUNT_WITHSCORES.html | 2 +- .../client/modules/lib_commands_ZRANGE.html | 2 +- .../modules/lib_commands_ZRANGEBYLEX.html | 2 +- .../modules/lib_commands_ZRANGEBYSCORE.html | 2 +- .../lib_commands_ZRANGEBYSCORE_WITHSCORES.html | 2 +- .../modules/lib_commands_ZRANGESTORE.html | 2 +- .../lib_commands_ZRANGE_WITHSCORES.html | 2 +- .../client/modules/lib_commands_ZRANK.html | 2 +- .../client/modules/lib_commands_ZREM.html | 2 +- .../modules/lib_commands_ZREMRANGEBYLEX.html | 2 +- .../modules/lib_commands_ZREMRANGEBYRANK.html | 2 +- .../modules/lib_commands_ZREMRANGEBYSCORE.html | 2 +- .../client/modules/lib_commands_ZREVRANK.html | 2 +- .../client/modules/lib_commands_ZSCAN.html | 2 +- .../client/modules/lib_commands_ZSCORE.html | 2 +- .../client/modules/lib_commands_ZUNION.html | 2 +- .../modules/lib_commands_ZUNIONSTORE.html | 2 +- .../lib_commands_ZUNION_WITHSCORES.html | 2 +- .../lib_commands_generic_transformers.html | 2 +- .../client/modules/lib_lua_script.html | 2 +- documentation/client/modules/lib_utils.html | 2 +- documentation/json/modules/commands.html | 2 +- .../json/modules/commands_ARRAPPEND.html | 2 +- .../json/modules/commands_ARRINDEX.html | 2 +- .../json/modules/commands_ARRINSERT.html | 2 +- .../json/modules/commands_ARRLEN.html | 2 +- .../json/modules/commands_ARRPOP.html | 2 +- .../json/modules/commands_ARRTRIM.html | 2 +- .../json/modules/commands_DEBUG_MEMORY.html | 2 +- documentation/json/modules/commands_DEL.html | 2 +- .../json/modules/commands_FORGET.html | 2 +- documentation/json/modules/commands_GET.html | 2 +- documentation/json/modules/commands_MGET.html | 2 +- .../json/modules/commands_NUMINCRBY.html | 2 +- .../json/modules/commands_NUMMULTBY.html | 2 +- .../json/modules/commands_OBJKEYS.html | 2 +- .../json/modules/commands_OBJLEN.html | 2 +- documentation/json/modules/commands_RESP.html | 2 +- documentation/json/modules/commands_SET.html | 2 +- .../json/modules/commands_STRAPPEND.html | 2 +- .../json/modules/commands_STRLEN.html | 2 +- documentation/json/modules/commands_TYPE.html | 2 +- .../enums/commands.RedisSearchLanguages.html | 2 +- .../enums/commands.SchemaFieldTypes.html | 2 +- .../commands.SchemaTextFieldPhonetics.html | 2 +- ...nds_AGGREGATE.AggregateGroupByReducers.html | 2 +- .../commands_AGGREGATE.AggregateSteps.html | 2 +- .../interfaces/commands.ProfileOptions.html | 2 +- .../interfaces/commands.ProfileReply.html | 2 +- .../interfaces/commands.SearchReply.html | 2 +- .../commands_AGGREGATE.AggregateOptions.html | 2 +- .../commands_AGGREGATE.AggregateReply.html | 2 +- .../commands_SEARCH.SearchOptions.html | 2 +- .../commands_SUGGET.SugGetOptions.html | 2 +- ...GET_WITHPAYLOADS.SuggestionWithPayload.html | 2 +- ...SUGGET_WITHSCORES.SuggestionWithScores.html | 2 +- documentation/search/modules/commands.html | 2 +- .../search/modules/commands_AGGREGATE.html | 2 +- .../search/modules/commands_ALIASADD.html | 2 +- .../search/modules/commands_ALIASDEL.html | 2 +- .../search/modules/commands_ALIASUPDATE.html | 2 +- .../search/modules/commands_ALTER.html | 2 +- .../search/modules/commands_CONFIG_GET.html | 2 +- .../search/modules/commands_CONFIG_SET.html | 2 +- .../search/modules/commands_CREATE.html | 2 +- .../search/modules/commands_DICTADD.html | 2 +- .../search/modules/commands_DICTDEL.html | 2 +- .../search/modules/commands_DICTDUMP.html | 2 +- .../search/modules/commands_DROPINDEX.html | 2 +- .../search/modules/commands_EXPLAIN.html | 2 +- .../search/modules/commands_EXPLAINCLI.html | 2 +- .../search/modules/commands_INFO.html | 2 +- .../modules/commands_PROFILE_AGGREGATE.html | 2 +- .../modules/commands_PROFILE_SEARCH.html | 2 +- .../search/modules/commands_SEARCH.html | 2 +- .../search/modules/commands_SPELLCHECK.html | 2 +- .../search/modules/commands_SUGADD.html | 2 +- .../search/modules/commands_SUGDEL.html | 2 +- .../search/modules/commands_SUGGET.html | 2 +- .../modules/commands_SUGGET_WITHPAYLOADS.html | 2 +- .../modules/commands_SUGGET_WITHSCORES.html | 2 +- ...ommands_SUGGET_WITHSCORES_WITHPAYLOADS.html | 2 +- .../search/modules/commands_SUGLEN.html | 2 +- .../search/modules/commands_SYNDUMP.html | 2 +- .../search/modules/commands_SYNUPDATE.html | 2 +- .../search/modules/commands_TAGVALS.html | 2 +- .../search/modules/commands__LIST.html | 2 +- .../commands.TimeSeriesAggregationType.html | 2 +- .../commands.TimeSeriesDuplicatePolicies.html | 2 +- .../enums/commands.TimeSeriesEncoding.html | 2 +- .../enums/commands.TimeSeriesReducers.html | 2 +- .../interfaces/commands.IncrDecrOptions.html | 2 +- .../interfaces/commands.MRangeOptions.html | 2 +- .../commands.MRangeWithLabelsOptions.html | 2 +- .../commands.MRangeWithLabelsReplyItem.html | 2 +- .../interfaces/commands.RangeOptions.html | 2 +- .../interfaces/commands.SampleReply.html | 2 +- .../interfaces/commands_INFO.InfoReply.html | 2 +- .../interfaces/commands_MGET.MGetReply.html | 2 +- ...ds_MGET_WITHLABELS.MGetWithLabelsReply.html | 2 +- .../time-series/modules/commands.html | 2 +- .../time-series/modules/commands_ADD.html | 2 +- .../time-series/modules/commands_ALTER.html | 2 +- .../time-series/modules/commands_CREATE.html | 2 +- .../modules/commands_CREATERULE.html | 2 +- .../time-series/modules/commands_DECRBY.html | 2 +- .../time-series/modules/commands_DEL.html | 2 +- .../modules/commands_DELETERULE.html | 2 +- .../time-series/modules/commands_GET.html | 2 +- .../time-series/modules/commands_INCRBY.html | 2 +- .../time-series/modules/commands_INFO.html | 2 +- .../modules/commands_INFO_DEBUG.html | 2 +- .../time-series/modules/commands_MADD.html | 2 +- .../time-series/modules/commands_MGET.html | 2 +- .../modules/commands_MGET_WITHLABELS.html | 2 +- .../time-series/modules/commands_MRANGE.html | 2 +- .../modules/commands_MRANGE_WITHLABELS.html | 2 +- .../modules/commands_MREVRANGE.html | 2 +- .../modules/commands_MREVRANGE_WITHLABELS.html | 2 +- .../modules/commands_QUERYINDEX.html | 2 +- .../time-series/modules/commands_RANGE.html | 2 +- .../time-series/modules/commands_REVRANGE.html | 2 +- 428 files changed, 451 insertions(+), 451 deletions(-) diff --git a/documentation/client/classes/lib_client.default.html b/documentation/client/classes/lib_client.default.html index 97c8c50cbc..b246041e9c 100644 --- a/documentation/client/classes/lib_client.default.html +++ b/documentation/client/classes/lib_client.default.html @@ -1,4 +1,4 @@ -default | @node-redis/client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default<M, S>

Type parameters

Hierarchy

  • EventEmitter
    • default

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Readonly #isolationPool

#isolationPool: Pool<RedisClientType<M, S>>

Private Optional Readonly #options

#options?: RedisClientOptions<M, S>

Private Readonly #queue

#queue: default

Private #selectedDB

#selectedDB: number = 0

Private Readonly #socket

#socket: default

Private Readonly #v4

#v4: Record<string, any> = {}

pSubscribe

pSubscribe: <T>(patterns: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T) => Promise<void> = ...

Type declaration

    • <T>(patterns: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

    • Type parameters

      • T: boolean = false

      Parameters

      • patterns: string | string[]
      • listener: PubSubListener<T, T extends true ? Buffer : string>
      • Optional bufferMode: T

      Returns Promise<void>

pUnsubscribe

pUnsubscribe: <T>(patterns?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T) => Promise<void> = ...

Type declaration

    • <T>(patterns?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

    • Type parameters

      • T: boolean = false

      Parameters

      • Optional patterns: string | string[]
      • Optional listener: PubSubListener<T, T extends true ? Buffer : string>
      • Optional bufferMode: T

      Returns Promise<void>

quit

quit: () => Promise<void> = ...

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

select

select: { (db: number): Promise<void>; (options: CommandOptions<ClientCommandOptions>, db: number): Promise<void> } = ...

Type declaration

subscribe

subscribe: <T>(channels: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T) => Promise<void> = ...

Type declaration

    • <T>(channels: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

    • Type parameters

      • T: boolean = false

      Parameters

      • channels: string | string[]
      • listener: PubSubListener<T, T extends true ? Buffer : string>
      • Optional bufferMode: T

      Returns Promise<void>

unsubscribe

unsubscribe: <T>(channels?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T) => Promise<void> = ...

Type declaration

    • <T>(channels?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

    • Type parameters

      • T: boolean = false

      Parameters

      • Optional channels: string | string[]
      • Optional listener: PubSubListener<T, T extends true ? Buffer : string>
      • Optional bufferMode: T

      Returns Promise<void>

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
+default | @node-redis/client
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default<M, S>

Type parameters

Hierarchy

  • EventEmitter
    • default

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Readonly #isolationPool

#isolationPool: Pool<RedisClientType<M, S>>

Private Optional Readonly #options

#options?: RedisClientOptions<M, S>

Private Readonly #queue

#queue: default

Private #selectedDB

#selectedDB: number = 0

Private Readonly #socket

#socket: default

Private Readonly #v4

#v4: Record<string, any> = {}

pSubscribe

pSubscribe: <T>(patterns: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T) => Promise<void> = ...

Type declaration

    • <T>(patterns: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

    • Type parameters

      • T: boolean = false

      Parameters

      • patterns: string | string[]
      • listener: PubSubListener<T, T extends true ? Buffer : string>
      • Optional bufferMode: T

      Returns Promise<void>

pUnsubscribe

pUnsubscribe: <T>(patterns?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T) => Promise<void> = ...

Type declaration

    • <T>(patterns?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

    • Type parameters

      • T: boolean = false

      Parameters

      • Optional patterns: string | string[]
      • Optional listener: PubSubListener<T, T extends true ? Buffer : string>
      • Optional bufferMode: T

      Returns Promise<void>

quit

quit: () => Promise<void> = ...

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

select

select: { (db: number): Promise<void>; (options: CommandOptions<ClientCommandOptions>, db: number): Promise<void> } = ...

Type declaration

subscribe

subscribe: <T>(channels: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T) => Promise<void> = ...

Type declaration

    • <T>(channels: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

    • Type parameters

      • T: boolean = false

      Parameters

      • channels: string | string[]
      • listener: PubSubListener<T, T extends true ? Buffer : string>
      • Optional bufferMode: T

      Returns Promise<void>

unsubscribe

unsubscribe: <T>(channels?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T) => Promise<void> = ...

Type declaration

    • <T>(channels?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

    • Type parameters

      • T: boolean = false

      Parameters

      • Optional channels: string | string[]
      • Optional listener: PubSubListener<T, T extends true ? Buffer : string>
      • Optional bufferMode: T

      Returns Promise<void>

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' @@ -7,10 +7,10 @@ events. Listeners installed using this symbol are called before the regular

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

-

Accessors

isOpen

  • get isOpen(): boolean

options

v4

  • get v4(): Record<string, any>

Methods

Private #defineLegacyCommand

  • #defineLegacyCommand(name: string): void

Private #destroyIsolationPool

  • #destroyIsolationPool(): Promise<void>

Private #initiateOptions

Private #initiateQueue

Private #initiateSocket

Private #legacyMode

  • #legacyMode(): void

Private #sendCommand

Private #subscribe

Private #tick

  • #tick(force?: boolean): void

Private #unsubscribe

PSUBSCRIBE

  • PSUBSCRIBE<T>(patterns: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

PUNSUBSCRIBE

  • PUNSUBSCRIBE<T>(patterns?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

QUIT

  • QUIT(): Promise<void>

SELECT

SUBSCRIBE

  • SUBSCRIBE<T>(channels: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

UNSUBSCRIBE

  • UNSUBSCRIBE<T>(channels?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

addListener

  • addListener(eventName: string | symbol, listener: (...args: any[]) => void): default<M, S>
  • +

Accessors

isOpen

  • get isOpen(): boolean

options

v4

  • get v4(): Record<string, any>

Methods

Private #defineLegacyCommand

  • #defineLegacyCommand(name: string): void

Private #destroyIsolationPool

  • #destroyIsolationPool(): Promise<void>

Private #initiateOptions

Private #initiateQueue

Private #initiateSocket

Private #legacyMode

  • #legacyMode(): void

Private #sendCommand

Private #subscribe

Private #tick

  • #tick(force?: boolean): void

Private #unsubscribe

PSUBSCRIBE

  • PSUBSCRIBE<T>(patterns: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

PUNSUBSCRIBE

  • PUNSUBSCRIBE<T>(patterns?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

QUIT

  • QUIT(): Promise<void>

SELECT

SUBSCRIBE

  • SUBSCRIBE<T>(channels: string | string[], listener: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

UNSUBSCRIBE

  • UNSUBSCRIBE<T>(channels?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, bufferMode?: T): Promise<void>

addListener

  • addListener(eventName: string | symbol, listener: (...args: any[]) => void): default<M, S>

  • Alias for emitter.on(eventName, listener).

    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default<M, S>

commandsExecutor

connect

  • connect(): Promise<void>

disconnect

  • disconnect(): Promise<void>

duplicate

emit

  • emit(eventName: string | symbol, ...args: any[]): boolean
  • +

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default<M, S>

commandsExecutor

connect

  • connect(): Promise<void>

disconnect

  • disconnect(): Promise<void>

duplicate

emit

  • emit(eventName: string | symbol, ...args: any[]): boolean

  • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

    @@ -23,11 +23,11 @@ listeners. The values in the array are strings or Symbols.

    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
    since

    v6.0.0

    -

    Returns (string | symbol)[]

executeIsolated

  • executeIsolated<T>(fn: (client: RedisClientType<M, S>) => T | Promise<T>): Promise<T>

executeScript

getMaxListeners

  • getMaxListeners(): number
  • +

    Returns (string | symbol)[]

executeIsolated

  • executeIsolated<T>(fn: (client: RedisClientType<M, S>) => T | Promise<T>): Promise<T>

executeScript

getMaxListeners

  • getMaxListeners(): number

  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    since

    v1.0.0

    -

    Returns number

hScanIterator

  • hScanIterator(key: string, options?: ScanOptions): AsyncIterable<{ field: string; value: string }>

listenerCount

  • listenerCount(eventName: string | symbol): number
  • +

    Returns number

hScanIterator

  • hScanIterator(key: string, options?: ScanOptions): AsyncIterable<{ field: string; value: string }>

listenerCount

  • listenerCount(eventName: string | symbol): number

multi

multiExecutor

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): default<M, S>
  • +

    Parameters

    • eventName: string | symbol

    Returns Function[]

multi

multiExecutor

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): default<M, S>

  • Alias for emitter.removeListener().

    since

    v10.0.0

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default<M, S>

on

  • on(eventName: string | symbol, listener: (...args: any[]) => void): default<M, S>
  • @@ -134,14 +134,14 @@ recently added instance. In the example the once('ping')lis

    Returns a reference to the EventEmitter, so that calls can be chained.

    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default<M, S>

sScanIterator

  • sScanIterator(key: string, options?: ScanOptions): AsyncIterable<string>

scanIterator

scriptsExecutor

sendCommand

setMaxListeners

  • setMaxListeners(n: number): default<M, S>
  • +

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default<M, S>

sScanIterator

  • sScanIterator(key: string, options?: ScanOptions): AsyncIterable<string>

scanIterator

scriptsExecutor

sendCommand

setMaxListeners

  • setMaxListeners(n: number): default<M, S>

  • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter, so that calls can be chained.

    since

    v0.3.5

    -

    Parameters

    • n: number

    Returns default<M, S>

zScanIterator

  • zScanIterator(key: string, options?: ScanOptions): AsyncIterable<{ score: number; value: string }>

Static commandOptions

Static create

Static extend

Static getEventListeners

  • getEventListeners(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]
  • +

    Parameters

    • n: number

    Returns default<M, S>

zScanIterator

  • zScanIterator(key: string, options?: ScanOptions): AsyncIterable<{ score: number; value: string }>

Static commandOptions

Static create

Static extend

Static getEventListeners

  • getEventListeners(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]

  • Returns a copy of the array of listeners for the event named eventName.

    For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

    @@ -202,4 +202,4 @@ special handling:

    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
    since

    v11.13.0, v10.16.0

    -

    Parameters

    • emitter: NodeEventTarget
    • eventName: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • eventName: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Static parseURL

Legend

  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Class
  • Class with type parameter
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Private property
  • Private method
  • Enumeration
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • emitter: NodeEventTarget
  • eventName: string | symbol
  • Optional options: StaticEventEmitterOptions

Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • eventName: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

    • Static parseURL

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/client/classes/lib_client_commands_queue.default.html b/documentation/client/classes/lib_client_commands_queue.default.html index eff30a6ffc..9e696425aa 100644 --- a/documentation/client/classes/lib_client_commands_queue.default.html +++ b/documentation/client/classes/lib_client_commands_queue.default.html @@ -1 +1 @@ -default | @node-redis/client
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class default

    Hierarchy

    • default

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new default(maxLength: undefined | null | number): default

    Properties

    Private #chainInExecution

    #chainInExecution: undefined | symbol

    Private Readonly #maxLength

    #maxLength: undefined | null | number

    Private Readonly #parser

    #parser: any = ...

    Private #pubSubState

    #pubSubState: undefined | PubSubState

    Private Readonly #waitingForReply

    #waitingForReply: Yallist<CommandWaitingForReply> = ...

    Private Readonly #waitingToBeSent

    #waitingToBeSent: Yallist<CommandWaitingToBeSent> = ...

    Static Private Readonly #PUB_SUB_MESSAGES

    #PUB_SUB_MESSAGES: { message: Buffer; pMessage: Buffer; pSubscribe: Buffer; pUnsubscribe: Buffer; subscribe: Buffer; unsubscribe: Buffer } = ...

    Type declaration

    • message: Buffer
    • pMessage: Buffer
    • pSubscribe: Buffer
    • pUnsubscribe: Buffer
    • subscribe: Buffer
    • unsubscribe: Buffer

    Methods

    Private #initiatePubSubState

    • #initiatePubSubState(): PubSubState

    Private #pushPubSubCommand

    Private #shiftWaitingForReply

    • #shiftWaitingForReply(): CommandWaitingForReply

    addCommand

    flushAll

    • flushAll(err: Error): void

    flushWaitingForReply

    • flushWaitingForReply(err: Error): void

    getCommandToSend

    parseResponse

    • parseResponse(data: Buffer): void

    resubscribe

    • resubscribe(): undefined | Promise<any>

    subscribe

    unsubscribe

    Static Private #emitPubSubMessage

    • #emitPubSubMessage(listenersMap: PubSubListenersMap, message: Buffer, channel: Buffer, pattern?: Buffer): void

    Static Private #flushQueue

    • #flushQueue<T>(queue: Yallist<T>, err: Error): void

    Generated using TypeDoc

    \ No newline at end of file +default | @node-redis/client
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class default

    Hierarchy

    • default

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new default(maxLength: undefined | null | number): default

    Properties

    Private #chainInExecution

    #chainInExecution: undefined | symbol

    Private Readonly #maxLength

    #maxLength: undefined | null | number

    Private Readonly #parser

    #parser: any = ...

    Private #pubSubState

    #pubSubState: undefined | PubSubState

    Private Readonly #waitingForReply

    #waitingForReply: Yallist<CommandWaitingForReply> = ...

    Private Readonly #waitingToBeSent

    #waitingToBeSent: Yallist<CommandWaitingToBeSent> = ...

    Static Private Readonly #PUB_SUB_MESSAGES

    #PUB_SUB_MESSAGES: { message: Buffer; pMessage: Buffer; pSubscribe: Buffer; pUnsubscribe: Buffer; subscribe: Buffer; unsubscribe: Buffer } = ...

    Type declaration

    • message: Buffer
    • pMessage: Buffer
    • pSubscribe: Buffer
    • pUnsubscribe: Buffer
    • subscribe: Buffer
    • unsubscribe: Buffer

    Methods

    Private #initiatePubSubState

    • #initiatePubSubState(): PubSubState

    Private #pushPubSubCommand

    Private #shiftWaitingForReply

    • #shiftWaitingForReply(): CommandWaitingForReply

    addCommand

    flushAll

    • flushAll(err: Error): void

    flushWaitingForReply

    • flushWaitingForReply(err: Error): void

    getCommandToSend

    parseResponse

    • parseResponse(data: Buffer): void

    resubscribe

    • resubscribe(): undefined | Promise<any>

    subscribe

    unsubscribe

    Static Private #emitPubSubMessage

    • #emitPubSubMessage(listenersMap: PubSubListenersMap, message: Buffer, channel: Buffer, pattern?: Buffer): void

    Static Private #flushQueue

    • #flushQueue<T>(queue: Yallist<T>, err: Error): void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/client/classes/lib_client_multi_command.default.html b/documentation/client/classes/lib_client_multi_command.default.html index d4acb9ff7c..43d0f87625 100644 --- a/documentation/client/classes/lib_client_multi_command.default.html +++ b/documentation/client/classes/lib_client_multi_command.default.html @@ -1 +1 @@ -default | @node-redis/client
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class default

    Hierarchy

    • default

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    Properties

    Private Readonly #executor

    #executor: RedisClientMultiExecutor

    Private Readonly #multi

    #multi: default = ...

    EXEC

    EXEC: (execAsPipeline?: boolean) => Promise<RedisCommandRawReply[]> = ...

    Type declaration

    Readonly v4

    v4: Record<string, any> = {}

    Methods

    Private #defineLegacyCommand

    • #defineLegacyCommand(name: string): void

    Private #legacyMode

    • #legacyMode(): void

    addCommand

    commandsExecutor

    exec

    execAsPipeline

    scriptsExecutor

    Static extend

    Generated using TypeDoc

    \ No newline at end of file +default | @node-redis/client
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class default

    Hierarchy

    • default

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    Properties

    Private Readonly #executor

    #executor: RedisClientMultiExecutor

    Private Readonly #multi

    #multi: default = ...

    EXEC

    EXEC: (execAsPipeline?: boolean) => Promise<RedisCommandRawReply[]> = ...

    Type declaration

    Readonly v4

    v4: Record<string, any> = {}

    Methods

    Private #defineLegacyCommand

    • #defineLegacyCommand(name: string): void

    Private #legacyMode

    • #legacyMode(): void

    addCommand

    commandsExecutor

    exec

    execAsPipeline

    scriptsExecutor

    Static extend

    Generated using TypeDoc

    \ No newline at end of file diff --git a/documentation/client/classes/lib_client_socket.default.html b/documentation/client/classes/lib_client_socket.default.html index 5af47ec074..3e0d4c42d9 100644 --- a/documentation/client/classes/lib_client_socket.default.html +++ b/documentation/client/classes/lib_client_socket.default.html @@ -1,4 +1,4 @@ -default | @node-redis/client
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class default

    Hierarchy

    • EventEmitter
      • default

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    Private Optional Readonly #initiator

    #initiator?: RedisSocketInitiator

    Private #isCorked

    #isCorked: boolean = false

    Private #isOpen

    #isOpen: boolean = false

    Private #isReady

    #isReady: boolean = false

    Private Readonly #options

    #options: RedisSocketOptions

    Private Optional #socket

    #socket?: Socket | TLSSocket

    Private #writableNeedDrain

    #writableNeedDrain: boolean = false

    Static Readonly captureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol

    Static captureRejections

    captureRejections: boolean
    +default | @node-redis/client
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class default

    Hierarchy

    • EventEmitter
      • default

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    Private Optional Readonly #initiator

    #initiator?: RedisSocketInitiator

    Private #isCorked

    #isCorked: boolean = false

    Private #isOpen

    #isOpen: boolean = false

    Private #isReady

    #isReady: boolean = false

    Private Readonly #options

    #options: RedisSocketOptions

    Private Optional #socket

    #socket?: Socket | TLSSocket

    Private #writableNeedDrain

    #writableNeedDrain: boolean = false

    Static Readonly captureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol

    Static captureRejections

    captureRejections: boolean

    Sets or gets the default captureRejection value for all emitters.

    Static defaultMaxListeners

    defaultMaxListeners: number

    Static Readonly errorMonitor

    errorMonitor: typeof errorMonitor

    This symbol shall be used to install a listener for only monitoring 'error' @@ -7,10 +7,10 @@ events. Listeners installed using this symbol are called before the regular

    Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

    -

    Accessors

    isOpen

    • get isOpen(): boolean

    isReady

    • get isReady(): boolean

    writableNeedDrain

    • get writableNeedDrain(): boolean

    Methods

    Private #connect

    • #connect(hadError?: boolean): Promise<void>

    Private #createNetSocket

    • #createNetSocket(): CreateSocketReturn<Socket>

    Private #createSocket

    • #createSocket(): Promise<Socket | TLSSocket>

    Private #createTlsSocket

    • #createTlsSocket(): CreateSocketReturn<TLSSocket>

    Private #onSocketError

    • #onSocketError(err: Error): void

    Private #retryConnection

    • #retryConnection(retries: number, hadError?: boolean): Promise<Socket | TLSSocket>

    addListener

    • addListener(eventName: string | symbol, listener: (...args: any[]) => void): default
    • +

    Accessors

    isOpen

    • get isOpen(): boolean

    isReady

    • get isReady(): boolean

    writableNeedDrain

    • get writableNeedDrain(): boolean

    Methods

    Private #connect

    • #connect(hadError?: boolean): Promise<void>

    Private #createNetSocket

    • #createNetSocket(): CreateSocketReturn<Socket>

    Private #createSocket

    • #createSocket(): Promise<Socket | TLSSocket>

    Private #createTlsSocket

    • #createTlsSocket(): CreateSocketReturn<TLSSocket>

    Private #onSocketError

    • #onSocketError(err: Error): void

    Private #retryConnection

    • #retryConnection(retries: number, hadError?: boolean): Promise<Socket | TLSSocket>

    addListener

    • addListener(eventName: string | symbol, listener: (...args: any[]) => void): default

    • Alias for emitter.on(eventName, listener).

      since

      v0.1.26

      -

      Parameters

      • eventName: string | symbol
      • listener: (...args: any[]) => void
          • (...args: any[]): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns default

    connect

    • connect(): Promise<void>

    cork

    • cork(): void

    disconnect

    • disconnect(): void

    emit

    • emit(eventName: string | symbol, ...args: any[]): boolean
    • +

      Parameters

      • eventName: string | symbol
      • listener: (...args: any[]) => void
          • (...args: any[]): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns default

    connect

    • connect(): Promise<void>

    cork

    • cork(): void

    disconnect

    • disconnect(): void

    emit

    • emit(eventName: string | symbol, ...args: any[]): boolean

    • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

      Returns true if the event had listeners, false otherwise.

      @@ -96,7 +96,7 @@ listener is removed, and then invoked.

      The name of the event.

    • listener: (...args: any[]) => void

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default

    quit

    • quit(fn: () => Promise<unknown>): Promise<void>

    rawListeners

    • rawListeners(eventName: string | symbol): Function[]
    • +
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default

    quit

    • quit(fn: () => Promise<unknown>): Promise<void>

    rawListeners

    • rawListeners(eventName: string | symbol): Function[]

    • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

      const emitter = new EventEmitter();
      emitter.once('log', () => console.log('log once'));

      // Returns a new Array with a function `onceWrapper` which has a property
      // `listener` which contains the original listener bound above
      const listeners = emitter.rawListeners('log');
      const logFnWrapper = listeners[0];

      // Logs "log once" to the console and does not unbind the `once` event
      logFnWrapper.listener();

      // Logs "log once" to the console and removes the listener
      logFnWrapper();

      emitter.on('log', () => console.log('log persistently'));
      // Will return a new Array with a single function bound by `.on()` above
      const newListeners = emitter.rawListeners('log');

      // Logs "log persistently" twice
      newListeners[0]();
      emitter.emit('log');
@@ -141,7 +141,7 @@ memory leaks. The emitter.setMaxListeners() method allows the limit
 modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

      Returns a reference to the EventEmitter, so that calls can be chained.

      since

      v0.3.5

      -

      Parameters

      • n: number

      Returns default

    writeCommand

    Static Private #defaultReconnectStrategy

    • #defaultReconnectStrategy(retries: number): number

    Static Private #initiateOptions

    Static Private #isTlsSocket

    Static getEventListeners

    • getEventListeners(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]
    • +

      Parameters

      • n: number

      Returns default

    writeCommand

    Static Private #defaultReconnectStrategy

    • #defaultReconnectStrategy(retries: number): number

    Static Private #initiateOptions

    Static Private #isTlsSocket

    Static getEventListeners

    • getEventListeners(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]