Add the Omit helper type

[Daniel Rosenwasser (DanielRosenwasser)]

Fixes#30455.

[Daniel Rosenwasser (DanielRosenwasser)]

TypeScript Bot (@typescript-bot) run dt

[TypeScript Bot (typescript-bot)]

Heya Daniel Rosenwasser (@DanielRosenwasser), I've started to run the Definitely Typed test suite on this PR at 53e76b3. You can monitor the build here. It should now contribute to this PR's status checks.

[Daniel Rosenwasser (DanielRosenwasser)]

The only breakages on DefinitelyTyped seem to be

• amap-js-api
• amap-js-api-indoor-map
• amap-js-api-map3d

And those all really come from amap-js-api unnecessarily plopping Omit in the global scope.

[Daniel Rosenwasser (DanielRosenwasser)]

A fix is now out to DefinitelyTyped's amap-js-api package.

I used BigTSQuery to partially assess the breakage with the following query

SourceFile:not([externalModuleIndicator]) > TypeAliasDeclaration > Identifier[name=Omit]

BigTSQuery isn't fully up to date (Uri Shaked (@urish) out of curiosity, how recent is the dataset?), but we saw three distinct results:

• an old fork of hollowverse (M-Fawaz Orabi (@forabi))
• an old revision of ArragroCMS.Examples (thanks Michael Jewell (@mike-jewell))
• this one test case we have in our repository

Also:

• There are no global InterfaceDeclarations named Omit
• There are no global ClassDeclarations named Omit

[Daniel Rosenwasser (DanielRosenwasser)]

We discussed this at #30738 and believe that the breakage can be easily communicated and is more limited than we initially anticipated.

[Aleksey Levenstein (levenleven)]

Keys are not limited to keyof T. Is that on purpose?

[Veniamin Krol (vkrol)]

Aleksey Levenstein (@levenleven)

Should we constrain K in the official definition?

Nah

#30738

🤔

[Daniel Rosenwasser (DanielRosenwasser)]

Exclude doesn't constrain its second type parameter on the first, so we felt like it would be strange to do that with Omit.

[Daniel Rosenwasser (DanielRosenwasser)]

Note, if you feel that shouldn't be the case, I'd encourage you to open up a separate issue to discuss it.

[Uri Shaked (urish)]

Daniel Rosenwasser (@DanielRosenwasser) the BigTSQuery dataset has last been updated around June 2018. If you find it useful, I can spend some time updating it

[Felix Becker (felixfbecker)]

Can Omit please be made strict before 3.5 moves to stable? #30825

[Ryan Cavanaugh (RyanCavanaugh)]

Felix Becker (@felixfbecker) the definition was intentional.

[Leo Y. Li (leoyli)]

Daniel Rosenwasser (@DanielRosenwasser)

Exclude doesn't constrain its second type parameter on the first, so we felt like it would be strange to do that with Omit.

But how a bout the case of Pick? Pick do constrain the use case.

Pick: pick members from a group to get a sub-group;
Omit: omit members in a group to get a sub-group;

As you can see, these 2 helper types are somehow complimentary. Looks pretty nature and intuitive when we use them together. How come Omit being permissive and Pick isn't???

When we make comparison, compare Omit with Exclude is like compare egg with chicken. Exclude is comparable with Extract not Omit, which should be Pick, IMHO.

[Oliver Joseph Ash (OliverJAsh)]

I've ran into a few bugs which would have been caught if K was constrained (like it is for Pick). Any chance of reconsidering this?

[Anatoliy Tsaryov (KazimirPodolski)]

TypeScript is not open-source, it's source-available.