Skip to content

Investigation: using a mapped form of Omit in rest destructuring #53134

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.

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

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions src/compiler/checker.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15724,7 +15724,7 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {

function getGlobalOmitSymbol(): Symbol | undefined {
// We always report an error, so cache a result in the event we could not resolve the symbol to prevent reporting it multiple times
deferredGlobalOmitSymbol ||= getGlobalTypeAliasSymbol("Omit" as __String, /*arity*/ 2, /*reportErrors*/ true) || unknownSymbol;
deferredGlobalOmitSymbol ||= getGlobalTypeAliasSymbol("MappedOmit" as __String, /*arity*/ 2, /*reportErrors*/ true) || unknownSymbol;
return deferredGlobalOmitSymbol === unknownSymbol ? undefined : deferredGlobalOmitSymbol;
}

Expand Down Expand Up @@ -40810,7 +40810,6 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
function checkExpressionStatement(node: ExpressionStatement) {
// Grammar checking
checkGrammarStatementInAmbientContext(node);

checkExpression(node.expression);
}

Expand Down
1 change: 1 addition & 0 deletions src/harness/fourslashInterfaceImpl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1204,6 +1204,7 @@ export namespace Completion {
typeEntry("Record"),
typeEntry("Exclude"),
typeEntry("Extract"),
typeEntry("MappedOmit"),
typeEntry("Omit"),
typeEntry("NonNullable"),
typeEntry("Parameters"),
Expand Down
6 changes: 6 additions & 0 deletions src/lib/es5.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1584,6 +1584,12 @@ type Extract<T, U> = T extends U ? T : never;
*/
type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;

/**
* Construct a type with the properties of T except for those in type K,
* in a mapped format
*/
type MappedOmit<T, K extends keyof any> = { [P in keyof T as Exclude<P, K>]: T[P]; }

/**
* Exclude null and undefined from T
*/
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ class A {
>A : Symbol(A, Decl(destructuringUnspreadableIntoRest.ts, 0, 0))

rest1.publicProp;
>rest1.publicProp : Symbol(publicProp, Decl(destructuringUnspreadableIntoRest.ts, 1, 16))
>rest1.publicProp : Symbol(publicProp)
>rest1 : Symbol(rest1, Decl(destructuringUnspreadableIntoRest.ts, 14, 15))
>publicProp : Symbol(publicProp, Decl(destructuringUnspreadableIntoRest.ts, 1, 16))
>publicProp : Symbol(publicProp)

rest2.publicProp;
>rest2.publicProp : Symbol(A.publicProp, Decl(destructuringUnspreadableIntoRest.ts, 1, 16))
Expand Down Expand Up @@ -157,9 +157,9 @@ function destructure<T extends A>(x: T) {
>A : Symbol(A, Decl(destructuringUnspreadableIntoRest.ts, 0, 0))

rest1.publicProp;
>rest1.publicProp : Symbol(publicProp, Decl(destructuringUnspreadableIntoRest.ts, 1, 16))
>rest1.publicProp : Symbol(publicProp)
>rest1 : Symbol(rest1, Decl(destructuringUnspreadableIntoRest.ts, 52, 11))
>publicProp : Symbol(publicProp, Decl(destructuringUnspreadableIntoRest.ts, 1, 16))
>publicProp : Symbol(publicProp)

rest2.publicProp;
>rest2.publicProp : Symbol(A.publicProp, Decl(destructuringUnspreadableIntoRest.ts, 1, 16))
Expand Down
56 changes: 28 additions & 28 deletions tests/baselines/reference/destructuringUnspreadableIntoRest.types
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class A {
>method : () => void

const { ...rest1 } = this;
>rest1 : Omit<this, "getter" | "setter" | "method">
>rest1 : MappedOmit<this, "getter" | "setter" | "method">
>this : this

const { ...rest2 } = this as A;
Expand All @@ -40,7 +40,7 @@ class A {
const { publicProp: _1, ...rest3 } = this;
>publicProp : any
>_1 : string
>rest3 : Omit<this, "publicProp" | "getter" | "setter" | "method">
>rest3 : MappedOmit<this, "publicProp" | "getter" | "setter" | "method">
>this : this

const { publicProp: _2, ...rest4 } = this as A;
Expand All @@ -52,7 +52,7 @@ class A {

rest1.publicProp;
>rest1.publicProp : this["publicProp"]
>rest1 : Omit<this, "getter" | "setter" | "method">
>rest1 : MappedOmit<this, "getter" | "setter" | "method">
>publicProp : this["publicProp"]

rest2.publicProp;
Expand All @@ -62,7 +62,7 @@ class A {

rest3.publicProp;
>rest3.publicProp : any
>rest3 : Omit<this, "publicProp" | "getter" | "setter" | "method">
>rest3 : MappedOmit<this, "publicProp" | "getter" | "setter" | "method">
>publicProp : any

rest4.publicProp;
Expand All @@ -72,7 +72,7 @@ class A {

rest1.privateProp;
>rest1.privateProp : any
>rest1 : Omit<this, "getter" | "setter" | "method">
>rest1 : MappedOmit<this, "getter" | "setter" | "method">
>privateProp : any

rest2.privateProp;
Expand All @@ -82,7 +82,7 @@ class A {

rest3.privateProp;
>rest3.privateProp : any
>rest3 : Omit<this, "publicProp" | "getter" | "setter" | "method">
>rest3 : MappedOmit<this, "publicProp" | "getter" | "setter" | "method">
>privateProp : any

rest4.privateProp;
Expand All @@ -92,7 +92,7 @@ class A {

rest1.protectedProp;
>rest1.protectedProp : any
>rest1 : Omit<this, "getter" | "setter" | "method">
>rest1 : MappedOmit<this, "getter" | "setter" | "method">
>protectedProp : any

rest2.protectedProp;
Expand All @@ -102,7 +102,7 @@ class A {

rest3.protectedProp;
>rest3.protectedProp : any
>rest3 : Omit<this, "publicProp" | "getter" | "setter" | "method">
>rest3 : MappedOmit<this, "publicProp" | "getter" | "setter" | "method">
>protectedProp : any

rest4.protectedProp;
Expand All @@ -112,7 +112,7 @@ class A {

rest1.getter;
>rest1.getter : any
>rest1 : Omit<this, "getter" | "setter" | "method">
>rest1 : MappedOmit<this, "getter" | "setter" | "method">
>getter : any

rest2.getter;
Expand All @@ -122,7 +122,7 @@ class A {

rest3.getter;
>rest3.getter : any
>rest3 : Omit<this, "publicProp" | "getter" | "setter" | "method">
>rest3 : MappedOmit<this, "publicProp" | "getter" | "setter" | "method">
>getter : any

rest4.getter;
Expand All @@ -132,7 +132,7 @@ class A {

rest1.setter;
>rest1.setter : any
>rest1 : Omit<this, "getter" | "setter" | "method">
>rest1 : MappedOmit<this, "getter" | "setter" | "method">
>setter : any

rest2.setter;
Expand All @@ -142,7 +142,7 @@ class A {

rest3.setter;
>rest3.setter : any
>rest3 : Omit<this, "publicProp" | "getter" | "setter" | "method">
>rest3 : MappedOmit<this, "publicProp" | "getter" | "setter" | "method">
>setter : any

rest4.setter;
Expand All @@ -152,7 +152,7 @@ class A {

rest1.method;
>rest1.method : any
>rest1 : Omit<this, "getter" | "setter" | "method">
>rest1 : MappedOmit<this, "getter" | "setter" | "method">
>method : any

rest2.method;
Expand All @@ -162,7 +162,7 @@ class A {

rest3.method;
>rest3.method : any
>rest3 : Omit<this, "publicProp" | "getter" | "setter" | "method">
>rest3 : MappedOmit<this, "publicProp" | "getter" | "setter" | "method">
>method : any

rest4.method;
Expand All @@ -177,7 +177,7 @@ function destructure<T extends A>(x: T) {
>x : T

const { ...rest1 } = x;
>rest1 : Omit<T, "getter" | "setter" | "method">
>rest1 : MappedOmit<T, "getter" | "setter" | "method">
>x : T

const { ...rest2 } = x as A;
Expand All @@ -188,7 +188,7 @@ function destructure<T extends A>(x: T) {
const { publicProp: _1, ...rest3 } = x;
>publicProp : any
>_1 : string
>rest3 : Omit<T, "publicProp" | "getter" | "setter" | "method">
>rest3 : MappedOmit<T, "publicProp" | "getter" | "setter" | "method">
>x : T

const { publicProp: _2, ...rest4 } = x as A;
Expand All @@ -200,7 +200,7 @@ function destructure<T extends A>(x: T) {

rest1.publicProp;
>rest1.publicProp : T["publicProp"]
>rest1 : Omit<T, "getter" | "setter" | "method">
>rest1 : MappedOmit<T, "getter" | "setter" | "method">
>publicProp : T["publicProp"]

rest2.publicProp;
Expand All @@ -210,7 +210,7 @@ function destructure<T extends A>(x: T) {

rest3.publicProp;
>rest3.publicProp : any
>rest3 : Omit<T, "publicProp" | "getter" | "setter" | "method">
>rest3 : MappedOmit<T, "publicProp" | "getter" | "setter" | "method">
>publicProp : any

rest4.publicProp;
Expand All @@ -220,7 +220,7 @@ function destructure<T extends A>(x: T) {

rest1.privateProp;
>rest1.privateProp : any
>rest1 : Omit<T, "getter" | "setter" | "method">
>rest1 : MappedOmit<T, "getter" | "setter" | "method">
>privateProp : any

rest2.privateProp;
Expand All @@ -230,7 +230,7 @@ function destructure<T extends A>(x: T) {

rest3.privateProp;
>rest3.privateProp : any
>rest3 : Omit<T, "publicProp" | "getter" | "setter" | "method">
>rest3 : MappedOmit<T, "publicProp" | "getter" | "setter" | "method">
>privateProp : any

rest4.privateProp;
Expand All @@ -240,7 +240,7 @@ function destructure<T extends A>(x: T) {

rest1.protectedProp;
>rest1.protectedProp : any
>rest1 : Omit<T, "getter" | "setter" | "method">
>rest1 : MappedOmit<T, "getter" | "setter" | "method">
>protectedProp : any

rest2.protectedProp;
Expand All @@ -250,7 +250,7 @@ function destructure<T extends A>(x: T) {

rest3.protectedProp;
>rest3.protectedProp : any
>rest3 : Omit<T, "publicProp" | "getter" | "setter" | "method">
>rest3 : MappedOmit<T, "publicProp" | "getter" | "setter" | "method">
>protectedProp : any

rest4.protectedProp;
Expand All @@ -260,7 +260,7 @@ function destructure<T extends A>(x: T) {

rest1.getter;
>rest1.getter : any
>rest1 : Omit<T, "getter" | "setter" | "method">
>rest1 : MappedOmit<T, "getter" | "setter" | "method">
>getter : any

rest2.getter;
Expand All @@ -270,7 +270,7 @@ function destructure<T extends A>(x: T) {

rest3.getter;
>rest3.getter : any
>rest3 : Omit<T, "publicProp" | "getter" | "setter" | "method">
>rest3 : MappedOmit<T, "publicProp" | "getter" | "setter" | "method">
>getter : any

rest4.getter;
Expand All @@ -280,7 +280,7 @@ function destructure<T extends A>(x: T) {

rest1.setter;
>rest1.setter : any
>rest1 : Omit<T, "getter" | "setter" | "method">
>rest1 : MappedOmit<T, "getter" | "setter" | "method">
>setter : any

rest2.setter;
Expand All @@ -290,7 +290,7 @@ function destructure<T extends A>(x: T) {

rest3.setter;
>rest3.setter : any
>rest3 : Omit<T, "publicProp" | "getter" | "setter" | "method">
>rest3 : MappedOmit<T, "publicProp" | "getter" | "setter" | "method">
>setter : any

rest4.setter;
Expand All @@ -300,7 +300,7 @@ function destructure<T extends A>(x: T) {

rest1.method;
>rest1.method : any
>rest1 : Omit<T, "getter" | "setter" | "method">
>rest1 : MappedOmit<T, "getter" | "setter" | "method">
>method : any

rest2.method;
Expand All @@ -310,7 +310,7 @@ function destructure<T extends A>(x: T) {

rest3.method;
>rest3.method : any
>rest3 : Omit<T, "publicProp" | "getter" | "setter" | "method">
>rest3 : MappedOmit<T, "publicProp" | "getter" | "setter" | "method">
>method : any

rest4.method;
Expand Down
12 changes: 6 additions & 6 deletions tests/baselines/reference/genericIsNeverEmptyObject.types
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
// Repro from #29067

function test<T extends { a: string }>(obj: T) {
>test : <T extends { a: string; }>(obj: T) => Omit<T, "a"> & { b: string; }
>test : <T extends { a: string; }>(obj: T) => MappedOmit<T, "a"> & { b: string; }
>a : string
>obj : T

let { a, ...rest } = obj;
>a : string
>rest : Omit<T, "a">
>rest : MappedOmit<T, "a">
>obj : T

return { ...rest, b: a };
>{ ...rest, b: a } : Omit<T, "a"> & { b: string; }
>rest : Omit<T, "a">
>{ ...rest, b: a } : MappedOmit<T, "a"> & { b: string; }
>rest : MappedOmit<T, "a">
>b : string
>a : string
}
Expand All @@ -30,7 +30,7 @@ let o2: { b: string, x: number } = test(o1);
>o2 : { b: string; x: number; }
>b : string
>x : number
>test(o1) : Omit<{ a: string; x: number; }, "a"> & { b: string; }
>test : <T extends { a: string; }>(obj: T) => Omit<T, "a"> & { b: string; }
>test(o1) : MappedOmit<{ a: string; x: number; }, "a"> & { b: string; }
>test : <T extends { a: string; }>(obj: T) => MappedOmit<T, "a"> & { b: string; }
>o1 : { a: string; x: number; }

Loading