Skip to content

Commit ddad61e

Browse files
weswighamsandersn
weswigham
and
sandersn
authored
Add an overload to Object.freeze that preserves literal types (microsoft#33767)
* Add an overload to Object.freeze that preserves literal types * Accept changes baselines Co-authored-by: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com>
1 parent 0a24dee commit ddad61e

34 files changed

+120
-114
lines changed

‎src/lib/es5.d.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,12 @@ interface ObjectConstructor {
206206
*/
207207
freeze<T extends Function>(f: T): T;
208208

209+
/**
210+
* Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
211+
* @param o Object on which to lock the attributes.
212+
*/
213+
freeze<T extends {[idx: string]: U | null | undefined | object}, U extends string | bigint | number | symbol>(o: T): Readonly<T>;
214+
209215
/**
210216
* Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
211217
* @param o Object on which to lock the attributes.

‎tests/baselines/reference/circularContextualReturnType.symbols‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
// Repro from #17711
33

44
Object.freeze({
5-
>Object.freeze : Symbol(ObjectConstructor.freeze, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --))
5+
>Object.freeze : Symbol(ObjectConstructor.freeze, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --))
66
>Object : Symbol(Object, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --))
7-
>freeze : Symbol(ObjectConstructor.freeze, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --))
7+
>freeze : Symbol(ObjectConstructor.freeze, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --))
88

99
foo() {
1010
>foo : Symbol(foo, Decl(circularContextualReturnType.ts, 2, 15))
1111

1212
return Object.freeze('a');
13-
>Object.freeze : Symbol(ObjectConstructor.freeze, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --))
13+
>Object.freeze : Symbol(ObjectConstructor.freeze, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --))
1414
>Object : Symbol(Object, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --))
15-
>freeze : Symbol(ObjectConstructor.freeze, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --))
15+
>freeze : Symbol(ObjectConstructor.freeze, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --))
1616

1717
},
1818
});

‎tests/baselines/reference/circularContextualReturnType.types‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@
33

44
Object.freeze({
55
>Object.freeze({ foo() { return Object.freeze('a'); },}) : Readonly<{ foo(): string; }>
6-
>Object.freeze : { <T>(a: T[]): readonly T[]; <T extends Function>(f: T): T; <T>(o: T): Readonly<T>; }
6+
>Object.freeze : { <T>(a: T[]): readonly T[]; <T extends Function>(f: T): T; <T extends { [idx: string]: object | U | null | undefined; }, U extends string | number | bigint | symbol>(o: T): Readonly<T>; <T>(o: T): Readonly<T>; }
77
>Object : ObjectConstructor
8-
>freeze : { <T>(a: T[]): readonly T[]; <T extends Function>(f: T): T; <T>(o: T): Readonly<T>; }
8+
>freeze : { <T>(a: T[]): readonly T[]; <T extends Function>(f: T): T; <T extends { [idx: string]: object | U | null | undefined; }, U extends string | number | bigint | symbol>(o: T): Readonly<T>; <T>(o: T): Readonly<T>; }
99
>{ foo() { return Object.freeze('a'); },} : { foo(): string; }
1010

1111
foo() {
1212
>foo : () => string
1313

1414
return Object.freeze('a');
1515
>Object.freeze('a') : string
16-
>Object.freeze : { <T>(a: T[]): readonly T[]; <T extends Function>(f: T): T; <T>(o: T): Readonly<T>; }
16+
>Object.freeze : { <T>(a: T[]): readonly T[]; <T extends Function>(f: T): T; <T extends { [idx: string]: object | U | null | undefined; }, U extends string | number | bigint | symbol>(o: T): Readonly<T>; <T>(o: T): Readonly<T>; }
1717
>Object : ObjectConstructor
18-
>freeze : { <T>(a: T[]): readonly T[]; <T extends Function>(f: T): T; <T>(o: T): Readonly<T>; }
18+
>freeze : { <T>(a: T[]): readonly T[]; <T extends Function>(f: T): T; <T extends { [idx: string]: object | U | null | undefined; }, U extends string | number | bigint | symbol>(o: T): Readonly<T>; <T>(o: T): Readonly<T>; }
1919
>'a' : "a"
2020

2121
},

‎tests/baselines/reference/destructuringParameterDeclaration4.errors.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ tests/cases/conformance/es6/destructuring/destructuringParameterDeclaration4.ts(
4141
a1(...array2); // Error parameter type is (number|string)[]
4242
~~~~~~
4343
!!! error TS2552: Cannot find name 'array2'. Did you mean 'Array'?
44-
!!! related TS2728 /.ts/lib.es5.d.ts:1464:13: 'Array' is declared here.
44+
!!! related TS2728 /.ts/lib.es5.d.ts:1470:13: 'Array' is declared here.
4545
a5([1, 2, "string", false, true]); // Error, parameter type is [any, any, [[any]]]
4646
~~~~~~~~
4747
!!! error TS2322: Type 'string' is not assignable to type '[[any]]'.

‎tests/baselines/reference/destructuringTuple.errors.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ tests/cases/compiler/destructuringTuple.ts(11,60): error TS2769: No overload mat
3333
!!! error TS2769: Overload 2 of 3, '(callbackfn: (previousValue: [], currentValue: number, currentIndex: number, array: number[]) => [], initialValue: []): []', gave the following error.
3434
!!! error TS2769: Type 'never[]' is not assignable to type '[]'.
3535
!!! error TS2769: Target allows only 0 element(s) but source may have more.
36-
!!! related TS6502 /.ts/lib.es5.d.ts:1429:24: The expected type comes from the return type of this signature.
37-
!!! related TS6502 /.ts/lib.es5.d.ts:1435:27: The expected type comes from the return type of this signature.
36+
!!! related TS6502 /.ts/lib.es5.d.ts:1435:24: The expected type comes from the return type of this signature.
37+
!!! related TS6502 /.ts/lib.es5.d.ts:1441:27: The expected type comes from the return type of this signature.
3838
~~
3939
!!! error TS2769: No overload matches this call.
4040
!!! error TS2769: Overload 1 of 2, '(...items: ConcatArray<never>[]): never[]', gave the following error.

‎tests/baselines/reference/duplicateNumericIndexers.errors.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ tests/cases/conformance/types/members/duplicateNumericIndexers.ts(24,5): error T
1010
tests/cases/conformance/types/members/duplicateNumericIndexers.ts(25,5): error TS2374: Duplicate index signature for type 'number'.
1111
tests/cases/conformance/types/members/duplicateNumericIndexers.ts(29,5): error TS2374: Duplicate index signature for type 'number'.
1212
tests/cases/conformance/types/members/duplicateNumericIndexers.ts(30,5): error TS2374: Duplicate index signature for type 'number'.
13-
lib.es5.d.ts(517,5): error TS2374: Duplicate index signature for type 'number'.
14-
lib.es5.d.ts(1450,5): error TS2374: Duplicate index signature for type 'number'.
13+
lib.es5.d.ts(523,5): error TS2374: Duplicate index signature for type 'number'.
14+
lib.es5.d.ts(1456,5): error TS2374: Duplicate index signature for type 'number'.
1515

1616

1717
==== tests/cases/conformance/types/members/duplicateNumericIndexers.ts (12 errors) ====

‎tests/baselines/reference/externModule.errors.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,20 +66,20 @@ tests/cases/compiler/externModule.ts(37,3): error TS2552: Cannot find name 'XDat
6666
var d=new XDate();
6767
~~~~~
6868
!!! error TS2552: Cannot find name 'XDate'. Did you mean 'Date'?
69-
!!! related TS2728 /.ts/lib.es5.d.ts:927:13: 'Date' is declared here.
69+
!!! related TS2728 /.ts/lib.es5.d.ts:933:13: 'Date' is declared here.
7070
d.getDay();
7171
d=new XDate(1978,2);
7272
~~~~~
7373
!!! error TS2552: Cannot find name 'XDate'. Did you mean 'Date'?
74-
!!! related TS2728 /.ts/lib.es5.d.ts:927:13: 'Date' is declared here.
74+
!!! related TS2728 /.ts/lib.es5.d.ts:933:13: 'Date' is declared here.
7575
d.getXDate();
7676
var n=XDate.parse("3/2/2004");
7777
~~~~~
7878
!!! error TS2552: Cannot find name 'XDate'. Did you mean 'Date'?
79-
!!! related TS2728 /.ts/lib.es5.d.ts:927:13: 'Date' is declared here.
79+
!!! related TS2728 /.ts/lib.es5.d.ts:933:13: 'Date' is declared here.
8080
n=XDate.UTC(1964,2,1);
8181
~~~~~
8282
!!! error TS2552: Cannot find name 'XDate'. Did you mean 'Date'?
83-
!!! related TS2728 /.ts/lib.es5.d.ts:927:13: 'Date' is declared here.
83+
!!! related TS2728 /.ts/lib.es5.d.ts:933:13: 'Date' is declared here.
8484

8585

‎tests/baselines/reference/invalidTypeOfTarget.errors.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ tests/cases/conformance/types/specifyingTypes/typeQueries/invalidTypeOfTarget.ts
3636
var x7: typeof function f() { };
3737
~~~~~~~~
3838
!!! error TS2552: Cannot find name 'function'. Did you mean 'Function'?
39-
!!! related TS2728 /.ts/lib.es5.d.ts:318:13: 'Function' is declared here.
39+
!!! related TS2728 /.ts/lib.es5.d.ts:324:13: 'Function' is declared here.
4040
~
4141
!!! error TS1005: ',' expected.
4242
~

‎tests/baselines/reference/jsEnumTagOnObjectFrozen.symbols‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ cbThing(type => {
4242
/** @enum {string} */
4343
const Thing = Object.freeze({
4444
>Thing : Symbol(Thing, Decl(index.js, 1, 5), Decl(index.js, 0, 4))
45-
>Object.freeze : Symbol(ObjectConstructor.freeze, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --))
45+
>Object.freeze : Symbol(ObjectConstructor.freeze, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --))
4646
>Object : Symbol(Object, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --))
47-
>freeze : Symbol(ObjectConstructor.freeze, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --))
47+
>freeze : Symbol(ObjectConstructor.freeze, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --))
4848

4949
a: "thing",
5050
>a : Symbol(a, Decl(index.js, 1, 29))

‎tests/baselines/reference/jsEnumTagOnObjectFrozen.types‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
=== tests/cases/compiler/usage.js ===
22
const { Thing, useThing, cbThing } = require("./index");
3-
>Thing : Readonly<{ a: string; b: string; }>
3+
>Thing : Readonly<{ a: "thing"; b: "chill"; }>
44
>useThing : (x: string) => void
55
>cbThing : (x: (x: string) => void) => void
66
>require("./index") : typeof import("tests/cases/compiler/index")
@@ -10,9 +10,9 @@ const { Thing, useThing, cbThing } = require("./index");
1010
useThing(Thing.a);
1111
>useThing(Thing.a) : void
1212
>useThing : (x: string) => void
13-
>Thing.a : string
14-
>Thing : Readonly<{ a: string; b: string; }>
15-
>a : string
13+
>Thing.a : "thing"
14+
>Thing : Readonly<{ a: "thing"; b: "chill"; }>
15+
>a : "thing"
1616

1717
/**
1818
* @typedef {Object} LogEntry
@@ -47,29 +47,29 @@ cbThing(type => {
4747
=== tests/cases/compiler/index.js ===
4848
/** @enum {string} */
4949
const Thing = Object.freeze({
50-
>Thing : Readonly<{ a: string; b: string; }>
51-
>Object.freeze({ a: "thing", b: "chill"}) : Readonly<{ a: string; b: string; }>
52-
>Object.freeze : { <T>(a: T[]): readonly T[]; <T extends Function>(f: T): T; <T>(o: T): Readonly<T>; }
50+
>Thing : Readonly<{ a: "thing"; b: "chill"; }>
51+
>Object.freeze({ a: "thing", b: "chill"}) : Readonly<{ a: "thing"; b: "chill"; }>
52+
>Object.freeze : { <T>(a: T[]): readonly T[]; <T extends Function>(f: T): T; <T extends { [idx: string]: object | U; }, U extends string | number | bigint | symbol>(o: T): Readonly<T>; <T>(o: T): Readonly<T>; }
5353
>Object : ObjectConstructor
54-
>freeze : { <T>(a: T[]): readonly T[]; <T extends Function>(f: T): T; <T>(o: T): Readonly<T>; }
55-
>{ a: "thing", b: "chill"} : { a: string; b: string; }
54+
>freeze : { <T>(a: T[]): readonly T[]; <T extends Function>(f: T): T; <T extends { [idx: string]: object | U; }, U extends string | number | bigint | symbol>(o: T): Readonly<T>; <T>(o: T): Readonly<T>; }
55+
>{ a: "thing", b: "chill"} : { a: "thing"; b: "chill"; }
5656

5757
a: "thing",
58-
>a : string
58+
>a : "thing"
5959
>"thing" : "thing"
6060

6161
b: "chill"
62-
>b : string
62+
>b : "chill"
6363
>"chill" : "chill"
6464

6565
});
6666

6767
exports.Thing = Thing;
68-
>exports.Thing = Thing : Readonly<{ a: string; b: string; }>
69-
>exports.Thing : Readonly<{ a: string; b: string; }>
68+
>exports.Thing = Thing : Readonly<{ a: "thing"; b: "chill"; }>
69+
>exports.Thing : Readonly<{ a: "thing"; b: "chill"; }>
7070
>exports : typeof import("tests/cases/compiler/index")
71-
>Thing : Readonly<{ a: string; b: string; }>
72-
>Thing : Readonly<{ a: string; b: string; }>
71+
>Thing : Readonly<{ a: "thing"; b: "chill"; }>
72+
>Thing : Readonly<{ a: "thing"; b: "chill"; }>
7373

7474
/**
7575
* @param {Thing} x

0 commit comments

Comments
 (0)