Skip to content

Update iterator types to align with microsoft/TypeScript#59506 #70221

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

Merged
typescript-bot merged 2 commits into from
Aug 7, 2024
Merged

Update iterator types to align with microsoft/TypeScript#59506 #70221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0dabbe5
Update to match microsoft/TypeScript#59506
rbuckton Aug 5, 2024
db11601
Fix typo in es-get-iterator-tests.ts
rbuckton Aug 7, 2024
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
6 changes: 3 additions & 3 deletions types/call-bind/test/callBound.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import callBound = require("call-bind/callBound");

callBound("%ArrayProto_keys%"); // $ExpectType (thisArg: unknown) => IterableIterator<number> || (thisArg: unknown) => BuiltinIterator<number, any, any>
callBound("%ArrayProto_values%"); // $ExpectType (thisArg: unknown) => IterableIterator<any> || (thisArg: unknown) => BuiltinIterator<any, any, any>
callBound("%ArrayProto_entries%"); // $ExpectType (thisArg: unknown) => IterableIterator<[number, any]> || (thisArg: unknown) => BuiltinIterator<[number, any], any, any>
callBound("%ArrayProto_keys%"); // $ExpectType (thisArg: unknown) => IterableIterator<number> || (thisArg: unknown) => ArrayIterator<number>
callBound("%ArrayProto_values%"); // $ExpectType (thisArg: unknown) => IterableIterator<any> || (thisArg: unknown) => ArrayIterator<any>
callBound("%ArrayProto_entries%"); // $ExpectType (thisArg: unknown) => IterableIterator<[number, any]> || (thisArg: unknown) => ArrayIterator<[number, any]>
callBound("%ArrayProto_forEach%"); // $ExpectType (thisArg: unknown, callbackfn: (value: any, index: number, array: any[]) => void, thisArg?: any) => void

callBound("%ObjProto_toString%"); // $ExpectType (thisArg: unknown) => string
Expand Down
2 changes: 1 addition & 1 deletion types/es-abstract/test/es2015.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ ES2015.Call<bigint, readonly [], string>(Object.prototype.toString, BigInt(Numbe
ES2015.Call(Object.prototype.hasOwnProperty, [], ["length"] as const); // $ExpectType boolean
ES2015.Call(Object.prototype.hasOwnProperty, any, args as IArguments & [PropertyKey]); // $ExpectType boolean

// $ExpectType IterableIterator<number> || BuiltinIterator<number, any, any>
// $ExpectType IterableIterator<number> || ArrayIterator<number>
ES2015.GetIterator([1, 2, 3]);

function* generable() {
Expand Down
6 changes: 3 additions & 3 deletions types/es-abstract/test/helpers/callBound.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import callBound = require("es-abstract/helpers/callBound");

callBound("%ArrayProto_keys%"); // $ExpectType (thisArg: unknown) => IterableIterator<number> || (thisArg: unknown) => BuiltinIterator<number, any, any>
callBound("%ArrayProto_values%"); // $ExpectType (thisArg: unknown) => IterableIterator<any> || (thisArg: unknown) => BuiltinIterator<any, any, any>
callBound("%ArrayProto_entries%"); // $ExpectType (thisArg: unknown) => IterableIterator<[number, any]> || (thisArg: unknown) => BuiltinIterator<[number, any], any, any>
callBound("%ArrayProto_keys%"); // $ExpectType (thisArg: unknown) => IterableIterator<number> || (thisArg: unknown) => ArrayIterator<number>
callBound("%ArrayProto_values%"); // $ExpectType (thisArg: unknown) => IterableIterator<any> || (thisArg: unknown) => ArrayIterator<any>
callBound("%ArrayProto_entries%"); // $ExpectType (thisArg: unknown) => IterableIterator<[number, any]> || (thisArg: unknown) => ArrayIterator<[number, any]>
callBound("%ArrayProto_forEach%"); // $ExpectType (thisArg: unknown, callbackfn: (value: any, index: number, array: any[]) => void, thisArg?: any) => void

callBound("%ObjProto_toString%"); // $ExpectType (thisArg: unknown) => string
Expand Down
18 changes: 9 additions & 9 deletions types/es-get-iterator/es-get-iterator-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
import getIterator = require("es-get-iterator");

// $ExpectType Iterator<string, any, undefined> || Iterator<string, any, any>
// $ExpectType Iterator<string, any, undefined> || Iterator<string, any, unknown>
getIterator("foo");

// $ExpectType Iterator<never, any, undefined> || Iterator<never, any, any>
// $ExpectType Iterator<never, any, undefined> || Iterator<never, any, unknown>
getIterator([]);

// $ExpectType Iterator<number, any, undefined> || Iterator<number, any, any>
// $ExpectType Iterator<number, any, undefined> || Iterator<number, any, unknown>
getIterator([0, 1, 2, 3, 4]);

// $ExpectType Iterator<string | number | boolean | undefined, any, undefined> || Iterator<string | number | boolean | undefined, any, any>
// $ExpectType Iterator<string | number | boolean | undefined, any, undefined> || Iterator<string | number | boolean | undefined, any, unknown>
getIterator([undefined, true, "bar", 0]);

// $ExpectType Iterator<[symbol, unknown], any, undefined> || Iterator<[symbol, unknown], any, any>
// $ExpectType Iterator<[symbol, unknown], any, undefined> || Iterator<[symbol, unknown], any, unknown>
getIterator(new Map<symbol, unknown>());

// $ExpectType Iterator<boolean, any, undefined> || Iterator<boolean, any, any>
// $ExpectType Iterator<boolean, any, undefined> || Iterator<boolean, any, unknown>
getIterator(new Set<boolean>());

// $ExpectType Iterator<"foo" | "bar", void, unknown> || Iterator<"foo" | "bar", void, any>
Expand All @@ -32,15 +32,15 @@ getIterator((function*() {
})());

declare const ARGUMENTS: IArguments;
// $ExpectType Iterator<any, any, undefined> || Iterator<any, any, any>
// $ExpectType Iterator<any, any, undefined> || Iterator<any, any, unknown>
getIterator(ARGUMENTS);

declare const ITERABLE_UNION: number[] | Set<Date>;
// $ExpectType Iterator<number, any, undefined> | Iterator<Date, any, undefined> || Iterator<number, any, any> | Iterator<Date, any, any>
// $ExpectType Iterator<number, any, undefined> | Iterator<Date, any, undefined> || Iterator<number, any, unknown> | Iterator<Date, any, unknown>
getIterator(ITERABLE_UNION);

declare const ITERABLE_OR_OTHERS_UNION: Map<Error, DataView> | ArrayBuffer;
// $ExpectType Iterator<[Error, DataView], any, undefined> | undefined || Iterator<[Error, DataView], any, any> | undefined
// $ExpectType Iterator<[Error, DataView], any, undefined> | undefined || Iterator<[Error, DataView], any, unknown> | undefined
getIterator(ITERABLE_OR_OTHERS_UNION);

declare const UNKNOWN: unknown;
Expand Down
10 changes: 5 additions & 5 deletions types/lodash/lodash-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5514,9 +5514,9 @@ fp.now(); // $ExpectType number
_.chain(objectWithOptionalField).get("a", defaultValue); // $ExpectType PrimitiveChain<false> | PrimitiveChain<true>
_.chain({}).get("a", defaultValue); // $ExpectType PrimitiveChain<false> | PrimitiveChain<true>

fp.get(Symbol.iterator, []); // $ExpectType any || () => IterableIterator<never> || () => BuiltinIterator<never, any, any>
fp.get(Symbol.iterator)([]); // $ExpectType any || () => IterableIterator<never> || () => BuiltinIterator<never>
fp.get([Symbol.iterator], []); // $ExpectType any || () => IterableIterator<never> || () => BuiltinIterator<never, any, any>
fp.get(Symbol.iterator, []); // $ExpectType any || () => IterableIterator<never> || () => ArrayIterator<never>
fp.get(Symbol.iterator)([]); // $ExpectType any || () => IterableIterator<never> || () => ArrayIterator<never>
fp.get([Symbol.iterator], []); // $ExpectType any || () => IterableIterator<never> || () => ArrayIterator<never>
fp.get(1)("abc"); // $ExpectType string
fp.get("1")("abc"); // $ExpectType any
fp.get("a", { a: { b: true } }); // $ExpectType { b: boolean; }
Expand Down Expand Up @@ -7289,7 +7289,7 @@ fp.now(); // $ExpectType number
_.chain("a.b[0]").property<SampleObject, number>(); // $ExpectType FunctionChain<(obj: SampleObject) => number>
_.chain(["a", "b", 0]).property<SampleObject, number>(); // $ExpectType FunctionChain<(obj: SampleObject) => number>
fp.property(Symbol.iterator)([]); // $ExpectType any
fp.property([Symbol.iterator], []); // $ExpectType any || () => IterableIterator<never> || () => BuiltinIterator<never, any, any>
fp.property([Symbol.iterator], []); // $ExpectType any || () => IterableIterator<never> || () => ArrayIterator<never>
fp.property(1)("abc"); // $ExpectType string
}

Expand All @@ -7300,7 +7300,7 @@ fp.now(); // $ExpectType number
_.chain({}).propertyOf() as _.LoDashExplicitWrapper<(path: _.Many<_.PropertyName>) => any>;

fp.propertyOf(Symbol.iterator)([]); // $ExpectType any
fp.propertyOf([Symbol.iterator], []); // $ExpectType any || () => IterableIterator<never> || () => BuiltinIterator<never, any, any>
fp.propertyOf([Symbol.iterator], []); // $ExpectType any || () => IterableIterator<never> || () => ArrayIterator<never>
fp.propertyOf(1)("abc"); // $ExpectType string
}

Expand Down
2 changes: 1 addition & 1 deletion types/regenerator-runtime/regenerator-runtime-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ declare const anyIterable: Iterable<object>;
declare const anyIterableIterator: IterableIterator<object>;
declare const anyGenerator: Generator<object, object, object>;

regenerator.values(anyArray); // $ExpectType IterableIterator<object> || BuiltinIterator<object, any, any>
regenerator.values(anyArray); // $ExpectType IterableIterator<object> || ArrayIterator<object>
expectType<Iterator<object>>(regenerator.values(anyIterable));
regenerator.values(anyIterableIterator); // $ExpectType IterableIterator<object>
regenerator.values(anyGenerator); // $ExpectType Generator<object, object, object>
Expand Down
4 changes: 2 additions & 2 deletions types/string.prototype.matchall/string.prototype.matchall-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ matchAll(str, nonRegexStr); // $ExpectType IterableIterator<RegExpExecArray>
matchAll(str, new RegExp(nonRegexStr, "g")); // $ExpectType IterableIterator<RegExpExecArray>
matchAll(str, globalRegex); // $ExpectType IterableIterator<RegExpExecArray>
matchAll.shim(); // $ExpectType void
str.matchAll(globalRegex); // $ExpectType IterableIterator<RegExpExecArray> || BuiltinIterator<RegExpExecArray, any, any>
str.matchAll(new RegExp(nonRegexStr, "g")); // $ExpectType IterableIterator<RegExpExecArray> || BuiltinIterator<RegExpExecArray, any, any>
str.matchAll(globalRegex); // $ExpectType IterableIterator<RegExpExecArray> || RegExpStringIterator<RegExpExecArray>
str.matchAll(new RegExp(nonRegexStr, "g")); // $ExpectType IterableIterator<RegExpExecArray> || RegExpStringIterator<RegExpExecArray>