|
| 1 | +import { Commands, RedisClient, ClientOpts, ServerInfo } from 'redis'; |
| 2 | +import {EventEmitter} from "events"; |
| 3 | + |
| 4 | +type Callback<T> = (err: Error | null, reply: T) => void; |
| 5 | + |
| 6 | +type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>; |
| 7 | +type Omitted = Omit<RedisClient, keyof Commands<boolean>>; |
| 8 | +type OkOrError = 'OK'|Error |
| 9 | + |
| 10 | +interface OverloadedCommand<T, R> { |
| 11 | + (arg1: T, arg2: T, arg3: T, arg4: T, arg5: T, arg6: T): R; |
| 12 | + (arg1: T, arg2: T, arg3: T, arg4: T, arg5: T): R; |
| 13 | + (arg1: T, arg2: T, arg3: T, arg4: T): R; |
| 14 | + (arg1: T, arg2: T, arg3: T): R; |
| 15 | + (arg1: T, arg2: T | T[]): R; |
| 16 | + (arg1: T | T[]): R; |
| 17 | + (...args: Array<T>): R; |
| 18 | +} |
| 19 | + |
| 20 | +interface Promisified<T = RedisClient> extends Omitted, Commands<Promise<boolean>> {} |
| 21 | + |
| 22 | +interface AsyncRedisConstructor { |
| 23 | + new (port: number, host?: string, options?: ClientOpts): Promisified; |
| 24 | + new (unix_socket: string, options?: ClientOpts): Promisified; |
| 25 | + new (redis_url: string, options?: ClientOpts): Promisified; |
| 26 | + new (options?: ClientOpts): Promisified; |
| 27 | + |
| 28 | + createClient(port: number, host?: string, options?: ClientOpts): Promisified; |
| 29 | + createClient(unix_socket: string, options?: ClientOpts): Promisified; |
| 30 | + createClient(redis_url: string, options?: ClientOpts): Promisified; |
| 31 | + createClient(options?: ClientOpts): Promisified; |
| 32 | + |
| 33 | + decorate: (client: RedisClient) => Promisified; |
| 34 | +} |
| 35 | + |
| 36 | +interface AsyncRedisEventHandlers extends EventEmitter { |
| 37 | + on(event: 'message' | 'message_buffer', listener: (channel: string, message: string) => void): this; |
| 38 | + on(event: 'pmessage' | 'pmessage_buffer', listener: (pattern: string, channel: string, message: string) => void): this; |
| 39 | + on(event: 'subscribe' | 'unsubscribe', listener: (channel: string, count: number) => void): this; |
| 40 | + on(event: 'psubscribe' | 'punsubscribe', listener: (pattern: string, count: number) => void): this; |
| 41 | + on(event: string, listener: (...args: any[]) => void): this; |
| 42 | +} |
| 43 | + |
| 44 | +interface AsyncRedisCommands<R> { |
| 45 | + /** |
| 46 | + * Listen for all requests received by the server in real time. |
| 47 | + */ |
| 48 | + monitor(cb?: Callback<undefined>): any; |
| 49 | + MONITOR(cb?: Callback<undefined>): any; |
| 50 | + |
| 51 | + /** |
| 52 | + * Get information and statistics about the server. |
| 53 | + */ |
| 54 | + info(): Promise<ServerInfo|boolean>; |
| 55 | + info(section?: string | string[]): Promise<ServerInfo|boolean>; |
| 56 | + INFO(): Promise<ServerInfo|boolean>; |
| 57 | + INFO(section?: string | string[]): Promise<ServerInfo|boolean>; |
| 58 | + |
| 59 | + /** |
| 60 | + * Ping the server. |
| 61 | + */ |
| 62 | + ping(): Promise<string|boolean>; |
| 63 | + ping(message: string): Promise<string|boolean>; |
| 64 | + PING(): Promise<string|boolean>; |
| 65 | + PING(message: string): Promise<string|boolean>; |
| 66 | + |
| 67 | + /** |
| 68 | + * Authenticate to the server. |
| 69 | + */ |
| 70 | + auth(password: string): Promise<string>; |
| 71 | + AUTH(password: string): Promise<string>; |
| 72 | + |
| 73 | + /** |
| 74 | + * Get array of Redis command details. |
| 75 | + * |
| 76 | + * COUNT - Get total number of Redis commands. |
| 77 | + * GETKEYS - Extract keys given a full Redis command. |
| 78 | + * INFO - Get array of specific REdis command details. |
| 79 | + */ |
| 80 | + command(cb?: Callback<Array<[string, number, string[], number, number, number]>>): R; |
| 81 | + COMMAND(cb?: Callback<Array<[string, number, string[], number, number, number]>>): R; |
| 82 | + |
| 83 | + /** |
| 84 | + * Get array of Redis command details. |
| 85 | + * |
| 86 | + * COUNT - Get array of Redis command details. |
| 87 | + * GETKEYS - Extract keys given a full Redis command. |
| 88 | + * INFO - Get array of specific Redis command details. |
| 89 | + * GET - Get the value of a configuration parameter. |
| 90 | + * REWRITE - Rewrite the configuration file with the in memory configuration. |
| 91 | + * SET - Set a configuration parameter to the given value. |
| 92 | + * RESETSTAT - Reset the stats returned by INFO. |
| 93 | + */ |
| 94 | + config: OverloadedCommand<string, boolean>; |
| 95 | + CONFIG: OverloadedCommand<string, boolean>; |
| 96 | + |
| 97 | + /** |
| 98 | + * Return the number of keys in the selected database. |
| 99 | + */ |
| 100 | + dbsize(): Promise<number>; |
| 101 | + DBSIZE(): Promise<number>; |
| 102 | + |
| 103 | + /** |
| 104 | + * OBJECT - Get debugging information about a key. |
| 105 | + * SEGFAULT - Make the server crash. |
| 106 | + */ |
| 107 | + debug: OverloadedCommand<string, boolean>; |
| 108 | + DEBUG: OverloadedCommand<string, boolean>; |
| 109 | + |
| 110 | + /** |
| 111 | + * PubSub Commands |
| 112 | + */ |
| 113 | + /** |
| 114 | + * Post a message to a channel. |
| 115 | + */ |
| 116 | + publish(channel: string, value: string): Promise<number|boolean>; |
| 117 | + PUBLISH(channel: string, value: string): Promise<number|boolean>; |
| 118 | + |
| 119 | + /** |
| 120 | + * CRUD Commands |
| 121 | + */ |
| 122 | + |
| 123 | + /** |
| 124 | + * Append a value to a key. |
| 125 | + */ |
| 126 | + append(key: string, value: string): Promise<number>; |
| 127 | + APPEND(key: string, value: string): Promise<number>; |
| 128 | + |
| 129 | + /** |
| 130 | + * Asynchronously rewrite the append-only file. |
| 131 | + */ |
| 132 | + bgrewriteaof(): Promise<OkOrError>; |
| 133 | + BGREWRITEAOF(): Promise<OkOrError>; |
| 134 | + |
| 135 | + /** |
| 136 | + * Asynchronously save the dataset to disk. |
| 137 | + */ |
| 138 | + bgsave(): Promise<OkOrError>; |
| 139 | + BGSAVE(): Promise<OkOrError>; |
| 140 | + |
| 141 | + /** |
| 142 | + * Determine if a key exists. |
| 143 | + */ |
| 144 | + exists: OverloadedCommand<string, R>; |
| 145 | + EXISTS: OverloadedCommand<string, R>; |
| 146 | + |
| 147 | + /** |
| 148 | + * Set the string value of a key. |
| 149 | + */ |
| 150 | + set(key: string, value: string): Promise<string|boolean>; |
| 151 | + set(key: string, value: string, flag: string): Promise<string|boolean>; |
| 152 | + set(key: string, value: string, mode: string, duration: number): Promise<string|undefined>; |
| 153 | + set(key: string, value: string, mode: string, duration: number, flag: string): Promise<string|undefined>; |
| 154 | + SET(key: string, value: string): Promise<string|boolean>; |
| 155 | + SET(key: string, value: string, flag: string): Promise<string|boolean>; |
| 156 | + SET(key: string, value: string, mode: string, duration: number): Promise<string|undefined>; |
| 157 | + SET(key: string, value: string, mode: string, duration: number, flag: string): Promise<string|undefined>; |
| 158 | +} |
| 159 | + |
| 160 | +interface AsyncRedisInterface extends AsyncRedisConstructor, AsyncRedisEventHandlers, AsyncRedisCommands<boolean> {} |
| 161 | +declare const AsyncRedis: AsyncRedisInterface; |
| 162 | +export = AsyncRedis; |
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4&size=40){kind=avatar}
0 commit comments