Variable default`Const`

default: {
    Client: (new (url: string) => {
        del(...keys: string[]): number;
        get(key: string): string;
        hDel(key: string, ...fields: string[]): number;
        hGet(key: string, field: string): string;
        hLen(key: string): number;
        hSet(key: string, ...members: (string | number)[]): number;
        lIndex(key: string, index: number): string;
        lLen(key: string): number;
        lPop(key: string): string;
        lPush(key: string, ...values: (string | number)[]): number;
        lRange(key: string, start: any, stop: number): string[];
        lRem(key: string, count: number, value: string | number): number;
        lSet(key: string, index: number, value: string | number): string;
        rPop(key: string): string;
        rPush(key: string, ...values: (string | number)[]): number;
        sAdd(key: string, ...members: (string | number)[]): number;
        set(key: string, value: string, expiration?: number): string;
        sIsMember(key: string, member: string | number): boolean;
        sMembers(key: string): string[];
        sPop(key: string): string;
        sRandMember(key: string): string;
        sRem(key: string, ...members: (string | number)[]): number;
    });
}

Type declaration

Client: (new (url: string) => {
    del(...keys: string[]): number;
    get(key: string): string;
    hDel(key: string, ...fields: string[]): number;
    hGet(key: string, field: string): string;
    hLen(key: string): number;
    hSet(key: string, ...members: (string | number)[]): number;
    lIndex(key: string, index: number): string;
    lLen(key: string): number;
    lPop(key: string): string;
    lPush(key: string, ...values: (string | number)[]): number;
    lRange(key: string, start: any, stop: number): string[];
    lRem(key: string, count: number, value: string | number): number;
    lSet(key: string, index: number, value: string | number): string;
    rPop(key: string): string;
    rPush(key: string, ...values: (string | number)[]): number;
    sAdd(key: string, ...members: (string | number)[]): number;
    set(key: string, value: string, expiration?: number): string;
    sIsMember(key: string, member: string | number): boolean;
    sMembers(key: string): string[];
    sPop(key: string): string;
    sRandMember(key: string): string;
    sRem(key: string, ...members: (string | number)[]): number;
})

Client 新建 redis client 实例。

new (url): {
    del(...keys: string[]): number;
    get(key: string): string;
    hDel(key: string, ...fields: string[]): number;
    hGet(key: string, field: string): string;
    hLen(key: string): number;
    hSet(key: string, ...members: (string | number)[]): number;
    lIndex(key: string, index: number): string;
    lLen(key: string): number;
    lPop(key: string): string;
    lPush(key: string, ...values: (string | number)[]): number;
    lRange(key: string, start: any, stop: number): string[];
    lRem(key: string, count: number, value: string | number): number;
    lSet(key: string, index: number, value: string | number): string;
    rPop(key: string): string;
    rPush(key: string, ...values: (string | number)[]): number;
    sAdd(key: string, ...members: (string | number)[]): number;
    set(key: string, value: string, expiration?: number): string;
    sIsMember(key: string, member: string | number): boolean;
    sMembers(key: string): string[];
    sPop(key: string): string;
    sRandMember(key: string): string;
    sRem(key: string, ...members: (string | number)[]): number;
}

Parameters

url: string
redis 地址，如 redis://:@:/<db_number>。

Returns {
    del(...keys: string[]): number;
    get(key: string): string;
    hDel(key: string, ...fields: string[]): number;
    hGet(key: string, field: string): string;
    hLen(key: string): number;
    hSet(key: string, ...members: (string | number)[]): number;
    lIndex(key: string, index: number): string;
    lLen(key: string): number;
    lPop(key: string): string;
    lPush(key: string, ...values: (string | number)[]): number;
    lRange(key: string, start: any, stop: number): string[];
    lRem(key: string, count: number, value: string | number): number;
    lSet(key: string, index: number, value: string | number): string;
    rPop(key: string): string;
    rPush(key: string, ...values: (string | number)[]): number;
    sAdd(key: string, ...members: (string | number)[]): number;
    set(key: string, value: string, expiration?: number): string;
    sIsMember(key: string, member: string | number): boolean;
    sMembers(key: string): string[];
    sPop(key: string): string;
    sRandMember(key: string): string;
    sRem(key: string, ...members: (string | number)[]): number;
}

del:function

del(...keys): number

执行 del 命令，删除已存在的 key。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let setResp = client.set("key", "hello, world", 0);
    console.log(`redis set ${setResp}`); // OK
    let delResp = client.del("key");
    console.log(`redis del ${delResp}`); // 1
}

Parameters

Rest...keys: string[]
键名

Returns number

结果，成功返回被删除条目的数量

get:function

get(key): string

执行 get 命令，获取指定 key 的值。

import redis from "pts/redis";

let client = new redis.Client("redis://<password>@<host>:6379/0");

export default function main() {
    let setResp = client.set("key", "hello, world", 0);
    console.log(`redis set ${setResp}`); // OK
    let getResp = client.get("key");
    console.log(`redis get ${getResp}`); // hello, world
}

Parameters

key: string
键名

Returns string

结果，成功返回 string

hDel:function

hDel(key, ...fields): number

执行 hDel 命令，删除一个或多个哈希表字段。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let hSetResp = client.hSet("hash", "k", 1, "k1", 2);
    console.log(`redis hSet ${hSetResp}`); // 2
    let hDelResp = client.hDel("hash", "k");
    console.log(`redis hDel ${hDelResp}`); // 1
}

Parameters

key: string
键名
Rest...fields: string[]
字段名

Returns number

结果，成功时返回被删除条目的数量

hGet:function

hGet(key, field): string

执行 hGet 命令，获取存储在哈希表中指定字段的值。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let hSetResp = client.hSet("hash", "k", 1, "k1", 2); // [k1, v1, k2, v2, ...]
    console.log(`redis hSet ${hSetResp}`); // 2
    let hGetResp = client.hGet("hash", "k");
    console.log(`redis hGet ${hGetResp}`); // 1
}

Parameters

key: string
键名
field: string
字段名

Returns string

结果，成功时返回对应字段的值

hLen:function

hLen(key): number

执行 hLen 命令，获取哈希表中字段的数量。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let hSetResp = client.hSet("hash", "k", 1, "k1", 2);
    console.log(`redis hSet ${hSetResp}`); // 2
    let hLenResp = client.hLen("hash");
    console.log(`redis hLen ${hLenResp}`); // 2
}

Parameters

key: string
键名

Returns number

结果，成功时返回条目的数量

hSet:function
- hSet(key, ...members): number
- 执行 hSet 命令，设置哈希表 key 中的字段和值。
```
import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let hSetResp = client.hSet("hash", "k", 1); // [k1, v1, k2, v2, ...]
    console.log(`redis hSet ${hSetResp}`); // 1
}
```
  Parameters
  - key: string
    键名
  - Rest...members: (string | number)[]
    hash 成员，以 key1、value1、key2、value2 形式输入
  Returns number
  结果，成功时返回添加成功的条数
  - Defined in typings/redis.d.ts:295

lIndex:function

lIndex(key, index): string

执行 lIndex 命令，通过索引获取列表中的元素。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let lPushResp = client.lPush("list", "foo", "bar", "zoo");
    console.log(`redis lPush ${lPushResp}`); // 3
    let lIndexResp = client.lIndex("list", 1);
    console.log(`redis lIndex ${lIndexResp}`); // bar
}

Parameters

key: string
键名
index: number
索引

Returns string

结果，成功时返回索引对应的元素

lLen:function

lLen(key): number

执行 lLen 命令，获取列表长度。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let lPushResp = client.lPush("list", "foo", "bar", "zoo");
    console.log(`redis lPush ${lPushResp}`); // 3
    let lLenResp = client.lLen("list");
    console.log(`redis lLen ${lLenResp}`); // 3
}

Parameters

key: string
键名

Returns number

结果，成功时返回列表的长度

lPop:function

lPop(key): string

执行 lPop 命令，移除并获取列表的第一个元素。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let lPushResp = client.lPush("list", "foo");
    console.log(`redis lPush ${lPushResp}`); // 1
    let lPopResp = client.lPop("list");
    console.log(`redis lPop ${lPopResp}`); // foo
}

Parameters

key: string
键名

Returns string

结果，成功时返回列表中的第一个元素

lPush:function

lPush(key, ...values): number

执行 lPush 命令，将一个或多个值插入到列表头部。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let lPushResp = client.lPush("list", "foo");
    console.log(`redis lPush ${lPushResp}`); // 1
}

Parameters

key: string
键名
Rest...values: (string | number)[]
值

Returns number

结果，成功返回插入后list的长度

lRange:function

lRange(key, start, stop): string[]

执行 lRange 命令，获取列表指定范围内的元素。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let lPushResp = client.lPush("list", "foo", "bar", "zoo");
    console.log(`redis lPush ${lPushResp}`); // 3
    let lRangeResp = client.lRange("list", 0, 1);
    console.log(`redis lRange ${lRangeResp}`); // zoo,bar
}

Parameters

key: string
键名
start: any
起始位置
stop: number
结束位置

Returns string[]

结果，成功时返回 [start, stop] 区间的元素

lRem:function

lRem(key, count, value): number

执行 lRem 命令，移除列表元素。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let lPushResp = client.lPush("list", "foo", "bar", "zoo", "foo", "bar", "zoo");
    console.log(`redis lPush ${lPushResp}`); // 6
    let lRemResp1 = client.lRem("list", 1, "bar");
    console.log(`redis lRem ${lRemResp1}`); // 1
    let lRemResp2 = client.lRem("list", -1, "foo");
    console.log(`redis lRem ${lRemResp2}`); // 1
    let lRangeResp = client.lRange("list", 0, 4);
    console.log(`redis lRange ${lRangeResp}`); // zoo,foo,zoo,bar
}

Parameters

key: string
键名
count: number
移除的数量，正数表示从表头开始，负数表示从表尾开始，0 代表全部移除
value: string | number
移除元素的值

Returns number

结果，成功时返回移除元素的数量

lSet:function

lSet(key, index, value): string

执行 lSet 命令，通过索引设置列表元素的值。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let lPushResp = client.lPush("list", "foo", "bar", "zoo");
    console.log(`redis lPush ${lPushResp}`); // 3
    let lSetResp = client.lSet("list", 1, "bar2");
    console.log(`redis lSet ${lSetResp}`); // OK
    let lIndexResp = client.lIndex("list", 1);
    console.log(`redis lIndex ${lIndexResp}`); // bar2
}

Parameters

key: string
键名
index: number
索引
value: string | number
值

Returns string

结果，成功时返回列表的长度

rPop:function

rPop(key): string

执行 rPop 命令，移除并获取列表的最后一个元素。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let rPushResp = client.rPush("list", "foo");
    console.log(`redis rPush ${rPushResp}`); // 1
    let rPopResp = client.rPop("list");
    console.log(`redis rPop ${rPopResp}`); // foo
}

Parameters

key: string
键名

Returns string

结果，成功时返回列表中的最后一个元素

rPush:function

rPush(key, ...values): number

执行 rPush 命令，将一个或多个值插入到列表尾部。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let rPushResp = client.rPush("list", "foo");
    console.log(`redis rPush ${rPushResp}`); // 1
}

Parameters

key: string
键名
Rest...values: (string | number)[]
值

Returns number

结果，成功返回插入后list的长度

sAdd:function
- sAdd(key, ...members): number
- 执行 sAdd 命令，向集合添加一个或多个成员。
```
import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let sAddResp = client.sAdd("set", "hello");
    console.log(`redis sAdd ${sAddResp}`); // 1
}
```
  Parameters
  - key: string
    键名
  - Rest...members: (string | number)[]
    待添加的成员
  Returns number
  结果，成功时返回添加成功的数量
  - Defined in typings/redis.d.ts:380

set:function

set(key, value, expiration?): string

执行 set 命令，设置指定 key 的值。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let setResp = client.set("key", "hello, world", 0);
    console.log(`redis set ${setResp}`); // OK
    let getResp = client.get("key");
    console.log(`redis get ${getResp}`); // hello, world
}

Parameters

key: string
键名
value: string
值
Optionalexpiration: number
过期时间，单位秒，可选，不填不设置，-1 代表 keepttl

Returns string

结果，成功返回 "OK"

sIsMember:function

sIsMember(key, member): boolean

执行 sIsMember 命令，判断 member 元素是否是集合 key 的成员。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let sAddResp = client.sAdd("set", "hello", "world");
    console.log(`redis sAdd ${sAddResp}`); // 2
    let sIsMemberResp = client.sIsMember("set", "hello");
    console.log(`redis sIsMember ${sIsMemberResp}`); // true
}

Parameters

key: string
键名
member: string | number
待查询的成员

Returns boolean

结果，存在时返回 true，否则返回 false

sMembers:function

sMembers(key): string[]

执行 sMembers 命令，返回集合中的所有成员。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let sAddResp = client.sAdd("set", "hello", "world");
    console.log(`redis sAdd ${sAddResp}`); // 2
    let sMembersResp = client.sMembers("set");
    console.log(`redis sMembers ${sMembersResp}`); // hello,world
}

Parameters

key: string
键名

Returns string[]

结果，成功时返回所有的元素

sPop:function

sPop(key): string

执行 sPop 命令，随机移除并返回集合中的一个元素。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let sAddResp = client.sAdd("set", "hello", "world");
    console.log(`redis sAdd ${sAddResp}`); // 2
    let sPopResp = client.sPop("set");
    console.log(`redis sPop ${sPopResp}`); // world
}

Parameters

key: string
键名

Returns string

结果，成功时随机删除一个元素并返回

sRandMember:function

sRandMember(key): string

执行 sRandMember 命令，随机返回集合中一个元素。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let sAddResp = client.sAdd("set", "hello", "world");
    console.log(`redis sAdd ${sAddResp}`); // 2
    let sRandMemberResp = client.sRandMember("set");
    console.log(`redis sRandMember ${sRandMemberResp}`); // world
}

Parameters

key: string
键名

Returns string

结果，成功时随机返回一个元素

sRem:function

sRem(key, ...members): number

执行 sRem 命令，移除集合中一个或多个成员。

import redis from "pts/redis";

let client = new redis.Client("redis://:<password>@<host>:6379/0");

export default function main() {
    let sAddResp = client.sAdd("set", "hello", "world");
    console.log(`redis sAdd ${sAddResp}`); // 2
    let sRemResp = client.sRem("set", "hello");
    console.log(`redis sRem ${sRemResp}`); // 1
}

Parameters

key: string
键名
Rest...members: (string | number)[]
待删除的成员

Returns number

结果，成功时返回删除成功的数量

Variable defaultConst

Type declaration

Parameters

del:function

Parameters

Returns number

get:function

Parameters

Returns string

hDel:function

Parameters

Returns number

hGet:function

Parameters

Returns string

hLen:function

Parameters

Returns number

hSet:function

Parameters

Returns number

lIndex:function

Parameters

Returns string

lLen:function

Parameters

Returns number

lPop:function

Parameters

Returns string

lPush:function

Parameters

Returns number

lRange:function

Parameters

Returns string[]

lRem:function

Parameters

Returns number

lSet:function

Parameters

Returns string

rPop:function

Parameters

Returns string

rPush:function

Parameters

Returns number

sAdd:function

Parameters

Returns number

set:function

Parameters

Returns string

sIsMember:function

Parameters

Returns boolean

sMembers:function

Parameters

Returns string[]

sPop:function

Parameters

Returns string

sRandMember:function

Parameters

Returns string

sRem:function

Parameters

Returns number

Settings

Variable default`Const`