UNPKG

14.4 kBTypeScriptView Raw
1export interface RetryStrategyOptions {
2 error: Error;
3 total_retry_time: number;
4 times_connected: number;
5 attempt: number;
6}
7export interface ClientOpts {
8 auth_pass?: string;
9 command_queue_high_water?: number;
10 command_queue_low_water?: number;
11 connect_timeout?: number;
12 db?: string;
13 detect_buffers?: boolean;
14 disable_resubscribing?: boolean;
15 enable_offline_queue?: boolean;
16 family?: string;
17 host?: string;
18 max_attempts?: number;
19 no_ready_check?: boolean;
20 parser?: string;
21 password?: string;
22 path?: string;
23 port?: number;
24 prefix?: string;
25 rename_commands?: any;
26 retry_max_delay?: number;
27 retry_strategy?: any;
28 retry_unfulfilled_commands?: boolean;
29 return_buffers?: boolean;
30 socket_keepalive?: boolean;
31 socket_nodelay?: boolean;
32 string_numbers?: boolean;
33 tls?: any;
34 url?: string;
35}
36export interface RedisClient {
37 connected: boolean;
38 retry_delay: number;
39 retry_backoff: number;
40 command_queue: any[];
41 offline_queue: any[];
42 server_info: any;
43 /**
44 * Forcibly close the connection to the Redis server. Note that this does not wait until all replies have been parsed. If you want to exit cleanly, call client.quit()
45 *
46 * @param {boolean} flush You should set flush to true, if you are not absolutely sure you do not care about any other commands. If you set flush to false all still running commands will silently fail.
47 */
48 end(flush: boolean): void;
49 unref(): void;
50 /**
51 * Stop sending commands and queue the commands.
52 */
53 cork(): void;
54 /**
55 * Resume and send the queued commands at once.
56 */
57 uncork(): void;
58 send_command(command: string, ...args: any[]): boolean;
59 auth(password: string, callback?: any): boolean;
60 ping(callback?: any): boolean;
61 append(key: string, value: string, callback?: any): boolean;
62 bitcount(key: string, callback?: any): boolean;
63 bitcount(key: string, start: number, end: number, callback?: any): boolean;
64 set(key: string, value: string, callback?: any): boolean;
65 get(key: string, callback?: any): boolean;
66 exists(key: string, value: string, callback?: any): boolean;
67 publish(channel: string, value: any): boolean;
68 subscribe(channel: string): boolean;
69 on(event: string, callback: Function): any;
70 off(event: string, callback: Function): any;
71 addListener(event: string, callback: Function): any;
72 get(args: any[], callback?: any): boolean;
73 get(...args: any[]): boolean;
74 set(args: any[], callback?: any): boolean;
75 set(...args: any[]): boolean;
76 setnx(args: any[], callback?: any): boolean;
77 setnx(...args: any[]): boolean;
78 setex(args: any[], callback?: any): boolean;
79 setex(...args: any[]): boolean;
80 append(args: any[], callback?: any): boolean;
81 append(...args: any[]): boolean;
82 strlen(args: any[], callback?: any): boolean;
83 strlen(...args: any[]): boolean;
84 del(args: any[], callback?: any): boolean;
85 del(...args: any[]): boolean;
86 exists(args: any[], callback?: any): boolean;
87 exists(...args: any[]): boolean;
88 setbit(args: any[], callback?: any): boolean;
89 setbit(...args: any[]): boolean;
90 getbit(args: any[], callback?: any): boolean;
91 getbit(...args: any[]): boolean;
92 setrange(args: any[], callback?: any): boolean;
93 setrange(...args: any[]): boolean;
94 getrange(args: any[], callback?: any): boolean;
95 getrange(...args: any[]): boolean;
96 substr(args: any[], callback?: any): boolean;
97 substr(...args: any[]): boolean;
98 incr(args: any[], callback?: any): boolean;
99 incr(...args: any[]): boolean;
100 decr(args: any[], callback?: any): boolean;
101 decr(...args: any[]): boolean;
102 mget(args: any[], callback?: any): boolean;
103 mget(...args: any[]): boolean;
104 rpush(...args: any[]): boolean;
105 lpush(args: any[], callback?: any): boolean;
106 lpush(...args: any[]): boolean;
107 rpushx(args: any[], callback?: any): boolean;
108 rpushx(...args: any[]): boolean;
109 lpushx(args: any[], callback?: any): boolean;
110 lpushx(...args: any[]): boolean;
111 linsert(args: any[], callback?: any): boolean;
112 linsert(...args: any[]): boolean;
113 rpop(args: any[], callback?: any): boolean;
114 rpop(...args: any[]): boolean;
115 lpop(args: any[], callback?: any): boolean;
116 lpop(...args: any[]): boolean;
117 brpop(args: any[], callback?: any): boolean;
118 brpop(...args: any[]): boolean;
119 brpoplpush(args: any[], callback?: any): boolean;
120 brpoplpush(...args: any[]): boolean;
121 blpop(args: any[], callback?: any): boolean;
122 blpop(...args: any[]): boolean;
123 llen(args: any[], callback?: any): boolean;
124 llen(...args: any[]): boolean;
125 lindex(args: any[], callback?: any): boolean;
126 lindex(...args: any[]): boolean;
127 lset(args: any[], callback?: any): boolean;
128 lset(...args: any[]): boolean;
129 lrange(args: any[], callback?: any): boolean;
130 lrange(...args: any[]): boolean;
131 ltrim(args: any[], callback?: any): boolean;
132 ltrim(...args: any[]): boolean;
133 lrem(args: any[], callback?: any): boolean;
134 lrem(...args: any[]): boolean;
135 rpoplpush(args: any[], callback?: any): boolean;
136 rpoplpush(...args: any[]): boolean;
137 sadd(args: any[], callback?: any): boolean;
138 sadd(...args: any[]): boolean;
139 srem(args: any[], callback?: any): boolean;
140 srem(...args: any[]): boolean;
141 smove(args: any[], callback?: any): boolean;
142 smove(...args: any[]): boolean;
143 sismember(args: any[], callback?: any): boolean;
144 sismember(...args: any[]): boolean;
145 scard(args: any[], callback?: any): boolean;
146 scard(...args: any[]): boolean;
147 spop(args: any[], callback?: any): boolean;
148 spop(...args: any[]): boolean;
149 srandmember(args: any[], callback?: any): boolean;
150 srandmember(...args: any[]): boolean;
151 sinter(args: any[], callback?: any): boolean;
152 sinter(...args: any[]): boolean;
153 sinterstore(args: any[], callback?: any): boolean;
154 sinterstore(...args: any[]): boolean;
155 sunion(args: any[], callback?: any): boolean;
156 sunion(...args: any[]): boolean;
157 sunionstore(args: any[], callback?: any): boolean;
158 sunionstore(...args: any[]): boolean;
159 sdiff(args: any[], callback?: any): boolean;
160 sdiff(...args: any[]): boolean;
161 sdiffstore(args: any[], callback?: any): boolean;
162 sdiffstore(...args: any[]): boolean;
163 smembers(args: any[], callback?: any): boolean;
164 smembers(...args: any[]): boolean;
165 zadd(args: any[], callback?: any): boolean;
166 zadd(...args: any[]): boolean;
167 zincrby(args: any[], callback?: any): boolean;
168 zincrby(...args: any[]): boolean;
169 zrem(args: any[], callback?: any): boolean;
170 zrem(...args: any[]): boolean;
171 zremrangebyscore(args: any[], callback?: any): boolean;
172 zremrangebyscore(...args: any[]): boolean;
173 zremrangebyrank(args: any[], callback?: any): boolean;
174 zremrangebyrank(...args: any[]): boolean;
175 zunionstore(args: any[], callback?: any): boolean;
176 zunionstore(...args: any[]): boolean;
177 zinterstore(args: any[], callback?: any): boolean;
178 zinterstore(...args: any[]): boolean;
179 zrange(args: any[], callback?: any): boolean;
180 zrange(...args: any[]): boolean;
181 zrangebyscore(args: any[], callback?: any): boolean;
182 zrangebyscore(...args: any[]): boolean;
183 zrevrangebyscore(args: any[], callback?: any): boolean;
184 zrevrangebyscore(...args: any[]): boolean;
185 zcount(args: any[], callback?: any): boolean;
186 zcount(...args: any[]): boolean;
187 zrevrange(args: any[], callback?: any): boolean;
188 zrevrange(...args: any[]): boolean;
189 zcard(args: any[], callback?: any): boolean;
190 zcard(...args: any[]): boolean;
191 zscore(args: any[], callback?: any): boolean;
192 zscore(...args: any[]): boolean;
193 zrank(args: any[], callback?: any): boolean;
194 zrank(...args: any[]): boolean;
195 zrevrank(args: any[], callback?: any): boolean;
196 zrevrank(...args: any[]): boolean;
197 hset(args: any[], callback?: any): boolean;
198 hset(...args: any[]): boolean;
199 hsetnx(args: any[], callback?: any): boolean;
200 hsetnx(...args: any[]): boolean;
201 hget(args: any[], callback?: any): boolean;
202 hget(...args: any[]): boolean;
203 hmset(args: any[], callback?: any): boolean;
204 hmset(key: string, hash: any, callback?: any): boolean;
205 hmset(...args: any[]): boolean;
206 hmget(args: any[], callback?: any): boolean;
207 hmget(...args: any[]): boolean;
208 hincrby(args: any[], callback?: any): boolean;
209 hincrby(...args: any[]): boolean;
210 hincrbyfloat(args: any[], callback?: any): boolean;
211 hincrbyfloat(...args: any[]): boolean;
212 hdel(args: any[], callback?: any): boolean;
213 hdel(...args: any[]): boolean;
214 hlen(args: any[], callback?: any): boolean;
215 hlen(...args: any[]): boolean;
216 hkeys(args: any[], callback?: any): boolean;
217 hkeys(...args: any[]): boolean;
218 hvals(args: any[], callback?: any): boolean;
219 hvals(...args: any[]): boolean;
220 hgetall(args: any[], callback?: any): boolean;
221 hgetall(...args: any[]): boolean;
222 hgetall(key: string, callback?: any): boolean;
223 hexists(args: any[], callback?: any): boolean;
224 hexists(...args: any[]): boolean;
225 incrby(args: any[], callback?: any): boolean;
226 incrby(...args: any[]): boolean;
227 decrby(args: any[], callback?: any): boolean;
228 decrby(...args: any[]): boolean;
229 getset(args: any[], callback?: any): boolean;
230 getset(...args: any[]): boolean;
231 mset(args: any[], callback?: any): boolean;
232 mset(...args: any[]): boolean;
233 msetnx(args: any[], callback?: any): boolean;
234 msetnx(...args: any[]): boolean;
235 randomkey(args: any[], callback?: any): boolean;
236 randomkey(...args: any[]): boolean;
237 select(args: any[], callback?: any): void;
238 select(...args: any[]): void;
239 move(args: any[], callback?: any): boolean;
240 move(...args: any[]): boolean;
241 rename(args: any[], callback?: any): boolean;
242 rename(...args: any[]): boolean;
243 renamenx(args: any[], callback?: any): boolean;
244 renamenx(...args: any[]): boolean;
245 expire(args: any[], callback?: any): boolean;
246 expire(...args: any[]): boolean;
247 expireat(args: any[], callback?: any): boolean;
248 expireat(...args: any[]): boolean;
249 keys(args: any[], callback?: any): boolean;
250 keys(...args: any[]): boolean;
251 dbsize(args: any[], callback?: any): boolean;
252 dbsize(...args: any[]): boolean;
253 auth(args: any[], callback?: any): void;
254 auth(...args: any[]): void;
255 ping(args: any[], callback?: any): boolean;
256 ping(...args: any[]): boolean;
257 echo(args: any[], callback?: any): boolean;
258 echo(...args: any[]): boolean;
259 save(args: any[], callback?: any): boolean;
260 save(...args: any[]): boolean;
261 bgsave(args: any[], callback?: any): boolean;
262 bgsave(...args: any[]): boolean;
263 bgrewriteaof(args: any[], callback?: any): boolean;
264 bgrewriteaof(...args: any[]): boolean;
265 shutdown(args: any[], callback?: any): boolean;
266 shutdown(...args: any[]): boolean;
267 lastsave(args: any[], callback?: any): boolean;
268 lastsave(...args: any[]): boolean;
269 type(args: any[], callback?: any): boolean;
270 type(...args: any[]): boolean;
271 any(args: any[], callback?: any): any;
272 any(...args: any[]): any;
273 exec(args: any[], callback?: any): boolean;
274 exec(...args: any[]): boolean;
275 discard(args: any[], callback?: any): boolean;
276 discard(...args: any[]): boolean;
277 sync(args: any[], callback?: any): boolean;
278 sync(...args: any[]): boolean;
279 flushdb(args: any[], callback?: any): boolean;
280 flushdb(...args: any[]): boolean;
281 flushall(args: any[], callback?: any): boolean;
282 flushall(...args: any[]): boolean;
283 sort(args: any[], callback?: any): boolean;
284 sort(...args: any[]): boolean;
285 info(args: any[], callback?: any): boolean;
286 info(...args: any[]): boolean;
287 monitor(args: any[], callback?: any): boolean;
288 monitor(...args: any[]): boolean;
289 ttl(args: any[], callback?: any): boolean;
290 ttl(...args: any[]): boolean;
291 persist(args: any[], callback?: any): boolean;
292 persist(...args: any[]): boolean;
293 slaveof(args: any[], callback?: any): boolean;
294 slaveof(...args: any[]): boolean;
295 debug(args: any[], callback?: any): boolean;
296 debug(...args: any[]): boolean;
297 config(args: any[], callback?: any): boolean;
298 config(...args: any[]): boolean;
299 subscribe(args: any[], callback?: any): boolean;
300 subscribe(...args: any[]): boolean;
301 unsubscribe(args: any[], callback?: any): boolean;
302 unsubscribe(...args: any[]): boolean;
303 psubscribe(args: any[], callback?: any): boolean;
304 psubscribe(...args: any[]): boolean;
305 punsubscribe(args: any[], callback?: any): boolean;
306 punsubscribe(...args: any[]): boolean;
307 publish(args: any[], callback?: any): boolean;
308 publish(...args: any[]): boolean;
309 watch(args: any[], callback?: any): boolean;
310 watch(...args: any[]): boolean;
311 unwatch(args: any[], callback?: any): boolean;
312 unwatch(...args: any[]): boolean;
313 cluster(args: any[], callback?: any): boolean;
314 cluster(...args: any[]): boolean;
315 restore(args: any[], callback?: any): boolean;
316 restore(...args: any[]): boolean;
317 migrate(args: any[], callback?: any): boolean;
318 migrate(...args: any[]): boolean;
319 dump(args: any[], callback?: any): boolean;
320 dump(...args: any[]): boolean;
321 object(args: any[], callback?: any): boolean;
322 object(...args: any[]): boolean;
323 client(args: any[], callback?: any): boolean;
324 client(...args: any[]): boolean;
325 eval(args: any[], callback?: any): boolean;
326 eval(...args: any[]): boolean;
327 evalsha(args: any[], callback?: any): boolean;
328 evalsha(...args: any[]): boolean;
329 script(args: any[], callback?: any): boolean;
330 script(...args: any[]): boolean;
331 script(key: string, callback?: any): boolean;
332 quit(args: any[], callback?: any): boolean;
333 quit(...args: any[]): boolean;
334 sscan(...args: any[]): boolean;
335 sscan(args: any[], callback?: any): boolean;
336 scan(...args: any[]): boolean;
337 scan(args: any[], callback?: any): boolean;
338 hscan(...args: any[]): boolean;
339 hscan(args: any[], callback?: any): boolean;
340 zscan(...args: any[]): boolean;
341 zscan(args: any[], callback?: any): boolean;
342 duplicate(options?: any[], callback?: any): RedisClient;
343}