Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Bottleneck event emitters method types to return the instance #165

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update Bottleneck event emitters method types to return the instance #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a341832
Update Bottleneck event emitters methods to return the instance
dobesv Aug 20, 2020
54b6d45
Fix other cases of on and once
dobesv Aug 20, 2020
c6247f7
Update ejs types file as well
dobesv Aug 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 44 additions & 44 deletions bottleneck.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,14 +223,14 @@ declare module "bottleneck" {
* @param name - The event name.
* @param fn - The callback function.
*/
on(name: "error", fn: (error: any) => void): void;
on(name: "error", fn: (error: any) => void): RedisConnection;

/**
* Register an event listener for one event only.
* @param name - The event name.
* @param fn - The callback function.
*/
once(name: "error", fn: (error: any) => void): void;
once(name: "error", fn: (error: any) => void): RedisConnection;

/**
* Waits until the connection is ready and returns the raw Node_Redis clients.
Expand All @@ -252,14 +252,14 @@ declare module "bottleneck" {
* @param name - The event name.
* @param fn - The callback function.
*/
on(name: "error", fn: (error: any) => void): void;
on(name: "error", fn: (error: any) => void): IORedisConnection;

/**
* Register an event listener for one event only.
* @param name - The event name.
* @param fn - The callback function.
*/
once(name: "error", fn: (error: any) => void): void;
once(name: "error", fn: (error: any) => void): IORedisConnection;

/**
* Waits until the connection is ready and returns the raw ioredis clients.
Expand All @@ -281,18 +281,18 @@ declare module "bottleneck" {
* @param name - The event name.
* @param fn - The callback function.
*/
on(name: string, fn: Function): void;
on(name: "error", fn: (error: any) => void): void;
on(name: "batch", fn: (batch: any[]) => void): void;
on(name: string, fn: Function): Batcher;
on(name: "error", fn: (error: any) => void): Batcher;
on(name: "batch", fn: (batch: any[]) => void): Batcher;

/**
* Register an event listener for one event only.
* @param name - The event name.
* @param fn - The callback function.
*/
once(name: string, fn: Function): void;
once(name: "error", fn: (error: any) => void): void;
once(name: "batch", fn: (batch: any[]) => void): void;
once(name: string, fn: Function): Batcher;
once(name: "error", fn: (error: any) => void): Batcher;
once(name: "batch", fn: (batch: any[]) => void): Batcher;

/**
* Add a request to the Batcher. Batches are flushed to the "batch" event.
Expand All @@ -318,18 +318,18 @@ declare module "bottleneck" {
* @param name - The event name.
* @param fn - The callback function.
*/
on(name: string, fn: Function): void;
on(name: "error", fn: (error: any) => void): void;
on(name: "created", fn: (limiter: Bottleneck, key: string) => void): void;
on(name: string, fn: Function): Group;
on(name: "error", fn: (error: any) => void): Group;
on(name: "created", fn: (limiter: Bottleneck, key: string) => void): Group;

/**
* Register an event listener for one event only.
* @param name - The event name.
* @param fn - The callback function.
*/
once(name: string, fn: Function): void;
once(name: "error", fn: (error: any) => void): void;
once(name: "created", fn: (limiter: Bottleneck, key: string) => void): void;
once(name: string, fn: Function): Group;
once(name: "error", fn: (error: any) => void): Group;
once(name: "created", fn: (limiter: Bottleneck, key: string) => void): Group;

/**
* Removes all registered event listeners.
Expand Down Expand Up @@ -495,40 +495,40 @@ class Bottleneck {
* @param name - The event name.
* @param fn - The callback function.
*/
on(name: "error", fn: (error: any) => void): void;
on(name: "empty", fn: () => void): void;
on(name: "idle", fn: () => void): void;
on(name: "depleted", fn: (empty: boolean) => void): void;
on(name: "message", fn: (message: string) => void): void;
on(name: "debug", fn: (message: string, info: any) => void): void;
on(name: "dropped", fn: (dropped: Bottleneck.EventInfoDropped) => void): void;
on(name: "received", fn: (info: Bottleneck.EventInfo) => void): void;
on(name: "queued", fn: (info: Bottleneck.EventInfoQueued) => void): void;
on(name: "scheduled", fn: (info: Bottleneck.EventInfo) => void): void;
on(name: "executing", fn: (info: Bottleneck.EventInfoRetryable) => void): void;
on(name: "failed", fn: (error: any, info: Bottleneck.EventInfoRetryable) => Promise<number | void | null> | number | void | null): void;
on(name: "retry", fn: (message: string, info: Bottleneck.EventInfoRetryable) => void): void;
on(name: "done", fn: (info: Bottleneck.EventInfoRetryable) => void): void;
on(name: "error", fn: (error: any) => void): Bottleneck;
on(name: "empty", fn: () => void): Bottleneck;
on(name: "idle", fn: () => void): Bottleneck;
on(name: "depleted", fn: (empty: boolean) => void): Bottleneck;
on(name: "message", fn: (message: string) => void): Bottleneck;
on(name: "debug", fn: (message: string, info: any) => void): Bottleneck;
on(name: "dropped", fn: (dropped: Bottleneck.EventInfoDropped) => void): Bottleneck;
on(name: "received", fn: (info: Bottleneck.EventInfo) => void): Bottleneck;
on(name: "queued", fn: (info: Bottleneck.EventInfoQueued) => void): Bottleneck;
on(name: "scheduled", fn: (info: Bottleneck.EventInfo) => void): Bottleneck;
on(name: "executing", fn: (info: Bottleneck.EventInfoRetryable) => void): Bottleneck;
on(name: "failed", fn: (error: any, info: Bottleneck.EventInfoRetryable) => Promise<number | void | null> | number | void | null): Bottleneck;
on(name: "retry", fn: (message: string, info: Bottleneck.EventInfoRetryable) => void): Bottleneck;
on(name: "done", fn: (info: Bottleneck.EventInfoRetryable) => void): Bottleneck;

/**
* Register an event listener for one event only.
* @param name - The event name.
* @param fn - The callback function.
*/
once(name: "error", fn: (error: any) => void): void;
once(name: "empty", fn: () => void): void;
once(name: "idle", fn: () => void): void;
once(name: "depleted", fn: (empty: boolean) => void): void;
once(name: "message", fn: (message: string) => void): void;
once(name: "debug", fn: (message: string, info: any) => void): void;
once(name: "dropped", fn: (dropped: Bottleneck.EventInfoDropped) => void): void;
once(name: "received", fn: (info: Bottleneck.EventInfo) => void): void;
once(name: "queued", fn: (info: Bottleneck.EventInfoQueued) => void): void;
once(name: "scheduled", fn: (info: Bottleneck.EventInfo) => void): void;
once(name: "executing", fn: (info: Bottleneck.EventInfoRetryable) => void): void;
once(name: "failed", fn: (error: any, info: Bottleneck.EventInfoRetryable) => Promise<number | void | null> | number | void | null): void;
once(name: "retry", fn: (message: string, info: Bottleneck.EventInfoRetryable) => void): void;
once(name: "done", fn: (info: Bottleneck.EventInfoRetryable) => void): void;
once(name: "error", fn: (error: any) => void): Bottleneck;
once(name: "empty", fn: () => void): Bottleneck;
once(name: "idle", fn: () => void): Bottleneck;
once(name: "depleted", fn: (empty: boolean) => void): Bottleneck;
once(name: "message", fn: (message: string) => void): Bottleneck;
once(name: "debug", fn: (message: string, info: any) => void): Bottleneck;
once(name: "dropped", fn: (dropped: Bottleneck.EventInfoDropped) => void): Bottleneck;
once(name: "received", fn: (info: Bottleneck.EventInfo) => void): Bottleneck;
once(name: "queued", fn: (info: Bottleneck.EventInfoQueued) => void): Bottleneck;
once(name: "scheduled", fn: (info: Bottleneck.EventInfo) => void): Bottleneck;
once(name: "executing", fn: (info: Bottleneck.EventInfoRetryable) => void): Bottleneck;
once(name: "failed", fn: (error: any, info: Bottleneck.EventInfoRetryable) => Promise<number | void | null> | number | void | null): Bottleneck;
once(name: "retry", fn: (message: string, info: Bottleneck.EventInfoRetryable) => void): Bottleneck;
once(name: "done", fn: (info: Bottleneck.EventInfoRetryable) => void): Bottleneck;

/**
* Removes all registered event listeners.
Expand Down
88 changes: 44 additions & 44 deletions bottleneck_types.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,14 +222,14 @@ namespace Bottleneck {
* @param name - The event name.
* @param fn - The callback function.
*/
on(name: "error", fn: (error: any) => void): void;
on(name: "error", fn: (error: any) => void): RedisConnection;

/**
* Register an event listener for one event only.
* @param name - The event name.
* @param fn - The callback function.
*/
once(name: "error", fn: (error: any) => void): void;
once(name: "error", fn: (error: any) => void): RedisConnection;

/**
* Waits until the connection is ready and returns the raw Node_Redis clients.
Expand All @@ -251,14 +251,14 @@ namespace Bottleneck {
* @param name - The event name.
* @param fn - The callback function.
*/
on(name: "error", fn: (error: any) => void): void;
on(name: "error", fn: (error: any) => void): IORedisConnection;

/**
* Register an event listener for one event only.
* @param name - The event name.
* @param fn - The callback function.
*/
once(name: "error", fn: (error: any) => void): void;
once(name: "error", fn: (error: any) => void): IORedisConnection;

/**
* Waits until the connection is ready and returns the raw ioredis clients.
Expand All @@ -280,18 +280,18 @@ namespace Bottleneck {
* @param name - The event name.
* @param fn - The callback function.
*/
on(name: string, fn: Function): void;
on(name: "error", fn: (error: any) => void): void;
on(name: "batch", fn: (batch: any[]) => void): void;
on(name: string, fn: Function): Batcher;
on(name: "error", fn: (error: any) => void): Batcher;
on(name: "batch", fn: (batch: any[]) => void): Batcher;

/**
* Register an event listener for one event only.
* @param name - The event name.
* @param fn - The callback function.
*/
once(name: string, fn: Function): void;
once(name: "error", fn: (error: any) => void): void;
once(name: "batch", fn: (batch: any[]) => void): void;
once(name: string, fn: Function): Batcher;
once(name: "error", fn: (error: any) => void): Batcher;
once(name: "batch", fn: (batch: any[]) => void): Batcher;

/**
* Add a request to the Batcher. Batches are flushed to the "batch" event.
Expand All @@ -317,18 +317,18 @@ namespace Bottleneck {
* @param name - The event name.
* @param fn - The callback function.
*/
on(name: string, fn: Function): void;
on(name: "error", fn: (error: any) => void): void;
on(name: "created", fn: (limiter: Bottleneck, key: string) => void): void;
on(name: string, fn: Function): Group;
on(name: "error", fn: (error: any) => void): Group;
on(name: "created", fn: (limiter: Bottleneck, key: string) => void): Group;

/**
* Register an event listener for one event only.
* @param name - The event name.
* @param fn - The callback function.
*/
once(name: string, fn: Function): void;
once(name: "error", fn: (error: any) => void): void;
once(name: "created", fn: (limiter: Bottleneck, key: string) => void): void;
once(name: string, fn: Function): Group;
once(name: "error", fn: (error: any) => void): Group;
once(name: "created", fn: (limiter: Bottleneck, key: string) => void): Group;

/**
* Removes all registered event listeners.
Expand Down Expand Up @@ -494,40 +494,40 @@ class Bottleneck {
* @param name - The event name.
* @param fn - The callback function.
*/
on(name: "error", fn: (error: any) => void): void;
on(name: "empty", fn: () => void): void;
on(name: "idle", fn: () => void): void;
on(name: "depleted", fn: (empty: boolean) => void): void;
on(name: "message", fn: (message: string) => void): void;
on(name: "debug", fn: (message: string, info: any) => void): void;
on(name: "dropped", fn: (dropped: Bottleneck.EventInfoDropped) => void): void;
on(name: "received", fn: (info: Bottleneck.EventInfo) => void): void;
on(name: "queued", fn: (info: Bottleneck.EventInfoQueued) => void): void;
on(name: "scheduled", fn: (info: Bottleneck.EventInfo) => void): void;
on(name: "executing", fn: (info: Bottleneck.EventInfoRetryable) => void): void;
on(name: "failed", fn: (error: any, info: Bottleneck.EventInfoRetryable) => Promise<number | void | null> | number | void | null): void;
on(name: "retry", fn: (message: string, info: Bottleneck.EventInfoRetryable) => void): void;
on(name: "done", fn: (info: Bottleneck.EventInfoRetryable) => void): void;
on(name: "error", fn: (error: any) => void): Bottleneck;
on(name: "empty", fn: () => void): Bottleneck;
on(name: "idle", fn: () => void): Bottleneck;
on(name: "depleted", fn: (empty: boolean) => void): Bottleneck;
on(name: "message", fn: (message: string) => void): Bottleneck;
on(name: "debug", fn: (message: string, info: any) => void): Bottleneck;
on(name: "dropped", fn: (dropped: Bottleneck.EventInfoDropped) => void): Bottleneck;
on(name: "received", fn: (info: Bottleneck.EventInfo) => void): Bottleneck;
on(name: "queued", fn: (info: Bottleneck.EventInfoQueued) => void): Bottleneck;
on(name: "scheduled", fn: (info: Bottleneck.EventInfo) => void): Bottleneck;
on(name: "executing", fn: (info: Bottleneck.EventInfoRetryable) => void): Bottleneck;
on(name: "failed", fn: (error: any, info: Bottleneck.EventInfoRetryable) => Promise<number | void | null> | number | void | null): Bottleneck;
on(name: "retry", fn: (message: string, info: Bottleneck.EventInfoRetryable) => void): Bottleneck;
on(name: "done", fn: (info: Bottleneck.EventInfoRetryable) => void): Bottleneck;

/**
* Register an event listener for one event only.
* @param name - The event name.
* @param fn - The callback function.
*/
once(name: "error", fn: (error: any) => void): void;
once(name: "empty", fn: () => void): void;
once(name: "idle", fn: () => void): void;
once(name: "depleted", fn: (empty: boolean) => void): void;
once(name: "message", fn: (message: string) => void): void;
once(name: "debug", fn: (message: string, info: any) => void): void;
once(name: "dropped", fn: (dropped: Bottleneck.EventInfoDropped) => void): void;
once(name: "received", fn: (info: Bottleneck.EventInfo) => void): void;
once(name: "queued", fn: (info: Bottleneck.EventInfoQueued) => void): void;
once(name: "scheduled", fn: (info: Bottleneck.EventInfo) => void): void;
once(name: "executing", fn: (info: Bottleneck.EventInfoRetryable) => void): void;
once(name: "failed", fn: (error: any, info: Bottleneck.EventInfoRetryable) => Promise<number | void | null> | number | void | null): void;
once(name: "retry", fn: (message: string, info: Bottleneck.EventInfoRetryable) => void): void;
once(name: "done", fn: (info: Bottleneck.EventInfoRetryable) => void): void;
once(name: "error", fn: (error: any) => void): Bottleneck;
once(name: "empty", fn: () => void): Bottleneck;
once(name: "idle", fn: () => void): Bottleneck;
once(name: "depleted", fn: (empty: boolean) => void): Bottleneck;
once(name: "message", fn: (message: string) => void): Bottleneck;
once(name: "debug", fn: (message: string, info: any) => void): Bottleneck;
once(name: "dropped", fn: (dropped: Bottleneck.EventInfoDropped) => void): Bottleneck;
once(name: "received", fn: (info: Bottleneck.EventInfo) => void): Bottleneck;
once(name: "queued", fn: (info: Bottleneck.EventInfoQueued) => void): Bottleneck;
once(name: "scheduled", fn: (info: Bottleneck.EventInfo) => void): Bottleneck;
once(name: "executing", fn: (info: Bottleneck.EventInfoRetryable) => void): Bottleneck;
once(name: "failed", fn: (error: any, info: Bottleneck.EventInfoRetryable) => Promise<number | void | null> | number | void | null): Bottleneck;
once(name: "retry", fn: (message: string, info: Bottleneck.EventInfoRetryable) => void): Bottleneck;
once(name: "done", fn: (info: Bottleneck.EventInfoRetryable) => void): Bottleneck;

/**
* Removes all registered event listeners.
Expand Down