Skip to content

Commit fce9aa1

Browse files
sundbrysundbry
authoredMar 28, 2022
fix: Now compatible with TypeScript 4.6 type checks (#6895)
* fix(typescript): type check failures in typescript 4.6 * fix(timers): TimerHandle type to resolve node/browser timer handle types setInterval/setTimeout/setImmediate have different return types in node.js and the browser. Define TimerHandle to abstract the difference and fix compilation errors where the return type was a number. * Use `export type` for re-exporting type definitions Fixes compilation under typescript with `isolatedModules: true` See https://devblogs.microsoft.com/typescript/announcing-typescript-3-8/#type-only-imports-exports
·
8.0.0-alpha.147.5.6
1 parent 708c0a7 commit fce9aa1

16 files changed

+65
-41
lines changed
 

‎spec/ajax/index-spec.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ describe('index', () => {
77
});
88

99
it('should export Ajax data classes', () => {
10-
expect(index.AjaxResponse).to.exist;
1110
expect(index.AjaxError).to.exist;
1211
expect(index.AjaxTimeoutError).to.exist;
1312
// Interfaces can be checked by creating a variable of that type
1413
let ajaxRequest: index.AjaxRequest;
14+
let ajaxResponse: index.AjaxResponse<object>;
1515
});
1616
});

‎src/ajax/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
export { ajax } from '../internal/ajax/ajax';
22
export { AjaxError, AjaxTimeoutError } from '../internal/ajax/errors';
33
export { AjaxResponse } from '../internal/ajax/AjaxResponse';
4-
export { AjaxRequest, AjaxConfig, AjaxDirection } from '../internal/ajax/types';
4+
export type { AjaxRequest, AjaxConfig, AjaxDirection } from '../internal/ajax/types';

‎src/index.ts

+18-10
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
/* Observable */
1616
export { Observable } from './internal/Observable';
1717
export { ConnectableObservable } from './internal/observable/ConnectableObservable';
18-
export { GroupedObservable } from './internal/operators/groupBy';
19-
export { Operator } from './internal/Operator';
18+
export type { GroupedObservable } from './internal/operators/groupBy';
19+
export type { Operator } from './internal/Operator';
2020
export { observable } from './internal/symbol/observable';
2121
export { animationFrames } from './internal/observable/dom/animationFrames';
2222

@@ -97,7 +97,8 @@ export { NEVER } from './internal/observable/never';
9797
export * from './internal/types';
9898

9999
/* Config */
100-
export { config, GlobalConfig } from './internal/config';
100+
export { config } from './internal/config';
101+
export type { GlobalConfig } from './internal/config';
101102

102103
/* Operators */
103104
export { audit } from './internal/operators/audit';
@@ -115,7 +116,8 @@ export { concatAll } from './internal/operators/concatAll';
115116
export { concatMap } from './internal/operators/concatMap';
116117
export { concatMapTo } from './internal/operators/concatMapTo';
117118
export { concatWith } from './internal/operators/concatWith';
118-
export { connect, ConnectConfig } from './internal/operators/connect';
119+
export { connect } from './internal/operators/connect';
120+
export type { ConnectConfig } from './internal/operators/connect';
119121
export { count } from './internal/operators/count';
120122
export { debounce } from './internal/operators/debounce';
121123
export { debounceTime } from './internal/operators/debounceTime';
@@ -138,7 +140,8 @@ export { finalize } from './internal/operators/finalize';
138140
export { find } from './internal/operators/find';
139141
export { findIndex } from './internal/operators/findIndex';
140142
export { first } from './internal/operators/first';
141-
export { groupBy, BasicGroupByOptions, GroupByOptionsWithElement } from './internal/operators/groupBy';
143+
export { groupBy } from './internal/operators/groupBy';
144+
export type { BasicGroupByOptions, GroupByOptionsWithElement } from './internal/operators/groupBy';
142145
export { ignoreElements } from './internal/operators/ignoreElements';
143146
export { isEmpty } from './internal/operators/isEmpty';
144147
export { last } from './internal/operators/last';
@@ -165,15 +168,18 @@ export { raceWith } from './internal/operators/raceWith';
165168
export { reduce } from './internal/operators/reduce';
166169
export { repeat } from './internal/operators/repeat';
167170
export { repeatWhen } from './internal/operators/repeatWhen';
168-
export { retry, RetryConfig } from './internal/operators/retry';
171+
export { retry } from './internal/operators/retry';
172+
export type { RetryConfig } from './internal/operators/retry';
169173
export { retryWhen } from './internal/operators/retryWhen';
170174
export { refCount } from './internal/operators/refCount';
171175
export { sample } from './internal/operators/sample';
172176
export { sampleTime } from './internal/operators/sampleTime';
173177
export { scan } from './internal/operators/scan';
174178
export { sequenceEqual } from './internal/operators/sequenceEqual';
175-
export { share, ShareConfig } from './internal/operators/share';
176-
export { shareReplay, ShareReplayConfig } from './internal/operators/shareReplay';
179+
export { share } from './internal/operators/share';
180+
export type { ShareConfig } from './internal/operators/share';
181+
export { shareReplay } from './internal/operators/shareReplay';
182+
export type { ShareReplayConfig } from './internal/operators/shareReplay';
177183
export { single } from './internal/operators/single';
178184
export { skip } from './internal/operators/skip';
179185
export { skipLast } from './internal/operators/skipLast';
@@ -190,11 +196,13 @@ export { takeLast } from './internal/operators/takeLast';
190196
export { takeUntil } from './internal/operators/takeUntil';
191197
export { takeWhile } from './internal/operators/takeWhile';
192198
export { tap } from './internal/operators/tap';
193-
export { throttle, ThrottleConfig } from './internal/operators/throttle';
199+
export { throttle } from './internal/operators/throttle';
200+
export type { ThrottleConfig } from './internal/operators/throttle';
194201
export { throttleTime } from './internal/operators/throttleTime';
195202
export { throwIfEmpty } from './internal/operators/throwIfEmpty';
196203
export { timeInterval } from './internal/operators/timeInterval';
197-
export { timeout, TimeoutConfig, TimeoutInfo } from './internal/operators/timeout';
204+
export { timeout } from './internal/operators/timeout';
205+
export type { TimeoutConfig, TimeoutInfo } from './internal/operators/timeout';
198206
export { timeoutWith } from './internal/operators/timeoutWith';
199207
export { timestamp } from './internal/operators/timestamp';
200208
export { toArray } from './internal/operators/toArray';

‎src/internal/Subscriber.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ export class SafeSubscriber<T> extends Subscriber<T> {
203203
// The first argument is a function, not an observer. The next
204204
// two arguments *could* be observers, or they could be empty.
205205
partialObserver = {
206-
next: observerOrNext ?? undefined,
206+
next: (observerOrNext ?? undefined) as (((value: T) => void) | undefined),
207207
error: error ?? undefined,
208208
complete: complete ?? undefined,
209209
};

‎src/internal/operators/groupBy.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ export function groupBy<T, K, R>(
147147
return operate((source, subscriber) => {
148148
let element: ((value: any) => any) | void;
149149
if (!elementOrOptions || typeof elementOrOptions === 'function') {
150-
element = elementOrOptions;
150+
element = elementOrOptions as ((value: any) => any);
151151
} else {
152152
({ duration, element, connector } = elementOrOptions);
153153
}

‎src/internal/operators/retry.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ export function retry<T>(configOrCount: number | RetryConfig = Infinity): MonoTy
8686
config = configOrCount;
8787
} else {
8888
config = {
89-
count: configOrCount,
89+
count: configOrCount as number,
9090
};
9191
}
9292
const { count = Infinity, delay, resetOnSuccess: resetOnSuccess = false } = config;

‎src/internal/operators/shareReplay.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ export function shareReplay<T>(
161161
if (configOrBufferSize && typeof configOrBufferSize === 'object') {
162162
({ bufferSize = Infinity, windowTime = Infinity, refCount = false, scheduler } = configOrBufferSize);
163163
} else {
164-
bufferSize = configOrBufferSize ?? Infinity;
164+
bufferSize = (configOrBufferSize ?? Infinity) as number;
165165
}
166166
return share<T>({
167167
connector: () => new ReplaySubject(bufferSize, windowTime, scheduler),

‎src/internal/scheduler/immediateProvider.ts

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
import { Immediate } from '../util/Immediate';
2+
import type { TimerHandle } from './timerHandle';
23
const { setImmediate, clearImmediate } = Immediate;
34

4-
type SetImmediateFunction = (handler: () => void, ...args: any[]) => number;
5-
type ClearImmediateFunction = (handle: number) => void;
5+
type SetImmediateFunction = (handler: () => void, ...args: any[]) => TimerHandle;
6+
type ClearImmediateFunction = (handle: TimerHandle) => void;
67

78
interface ImmediateProvider {
89
setImmediate: SetImmediateFunction;
@@ -24,7 +25,7 @@ export const immediateProvider: ImmediateProvider = {
2425
},
2526
clearImmediate(handle) {
2627
const { delegate } = immediateProvider;
27-
return (delegate?.clearImmediate || clearImmediate)(handle);
28+
return (delegate?.clearImmediate || clearImmediate)(handle as any);
2829
},
2930
delegate: undefined,
3031
};

‎src/internal/scheduler/intervalProvider.ts

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
type SetIntervalFunction = (handler: () => void, timeout?: number, ...args: any[]) => number;
2-
type ClearIntervalFunction = (handle: number) => void;
1+
import type { TimerHandle } from './timerHandle';
2+
type SetIntervalFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;
3+
type ClearIntervalFunction = (handle: TimerHandle) => void;
34

45
interface IntervalProvider {
56
setInterval: SetIntervalFunction;
@@ -16,15 +17,15 @@ export const intervalProvider: IntervalProvider = {
1617
// When accessing the delegate, use the variable rather than `this` so that
1718
// the functions can be called without being bound to the provider.
1819
setInterval(handler: () => void, timeout?: number, ...args) {
19-
const {delegate} = intervalProvider;
20+
const { delegate } = intervalProvider;
2021
if (delegate?.setInterval) {
2122
return delegate.setInterval(handler, timeout, ...args);
2223
}
2324
return setInterval(handler, timeout, ...args);
2425
},
2526
clearInterval(handle) {
2627
const { delegate } = intervalProvider;
27-
return (delegate?.clearInterval || clearInterval)(handle);
28+
return (delegate?.clearInterval || clearInterval)(handle as any);
2829
},
2930
delegate: undefined,
3031
};

‎src/internal/scheduler/timeoutProvider.ts

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
type SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => number;
2-
type ClearTimeoutFunction = (handle: number) => void;
1+
import type { TimerHandle } from './timerHandle';
2+
type SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;
3+
type ClearTimeoutFunction = (handle: TimerHandle) => void;
34

45
interface TimeoutProvider {
56
setTimeout: SetTimeoutFunction;
@@ -16,15 +17,15 @@ export const timeoutProvider: TimeoutProvider = {
1617
// When accessing the delegate, use the variable rather than `this` so that
1718
// the functions can be called without being bound to the provider.
1819
setTimeout(handler: () => void, timeout?: number, ...args) {
19-
const {delegate} = timeoutProvider;
20+
const { delegate } = timeoutProvider;
2021
if (delegate?.setTimeout) {
2122
return delegate.setTimeout(handler, timeout, ...args);
2223
}
2324
return setTimeout(handler, timeout, ...args);
2425
},
2526
clearTimeout(handle) {
2627
const { delegate } = timeoutProvider;
27-
return (delegate?.clearTimeout || clearTimeout)(handle);
28+
return (delegate?.clearTimeout || clearTimeout)(handle as any);
2829
},
2930
delegate: undefined,
3031
};

‎src/internal/scheduler/timerHandle.ts

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export type TimerHandle = number | NodeJS.Timeout;

‎src/internal/testing/TestScheduler.ts

+6-5
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import { COMPLETE_NOTIFICATION, errorNotification, nextNotification } from '../N
1010
import { dateTimestampProvider } from '../scheduler/dateTimestampProvider';
1111
import { performanceTimestampProvider } from '../scheduler/performanceTimestampProvider';
1212
import { animationFrameProvider } from '../scheduler/animationFrameProvider';
13+
import type { TimerHandle } from '../scheduler/timerHandle';
1314
import { immediateProvider } from '../scheduler/immediateProvider';
1415
import { intervalProvider } from '../scheduler/intervalProvider';
1516
import { timeoutProvider } from '../scheduler/timeoutProvider';
@@ -510,11 +511,11 @@ export class TestScheduler extends VirtualTimeScheduler {
510511

511512
let lastHandle = 0;
512513
const scheduleLookup = new Map<
513-
number,
514+
TimerHandle,
514515
{
515516
due: number;
516517
duration: number;
517-
handle: number;
518+
handle: TimerHandle;
518519
handler: () => void;
519520
subscription: Subscription;
520521
type: 'immediate' | 'interval' | 'timeout';
@@ -582,7 +583,7 @@ export class TestScheduler extends VirtualTimeScheduler {
582583
});
583584
return handle;
584585
},
585-
clearImmediate: (handle: number) => {
586+
clearImmediate: (handle: TimerHandle) => {
586587
const value = scheduleLookup.get(handle);
587588
if (value) {
588589
value.subscription.unsubscribe();
@@ -604,7 +605,7 @@ export class TestScheduler extends VirtualTimeScheduler {
604605
});
605606
return handle;
606607
},
607-
clearInterval: (handle: number) => {
608+
clearInterval: (handle: TimerHandle) => {
608609
const value = scheduleLookup.get(handle);
609610
if (value) {
610611
value.subscription.unsubscribe();
@@ -626,7 +627,7 @@ export class TestScheduler extends VirtualTimeScheduler {
626627
});
627628
return handle;
628629
},
629-
clearTimeout: (handle: number) => {
630+
clearTimeout: (handle: TimerHandle) => {
630631
const value = scheduleLookup.get(handle);
631632
if (value) {
632633
value.subscription.unsubscribe();

‎src/internal/util/workarounds.ts

+2
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@
33
// Wherever possible, use a TypeScript issue number in the type - something
44
// like TS_18757 - or use a descriptive name and leave a detailed comment
55
// alongside the type alias.
6+
7+
export {}

‎src/operators/index.ts

+14-7
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ export { concatAll } from '../internal/operators/concatAll';
1616
export { concatMap } from '../internal/operators/concatMap';
1717
export { concatMapTo } from '../internal/operators/concatMapTo';
1818
export { concatWith } from '../internal/operators/concatWith';
19-
export { connect, ConnectConfig } from '../internal/operators/connect';
19+
export { connect } from '../internal/operators/connect';
20+
export type { ConnectConfig } from '../internal/operators/connect';
2021
export { count } from '../internal/operators/count';
2122
export { debounce } from '../internal/operators/debounce';
2223
export { debounceTime } from '../internal/operators/debounceTime';
@@ -39,7 +40,8 @@ export { finalize } from '../internal/operators/finalize';
3940
export { find } from '../internal/operators/find';
4041
export { findIndex } from '../internal/operators/findIndex';
4142
export { first } from '../internal/operators/first';
42-
export { groupBy, BasicGroupByOptions, GroupByOptionsWithElement } from '../internal/operators/groupBy';
43+
export { groupBy } from '../internal/operators/groupBy';
44+
export type { BasicGroupByOptions, GroupByOptionsWithElement } from '../internal/operators/groupBy';
4345
export { ignoreElements } from '../internal/operators/ignoreElements';
4446
export { isEmpty } from '../internal/operators/isEmpty';
4547
export { last } from '../internal/operators/last';
@@ -70,15 +72,18 @@ export { raceWith } from '../internal/operators/raceWith';
7072
export { reduce } from '../internal/operators/reduce';
7173
export { repeat } from '../internal/operators/repeat';
7274
export { repeatWhen } from '../internal/operators/repeatWhen';
73-
export { retry, RetryConfig } from '../internal/operators/retry';
75+
export { retry } from '../internal/operators/retry';
76+
export type { RetryConfig } from '../internal/operators/retry';
7477
export { retryWhen } from '../internal/operators/retryWhen';
7578
export { refCount } from '../internal/operators/refCount';
7679
export { sample } from '../internal/operators/sample';
7780
export { sampleTime } from '../internal/operators/sampleTime';
7881
export { scan } from '../internal/operators/scan';
7982
export { sequenceEqual } from '../internal/operators/sequenceEqual';
80-
export { share, ShareConfig } from '../internal/operators/share';
81-
export { shareReplay, ShareReplayConfig } from '../internal/operators/shareReplay';
83+
export { share } from '../internal/operators/share';
84+
export type { ShareConfig } from '../internal/operators/share';
85+
export { shareReplay } from '../internal/operators/shareReplay';
86+
export type { ShareReplayConfig } from '../internal/operators/shareReplay';
8287
export { single } from '../internal/operators/single';
8388
export { skip } from '../internal/operators/skip';
8489
export { skipLast } from '../internal/operators/skipLast';
@@ -95,11 +100,13 @@ export { takeLast } from '../internal/operators/takeLast';
95100
export { takeUntil } from '../internal/operators/takeUntil';
96101
export { takeWhile } from '../internal/operators/takeWhile';
97102
export { tap } from '../internal/operators/tap';
98-
export { throttle, ThrottleConfig } from '../internal/operators/throttle';
103+
export { throttle } from '../internal/operators/throttle';
104+
export type { ThrottleConfig } from '../internal/operators/throttle';
99105
export { throttleTime } from '../internal/operators/throttleTime';
100106
export { throwIfEmpty } from '../internal/operators/throwIfEmpty';
101107
export { timeInterval } from '../internal/operators/timeInterval';
102-
export { timeout, TimeoutConfig, TimeoutInfo } from '../internal/operators/timeout';
108+
export { timeout } from '../internal/operators/timeout';
109+
export type { TimeoutConfig, TimeoutInfo } from '../internal/operators/timeout';
103110
export { timeoutWith } from '../internal/operators/timeoutWith';
104111
export { timestamp } from '../internal/operators/timestamp';
105112
export { toArray } from '../internal/operators/toArray';

‎src/testing/index.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
export { TestScheduler, RunHelpers } from '../internal/testing/TestScheduler';
1+
export { TestScheduler } from '../internal/testing/TestScheduler';
2+
export type { RunHelpers } from '../internal/testing/TestScheduler';

‎src/webSocket/index.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
export { webSocket as webSocket } from '../internal/observable/dom/webSocket';
2-
export { WebSocketSubject, WebSocketSubjectConfig } from '../internal/observable/dom/WebSocketSubject';
2+
export { WebSocketSubject } from '../internal/observable/dom/WebSocketSubject';
3+
export type { WebSocketSubjectConfig } from '../internal/observable/dom/WebSocketSubject';

0 commit comments

Comments
 (0)
Please sign in to comment.