debounce() and throttle()’s selector argument has wrong return type

[mernen]

Here’s the current signature for debounce():

rxjs/src/operators/debounce.ts

Line 53 in c1721e3

export function debounce<T>(durationSelector: (value: T) => SubscribableOrPromise<number>): MonoTypeOperatorFunction<T> {

One thing that confused me is that it asks for your function to return a SubscribableOrPromise<number>. The documentation compounded my confusion ("A function (…) for computing the timeout duration for each source value”): is my selector supposed to return the number of milliseconds? Turns out the result of that observable/promise is completely discarded.

RxJS version: 5.5.6 (and, looking at the code, the next branch, too)

Additional information: throttle() has the same issue. Interestingly, audit() is correctly using SubscribableOrPromise<any>:

rxjs/src/operators/audit.ts

Line 52 in c1721e3

export function audit<T>(durationSelector: (value: T) => SubscribableOrPromise<any>): MonoTypeOperatorFunction<T> {

[cartant]

Regarding debounce, see #3164 and #3169. I will have a look at the throttle typings

[mernen]

Ah, that’s nice! Sorry, it completely forgot to search for past reports. My bad.

[cartant]

No worries; you're right. throttle also uses number instead of any. I'll create another PR.

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.