diff --git a/lib/cluster/index.ts b/lib/cluster/index.ts index 202bd0a15..a572adaf8 100644 --- a/lib/cluster/index.ts +++ b/lib/cluster/index.ts @@ -1457,7 +1457,80 @@ class Cluster< // eslint-disable-next-line @typescript-eslint/no-unused-vars interface Cluster - extends EventEmitter {} + extends EventEmitter { + on(event: "message", cb: (channel: string, message: string) => void): this; + once(event: "message", cb: (channel: string, message: string) => void): this; + + on( + event: "messageBuffer", + cb: (channel: Buffer, message: Buffer) => void + ): this; + once( + event: "messageBuffer", + cb: (channel: Buffer, message: Buffer) => void + ): this; + + on( + event: "pmessage", + cb: (pattern: string, channel: string, message: string) => void + ): this; + once( + event: "pmessage", + cb: (pattern: string, channel: string, message: string) => void + ): this; + + on( + event: "pmessageBuffer", + cb: (pattern: string, channel: Buffer, message: Buffer) => void + ): this; + once( + event: "pmessageBuffer", + cb: (pattern: string, channel: Buffer, message: Buffer) => void + ): this; + + on(event: "smessage", cb: (channel: string, message: string) => void): this; + once(event: "smessage", cb: (channel: string, message: string) => void): this; + + on( + event: "smessageBuffer", + cb: (channel: Buffer, message: Buffer) => void + ): this; + once( + event: "smessageBuffer", + cb: (channel: Buffer, message: Buffer) => void + ): this; + + on(event: "error", cb: (error: Error) => void): this; + once(event: "error", cb: (error: Error) => void): this; + + on(event: "+node", cb: (node: Redis) => void): this; + once(event: "+node", cb: (node: Redis) => void): this; + + on(event: "-node", cb: (node: Redis, nodeKey?: string) => void): this; + once(event: "-node", cb: (node: Redis, nodeKey?: string) => void): this; + + on(event: "node error", cb: (error: Error, nodeKey: string) => void): this; + once(event: "node error", cb: (error: Error, nodeKey: string) => void): this; + + on(event: "nodeError", cb: (error: Error, nodeKey: string) => void): this; + once(event: "nodeError", cb: (error: Error, nodeKey: string) => void): this; + + on( + event: "+subscriber" | "-subscriber" | "subscribersReady" | "refresh", + cb: () => void + ): this; + once( + event: "+subscriber" | "-subscriber" | "subscribersReady" | "refresh", + cb: () => void + ): this; + + on(event: ClusterStatus, cb: () => void): this; + once(event: ClusterStatus, cb: () => void): this; + + // base method of EventEmitter + on(event: string | symbol, listener: (...args: any[]) => void): this; + once(event: string | symbol, listener: (...args: any[]) => void): this; +} applyMixin(Cluster, EventEmitter); addTransactionSupport(Cluster.prototype); diff --git a/test/typing/cluster-events.test-d.ts b/test/typing/cluster-events.test-d.ts new file mode 100644 index 000000000..432d081e8 --- /dev/null +++ b/test/typing/cluster-events.test-d.ts @@ -0,0 +1,144 @@ +import { expectType } from "tsd"; +import { Cluster, Redis } from "../../built"; + +const cluster = new Cluster([]); + +expectType(cluster.on("connect", () => {})); +expectType(cluster.on("ready", () => {})); +expectType(cluster.on("close", () => {})); +expectType(cluster.on("reconnecting", () => {})); +expectType(cluster.on("end", () => {})); +expectType(cluster.on("disconnecting", () => {})); +expectType(cluster.on("wait", () => {})); + +expectType( + cluster.on("error", (error) => { + expectType(error); + }) +); + +expectType(cluster.once("connect", () => {})); +expectType(cluster.once("ready", () => {})); +expectType(cluster.once("close", () => {})); +expectType(cluster.once("reconnecting", () => {})); +expectType(cluster.once("end", () => {})); +expectType(cluster.once("disconnecting", () => {})); +expectType(cluster.once("wait", () => {})); + +expectType( + cluster.once("error", (error) => { + expectType(error); + }) +); + +cluster.on("message", (channel, message) => { + expectType(channel); + expectType(message); +}); + +cluster.on("messageBuffer", (channel, message) => { + expectType(channel); + expectType(message); +}); + +cluster.on("pmessage", (pattern, channel, message) => { + expectType(pattern); + expectType(channel); + expectType(message); +}); + +cluster.on("pmessageBuffer", (pattern, channel, message) => { + expectType(pattern); + expectType(channel); + expectType(message); +}); + +cluster.on("smessage", (channel, message) => { + expectType(channel); + expectType(message); +}); + +cluster.on("smessageBuffer", (channel, message) => { + expectType(channel); + expectType(message); +}); + +cluster.once("message", (channel, message) => { + expectType(channel); + expectType(message); +}); + +cluster.once("messageBuffer", (channel, message) => { + expectType(channel); + expectType(message); +}); + +cluster.once("pmessage", (pattern, channel, message) => { + expectType(pattern); + expectType(channel); + expectType(message); +}); + +cluster.once("pmessageBuffer", (pattern, channel, message) => { + expectType(pattern); + expectType(channel); + expectType(message); +}); + +cluster.once("smessage", (channel, message) => { + expectType(channel); + expectType(message); +}); + +cluster.once("smessageBuffer", (channel, message) => { + expectType(channel); + expectType(message); +}); + +cluster.on("+node", (node) => { + expectType(node); +}); + +cluster.on("-node", (node, nodeKey) => { + expectType(node); + expectType(nodeKey); +}); + +cluster.on("node error", (error, nodeKey) => { + expectType(error); + expectType(nodeKey); +}); + +cluster.on("nodeError", (error, nodeKey) => { + expectType(error); + expectType(nodeKey); +}); + +cluster.once("+node", (node) => { + expectType(node); +}); + +cluster.once("-node", (node, nodeKey) => { + expectType(node); + expectType(nodeKey); +}); + +cluster.once("node error", (error, nodeKey) => { + expectType(error); + expectType(nodeKey); +}); + +cluster.once("nodeError", (error, nodeKey) => { + expectType(error); + expectType(nodeKey); +}); + +cluster.on("+subscriber", () => {}); +cluster.on("-subscriber", () => {}); +cluster.on("subscribersReady", () => {}); +cluster.on("refresh", () => {}); + +cluster.once("+subscriber", () => {}); +cluster.once("-subscriber", () => {}); +cluster.once("subscribersReady", () => {}); +cluster.once("refresh", () => {});