Skip to content

Add an overload to Object.freeze that preserves literal types#33767

Merged
weswigham merged 3 commits into
microsoft:mainfrom
weswigham:add-literal-preserving-freeze-overload
Mar 3, 2022
Merged

Add an overload to Object.freeze that preserves literal types#33767
weswigham merged 3 commits into
microsoft:mainfrom
weswigham:add-literal-preserving-freeze-overload

Conversation

@weswigham
Copy link
Copy Markdown
Member

@weswigham weswigham commented Oct 2, 2019

This way when you write something like

const LogType = Object.freeze({
	error: "error", // message, c style arguments
	warn: "warn", // message, c style arguments
	info: "info", // message, c style arguments
	log: "log", // message, c style arguments
	debug: "debug", // message, c style arguments

	trace: "trace", // no arguments

	group: "group", // [label]
	groupCollapsed: "groupCollapsed", // [label]
	groupEnd: "groupEnd", // [label]

	profile: "profile", // [profileName]
	profileEnd: "profileEnd", // [profileName]

	time: "time", // name, time as [seconds, nanoseconds]

	clear: "clear", // no arguments
	status: "status" // message, arguments
});

(snippet from webpack) you get something with literally-typed members as a result, if possible. The intuition seems to be that it should just work like that already, but it does not currently.

falsandtru
falsandtru reviewed Oct 2, 2019
View reviewed changes
Comment thread src/lib/es5.d.ts Outdated
@weswigham
Copy link
Copy Markdown
Member Author

weswigham commented Oct 22, 2019

@typescript-bot test this

@typescript-bot
Copy link
Copy Markdown
Collaborator

typescript-bot commented Oct 22, 2019 •
edited
Loading

Heya @weswigham, I've started to run the extended test suite on this PR at a5cb1a6. You can monitor the build here. It should now contribute to this PR's status checks.

@weswigham
Copy link
Copy Markdown
Member Author

weswigham commented Oct 22, 2019

@typescript-bot user test this

@typescript-bot
Copy link
Copy Markdown
Collaborator

typescript-bot commented Oct 22, 2019 •
edited
Loading

Heya @weswigham, I've started to run the parallelized community code test suite on this PR at a5cb1a6. You can monitor the build here. It should now contribute to this PR's status checks.

@typescript-bot typescript-bot mentioned this pull request Oct 22, 2019
Closed
@typescript-bot
Copy link
Copy Markdown
Collaborator

typescript-bot commented Oct 22, 2019

The user suite test run you requested has finished and failed. I've opened a PR with the baseline diff from master.

@sandersn sandersn added the For Backlog Bug PRs that fix a backlog bug label Feb 1, 2020
@sandersn sandersn assigned sandersn and unassigned weswigham Mar 10, 2020
@typescript-bot typescript-bot added For Uncommitted Bug PR for untriaged, rejected, closed or missing bug and removed For Backlog Bug PRs that fix a backlog bug labels Mar 3, 2022
@sandersn
Copy link
Copy Markdown
Member

sandersn commented Mar 3, 2022

@typescript-bot user test this inline

@typescript-bot
Copy link
Copy Markdown
Collaborator

typescript-bot commented Mar 3, 2022 •
edited
Loading

Heya @sandersn, I've started to run the diff-based community code test suite on this PR at 89cfe35. You can monitor the build here.

Update: The results are in!

@typescript-bot
Copy link
Copy Markdown
Collaborator

typescript-bot commented Mar 3, 2022

@sandersn
Great news! no new errors were found between main..refs/pull/33767/merge

@sandersn
Copy link
Copy Markdown
Member

sandersn commented Mar 3, 2022

@weswigham this seems like a plausible change even though it's old. It didn't create any new errors in the user tests. Think it's worth trying out?

@weswigham
Copy link
Copy Markdown
Member Author

weswigham commented Mar 3, 2022

Yeah, I think it's still a reasonable change.

@weswigham weswigham merged commit ddad61e into microsoft:main Mar 3, 2022
@Andarist
Copy link
Copy Markdown
Contributor

Andarist commented Mar 4, 2022

Out of curiosity... if I hover over the call using this signature I might see something like this:

function freeze<{
    a: 1;
}, string | number | bigint | symbol>(o: {
    a: 1;
}): Readonly<{
    a: 1;
}>

In here, the U was not "computed" but instead its constraint is displayed. What kind of TS behavior/trait is at play here? On what foundation/principles this PR is built? 🤔

@Andarist Andarist mentioned this pull request Mar 4, 2022
Merged
@weswigham
Copy link
Copy Markdown
Member Author

weswigham commented Mar 4, 2022

We assign positions literal types when they're contextually typed by a generic with literal bases in the constraint.

@sandersn sandersn mentioned this pull request May 13, 2022
Closed
@Andarist Andarist mentioned this pull request Jan 20, 2023
Closed
@microsoft microsoft locked as resolved and limited conversation to collaborators Oct 21, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@sandersn sandersn sandersn approved these changes

@RyanCavanaugh RyanCavanaugh Awaiting requested review from RyanCavanaugh

@DanielRosenwasser DanielRosenwasser Awaiting requested review from DanielRosenwasser

+1 more reviewer

@falsandtru falsandtru falsandtru left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@sandersn sandersn

Labels

Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug

Projects

PR Backlog
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@weswigham @typescript-bot @sandersn @Andarist @falsandtru