Interface SortedSet

有序集合

Hierarchy

SortedSet
- RedisClient

Index

Properties

zadd zaddPair zcard zcount zincrby zrangebyscore zrank zrem zremrangebyscore zrevrangebyscore zrevrank zscan zscore

Methods

zrange zremrangebyrank zrevrange

Properties

zadd

zadd: ((key, map) => number)

Type declaration

- (key, map): number
- 将一个或多个 member 元素及其 score 值加入到有序集 key 当中
  
  返回被成功添加的新成员的数量，不包括那些被更新的、已经存在的成员。
  Parameters
  - key: string
    键值
  - map: "redis".StringDict
    <score,member>键值对，即key为score，value是member
  Returns number

zaddPair

zaddPair: ((key, ...pairs) => number)

Type declaration

- (key, ...pairs): number
- 功能同 zadd
  Parameters
  - key: string
  - Rest ...pairs: SortedSetPair[]
    参考 SortedSetPair
  Returns number

zcard

zcard: ((key) => number)

Type declaration

- (key): number
- 返回有序集 key 的基数
  Parameters
  - key: string
    键值
  Returns number

zcount

zcount: ((key, min, max) => number)

Type declaration

- (key, min, max): number
- 返回有序集 key 中， score 值在 min 和 max 之间(默认包括 score 值等于 min 或 max )的成员的数量.
  Parameters
  - key: string
    键值
  - min: string
    最小值
  - max: string
    最大值
  Returns number

zincrby

zincrby: ((key, increment, member) => string)

Type declaration

- (key, increment, member): string
- 为有序集 key 的成员 member 的 score 值加上增量 increment
  
  member 成员的新 score 值，以字符串形式表示
  Parameters
  - key: string
    键值
  - increment: string
    增量，可以是负数值
  - member: string
    成员
  Returns string

zrangebyscore

zrangebyscore: ((key, min, max, option?) => string[])

Type declaration

- (key, min, max, option?): string[]
- 返回有序集 key 中，所有 score 值介于 min 和 max 之间(包括等于 min 或 max )的成员。有序集成员按 score 值递增(从小到大)次序排列
  
  min 和 max 可以是 -inf 和 +inf ，这样一来，你就可以在不知道有序集的最低和最高 score 值的情况下，使用 ZRANGEBYSCORE 这类命令。
  
  默认情况下，区间的取值使用闭区间 (小于等于或大于等于)，你也可以通过给参数前增加 ( 符号来使用可选的开区间 (小于或大于)。
  Parameters
  - key: string
    键值
  - min: string
    最小值
  - max: string
    最大值
  - Optional option: RangeByScoreOption
    可选参数，参考RangeByScoreOption
  Returns string[]
  Example
```
import * as redis from 'redis';

let cli = redis.newClient("test");

console.log(cli.zrangebyscore("test_key", "(1", "5"));
```

zrank

zrank: ((key, member) => number)

Type declaration

- (key, member): number
- 返回有序集 key 中成员 member 的排名。其中有序集成员按 score 值递增(从小到大)顺序排列。排名以 0 为底，也就是说， score 值最小的成员排名为 0 。
  
  如果 member 是有序集 key 的成员，返回 member 的排名。如果 member 不是有序集 key 的成员，返回 nil
  Parameters
  - key: string
    键值
  - member: string
    成员
  Returns number

zrem

zrem: ((key, ...members) => number)

Type declaration

- (key, ...members): number
- 移除有序集 key 中的一个或多个成员，不存在的成员将被忽略。
  
  返回被成功移除的成员的数量，不包括被忽略的成员。
  Parameters
  - key: string
    键值
  - Rest ...members: string[]
    成员列表
  Returns number

zremrangebyscore

zremrangebyscore: ((key, min, max) => number)

Type declaration

- (key, min, max): number
- 移除有序集 key 中，所有 score 值介于 min 和 max 之间(包括等于 min 或 max )的成员。
  
  返回被移除成员的数量
  Parameters
  - key: string
    键值
  - min: string
    最小值
  - max: string
    最大值
  Returns number

zrevrangebyscore

zrevrangebyscore: ((key, max, min, option?) => string[])

Type declaration

- (key, max, min, option?): string[]
- 返回有序集 key 中， score 值介于 max 和 min 之间(默认包括等于 max 或 min )的所有的成员。有序集成员按 score 值递减(从大到小)的次序排列。
  Parameters
  - key: string
    键值
  - max: string
    最大值
  - min: string
    最小值
  - Optional option: RangeByScoreOption
    可选参数，参考RangeByScoreOption
  Returns string[]

zrevrank

zrevrank: ((key, member) => number)

Type declaration

- (key, member): number
- 返回有序集 key 中成员 member 的排名。其中有序集成员按 score 值递减(从大到小)排序。排名以 0 为底，也就是说， score 值最大的成员排名为 0 。
  
  如果 member 是有序集 key 的成员，返回 member 的排名。如果 member 不是有序集 key 的成员，返回 nil
  Parameters
  - key: string
    键值
  - member: string
    成员
  Returns number

zscan

zscan: ((key, cursor, opt?) => ZScanResult)

Type declaration

- (key, cursor, opt?): ZScanResult
- 有序集合的增量式迭代命令，用于增量地迭代一个有序集合上的元素。
  Parameters
  - key: string
    有序集合
  - cursor: number
    起始游标
  - Optional opt: ScanOption
    scan 可选参数
  Returns ZScanResult

zscore

zscore: ((key, member) => string)

Type declaration

- (key, member): string
- 返回有序集 key 中，成员 member 的 score 值。如果 member 元素不是有序集 key 的成员，或 key 不存在，则报错
  Parameters
  - key: string
    键值
  - member: string
    成员
  Returns string

Methods

zrange

zrange(key, start, stop): string[]
返回有序集 key 中，指定区间内的成员。其中成员的位置按 score 值递增(从小到大)来排序。具有相同 score 值的成员按字典序(lexicographical order )来排列。

下标参数 start 和 stop 都以 0 为底，也就是说，以 0 表示有序集第一个成员，以 1 表示有序集第二个成员，以此类推。你也可以使用负数下标，以 -1 表示最后一个成员， -2 表示倒数第二个成员，以此类推。
Parameters
- key: string
  键值
- start: string
  起始位置
- stop: string
  结束位置
Returns string[]
zrange(key, start, stop, opt?): string[]
返回有序集 key 中，指定区间内的成员。其中成员的位置按 score 值递增(从小到大)来排序。具有相同 score 值的成员按字典序(lexicographical order )来排列。

下标参数 start 和 stop 都以 0 为底，也就是说，以 0 表示有序集第一个成员，以 1 表示有序集第二个成员，以此类推。你也可以使用负数下标，以 -1 表示最后一个成员， -2 表示倒数第二个成员，以此类推。
Parameters
- key: string
  键值
- start: string
  起始位置
- stop: string
  结束位置
- Optional opt: SortedSetRangeOption
  range 命令可选参数，见 SortedSetRangeOption
Returns string[]

zremrangebyrank

zremrangebyrank(key, start, stop): number
移除有序集 key 中，指定排名(rank)区间内的所有成员。区间分别以下标参数 start 和 stop 指出，包含 start 和 stop 在内。下标参数 start 和 stop 都以 0 为底，也就是说，以 0 表示有序集第一个成员，以 1 表示有序集第二个成员，以此类推。你也可以使用负数下标，以 -1 表示最后一个成员， -2 表示倒数第二个成员，以此类推。

返回被移除成员的数量
Parameters
- key: string
  键值
- start: string
  起始位置
- stop: string
  结束位置
Returns number

zrevrange

zrevrange(key, start, stop): string[]
返回有序集 key 中，指定区间内的成员其中成员的位置按 score 值递减(从大到小)来排列。具有相同 score 值的成员按字典序的逆序(reverse lexicographical order)排列。
Parameters
- key: string
  键值
- start: string
  其实位置
- stop: string
  结束位置
Returns string[]
zrevrange(key, start, stop, opt?): string[]
返回有序集 key 中，指定区间内的成员其中成员的位置按 score 值递减(从大到小)来排列。具有相同 score 值的成员按字典序的逆序(reverse lexicographical order)排列。
Parameters
- key: string
  键值
- start: string
  其实位置
- stop: string
  结束位置
- Optional opt: SortedSetRangeOption
  range 命令可选参数，见 SortedSetRangeOption
Returns string[]

Interface SortedSet

Hierarchy

Index

Properties

Methods

Properties

zadd

Type declaration

Parameters

key: string

map: "redis".StringDict

Returns number

zaddPair

Type declaration

Parameters

key: string

Rest ...pairs: SortedSetPair[]

Returns number

zcard

Type declaration

Parameters

key: string

Returns number

zcount

Type declaration

Parameters

key: string

min: string

max: string

Returns number

zincrby

Type declaration

Parameters

key: string

increment: string

member: string

Returns string

zrangebyscore

Type declaration

Parameters

key: string

min: string

max: string

Optional option: RangeByScoreOption

Returns string[]

Example

zrank

Type declaration

Parameters

key: string

member: string

Returns number

zrem

Type declaration

Parameters

key: string

Rest ...members: string[]

Returns number

zremrangebyscore

Type declaration

Parameters

key: string

min: string

max: string

Returns number

zrevrangebyscore

Type declaration

Parameters

key: string

max: string

min: string

Optional option: RangeByScoreOption

Returns string[]

zrevrank

Type declaration

Parameters

key: string

member: string

Returns number

zscan

`Rest` ...pairs: SortedSetPair[]

`Optional` option: RangeByScoreOption

`Rest` ...members: string[]

`Optional` option: RangeByScoreOption

`Optional` opt: ScanOption

`Optional` opt: SortedSetRangeOption

`Optional` opt: SortedSetRangeOption