Interface StringClient

字符串

interface StringClient {
    append: ((key, value) => number);
    decr: ((key) => number);
    decrBy: ((key, decrement) => void);
    get: ((key) => string);
    getset: ((key, value) => string);
    incr: ((key) => number);
    incrBy: ((key, increment) => number);
    strlen: ((key) => number);
    set(key, value, expireInSeconds): boolean;
    set(key, value, opt?): string;
}

Hierarchy (view full)

Properties

append decr decrBy get getset incr incrBy strlen

Methods

set

Properties

append

append: ((key, value) => number)

如果键 key 已经存在并且它的值是一个字符串， APPEND 命令将把 value 追加到键 key 现有值的末尾。

如果 key 不存在， APPEND 就简单地将键 key 的值设为 value ， 就像执行 SET key value 一样。

Type declaration

    • (key, value): number

    • Parameters

      • key: string
      • value: string

      Returns number

decr

decr: ((key) => number)

为键 key 储存的数字值减去一。

Type declaration

    • (key): number

    • Parameters

      • key: string

        键值

      Returns number

decrBy

decrBy: ((key, decrement) => void)

将键 key 储存的整数值减去减量 decrement 。

Type declaration

    • (key, decrement): void

    • Parameters

      • key: string

        键值

      • decrement: number

        必须是正整数

      Returns void

get

get: ((key) => string)

返回与键 key 相关联的字符串值。

Type declaration

    • (key): string

    • Parameters

      • key: string

        键值

      Returns string

getset

getset: ((key, value) => string)

将键 key 的值设为 value ， 并返回键 key 在被设置之前的旧值。

返回给定键 key 的旧值。

如果键 key 没有旧值， 也即是说， 键 key 在被设置之前并不存在， 那么命令返回 nil 。

Type declaration

    • (key, value): string

    • Parameters

      • key: string
      • value: string

      Returns string

incr

incr: ((key) => number)

为键 key 储存的数字值加上 1

Type declaration

    • (key): number

    • Parameters

      • key: string

        键值

      Returns number

incrBy

incrBy: ((key, increment) => number)

为键 key 储存的数字值加上增量 increment

Type declaration

    • (key, increment): number

    • Parameters

      • key: string

        键值

      • increment: number

        必须是正整数

      Returns number

strlen

strlen: ((key) => number)

返回键 key 储存的字符串值的长度。

Type declaration

    • (key): number

    • Parameters

      • key: string

      Returns number

Methods

set

  • set(key, value, expireInSeconds): boolean

  • 将字符串值 value 关联到 key

    Parameters

    • key: string

      键

    • value: string

      值

    • expireInSeconds: number

      超时时间，如果为0表示永不超时

    Returns boolean

  • set(key, value, opt?): string

  • 将字符串值 value 关联到 key

    只在设置操作成功完成时才返回 OK ； 如果命令使用了 NX 或者 XX 选项， 但是因为条件没达到而造成设置操作未执行， 那么命令将返回空批量回复

    Parameters

    • key: string

      键

    • value: string

      值

    • Optional opt: SetOption

      可选参数，参考 setOption

    Returns string

Settings

Member Visibility

Theme

On This Page

appenddecrdecrBygetgetsetincrincrBystrlenset