Skip to content

Commit e5a85e7

Browse files
committed
Added overload to ReadonlyArray.prototype.every to make it a type guard if the callback is one.
Fixes microsoft#14963
1 parent eb80799 commit e5a85e7

File tree

4 files changed

+54
-0
lines changed

4 files changed

+54
-0
lines changed

src/lib/es5.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1014,6 +1014,7 @@ interface ReadonlyArray<T> {
10141014
* @param callbackfn A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
10151015
* @param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
10161016
*/
1017+
every<U extends T>(callbackfn: (value: T, index: number, array: ReadonlyArray<T>) => value is U, thisArg?: any): this is ReadonlyArray<U>;
10171018
every(callbackfn: (value: T, index: number, array: ReadonlyArray<T>) => boolean, thisArg?: any): boolean;
10181019
/**
10191020
* Determines whether the specified callback function returns true for any element of an array.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
tests/cases/compiler/arrayEvery.ts(8,9): error TS2322: Type 'ReadonlyArray<string | number>' is not assignable to type 'ReadonlyArray<number>'.
2+
Type 'string | number' is not assignable to type 'number'.
3+
Type 'string' is not assignable to type 'number'.
4+
5+
6+
==== tests/cases/compiler/arrayEvery.ts (1 errors) ====
7+
declare const baseReadonlyArray: ReadonlyArray<number | string>;
8+
9+
if (baseReadonlyArray.every<number>((x): x is number => "number" === typeof x)) {
10+
const numberReadonlyArray: ReadonlyArray<number> = baseReadonlyArray; // should be ReadonlyArray<number>
11+
}
12+
13+
if (baseReadonlyArray.every((x): x is number => "number" === typeof x)) {
14+
const numberReadonlyArray: ReadonlyArray<number> = baseReadonlyArray; // should be ReadonlyArray<number>
15+
~~~~~~~~~~~~~~~~~~~
16+
!!! error TS2322: Type 'ReadonlyArray<string | number>' is not assignable to type 'ReadonlyArray<number>'.
17+
!!! error TS2322: Type 'string | number' is not assignable to type 'number'.
18+
!!! error TS2322: Type 'string' is not assignable to type 'number'.
19+
}
20+
21+
baseReadonlyArray.every(x => "number" === typeof x && x > 2);
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
//// [arrayEvery.ts]
2+
declare const baseReadonlyArray: ReadonlyArray<number | string>;
3+
4+
if (baseReadonlyArray.every<number>((x): x is number => "number" === typeof x)) {
5+
const numberReadonlyArray: ReadonlyArray<number> = baseReadonlyArray; // should be ReadonlyArray<number>
6+
}
7+
8+
if (baseReadonlyArray.every((x): x is number => "number" === typeof x)) {
9+
const numberReadonlyArray: ReadonlyArray<number> = baseReadonlyArray; // should be ReadonlyArray<number>
10+
}
11+
12+
baseReadonlyArray.every(x => "number" === typeof x && x > 2);
13+
14+
//// [arrayEvery.js]
15+
if (baseReadonlyArray.every(function (x) { return "number" === typeof x; })) {
16+
var numberReadonlyArray = baseReadonlyArray; // should be ReadonlyArray<number>
17+
}
18+
if (baseReadonlyArray.every(function (x) { return "number" === typeof x; })) {
19+
var numberReadonlyArray = baseReadonlyArray; // should be ReadonlyArray<number>
20+
}
21+
baseReadonlyArray.every(function (x) { return "number" === typeof x && x > 2; });

tests/cases/compiler/arrayEvery.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
declare const baseReadonlyArray: ReadonlyArray<number | string>;
2+
3+
if (baseReadonlyArray.every<number>((x): x is number => "number" === typeof x)) {
4+
const numberReadonlyArray: ReadonlyArray<number> = baseReadonlyArray; // should be ReadonlyArray<number>
5+
}
6+
7+
if (baseReadonlyArray.every((x): x is number => "number" === typeof x)) {
8+
const numberReadonlyArray: ReadonlyArray<number> = baseReadonlyArray; // should be ReadonlyArray<number>
9+
}
10+
11+
baseReadonlyArray.every(x => "number" === typeof x && x > 2);

0 commit comments

Comments
 (0)