有序集合

Hierarchy

Properties

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: ((key, ...pairs) => number)

Type declaration

zcard: ((key) => number)

Type declaration

    • (key): number
    • 返回有序集 key 的基数

      Parameters

      • key: string

        键值

      Returns number

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: ((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: ((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

      Returns string[]

      Example

      import * as redis from 'redis';

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

      console.log(cli.zrangebyscore("test_key", "(1", "5"));
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: ((key, ...members) => number)

Type declaration

    • (key, ...members): number
    • 移除有序集 key 中的一个或多个成员,不存在的成员将被忽略。

      返回被成功移除的成员的数量,不包括被忽略的成员。

      Parameters

      • key: string

        键值

      • Rest ...members: string[]

        成员列表

      Returns number

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: ((key, max, min, option?) => string[])

Type declaration

    • (key, max, min, option?): string[]
    • 返回有序集 key 中, score 值介于 max 和 min 之间(默认包括等于 max 或 min )的所有的成员。 有序集成员按 score 值递减(从大到小)的次序排列。

      Parameters

      Returns string[]

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: ((key, cursor, opt?) => ZScanResult)

Type declaration

    • (key, cursor, opt?): ZScanResult
    • 有序集合的增量式迭代命令, 用于增量地迭代一个有序集合上的元素。

      Parameters

      • key: string

        有序集合

      • cursor: number

        起始游标

      • Optional opt: ScanOption

        scan 可选参数

      Returns ZScanResult

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

Type declaration

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

      Parameters

      • key: string

        键值

      • member: string

        成员

      Returns string

Methods

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

    下标参数 start 和 stop 都以 0 为底,也就是说,以 0 表示有序集第一个成员,以 1 表示有序集第二个成员,以此类推。 你也可以使用负数下标,以 -1 表示最后一个成员, -2 表示倒数第二个成员,以此类推。

    Parameters

    • key: string

      键值

    • start: string

      起始位置

    • stop: string

      结束位置

    Returns string[]

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

    下标参数 start 和 stop 都以 0 为底,也就是说,以 0 表示有序集第一个成员,以 1 表示有序集第二个成员,以此类推。 你也可以使用负数下标,以 -1 表示最后一个成员, -2 表示倒数第二个成员,以此类推。

    Parameters

    Returns string[]

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

    返回被移除成员的数量

    Parameters

    • key: string

      键值

    • start: string

      起始位置

    • stop: string

      结束位置

    Returns number

  • 返回有序集 key 中,指定区间内的成员 其中成员的位置按 score 值递减(从大到小)来排列。 具有相同 score 值的成员按字典序的逆序(reverse lexicographical order)排列。

    Parameters

    • key: string

      键值

    • start: string

      其实位置

    • stop: string

      结束位置

    Returns string[]

  • 返回有序集 key 中,指定区间内的成员 其中成员的位置按 score 值递减(从大到小)来排列。 具有相同 score 值的成员按字典序的逆序(reverse lexicographical order)排列。

    Parameters

    Returns string[]