| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
|
Thanks for the PR! This section of the codebase is owned by Kibeom Kwon (@bumkeyy), YeonJuan (@yeonjuan), Dan Jeong (@guyeol), and Seohee Park (@dvlprsh) - if they write a comment saying "LGTM" then it will be merged. |
Sorry, something went wrong.
|
Translation of TypeScript 4.9.md
title: TypeScript 4.9 oneline: TypeScript 4.9 Release NotesThe satisfies OperatorTypeScript developers are often faced with a dilemma: we want to ensure that some expression matches some type, but also want to keep the most specific type of that expression for inference purposes. For example: // Each property can be a string or an RGB tuple.
const palette = {
red: [255, 0, 0],
green: "#00ff00",
bleu: [0, 0, 255]
// ^^^^ sacrebleu - we've made a typo!
};
// We want to be able to use array methods on 'red'...
const redComponent = palette.red.at(0);
// or string methods on 'green'...
const greenNormalized = palette.green.toUpperCase();Notice that we've written bleu, whereas we probably should have written blue. type Colors = "red" | "green" | "blue";
type RGB = [red: number, green: number, blue: number];
const palette: Record<Colors, string | RGB> = {
red: [255, 0, 0],
green: "#00ff00",
bleu: [0, 0, 255]
// ~~~~ The typo is now correctly detected
};
// But we now have an undesirable error here - 'palette.red' "could" be a string.
const redComponent = palette.red.at(0);The new satisfies operator lets us validate that the type of an expression matches some type, without changing the resulting type of that expression. type Colors = "red" | "green" | "blue";
type RGB = [red: number, green: number, blue: number];
const palette = {
red: [255, 0, 0],
green: "#00ff00",
bleu: [0, 0, 255]
// ~~~~ The typo is now caught!
} satisfies Record<Colors, string | RGB>;
// Both of these methods are still accessible!
const redComponent = palette.red.at(0);
const greenNormalized = palette.green.toUpperCase();satisfies can be used to catch lots of possible errors. type Colors = "red" | "green" | "blue";
// Ensure that we have exactly the keys from 'Colors'.
const favoriteColors = {
"red": "yes",
"green": false,
"blue": "kinda",
"platypus": false
// ~~~~~~~~~~ error - "platypus" was never listed in 'Colors'.
} satisfies Record<Colors, unknown>;
// All the information about the 'red', 'green', and 'blue' properties are retained.
const g: boolean = favoriteColors.green;Maybe we don't care about if the property names match up somehow, but we do care about the types of each property. type RGB = [red: number, green: number, blue: number];
const palette = {
red: [255, 0, 0],
green: "#00ff00",
blue: [0, 0]
// ~~~~~~ error!
} satisfies Record<string, string | RGB>;
// Information about each property is still maintained.
const redComponent = palette.red.at(0);
const greenNormalized = palette.green.toUpperCase();For more examples, you can see the issue proposing this and the implementing pull request. Unlisted Property Narrowing with the in OperatorAs developers, we often need to deal with values that aren't fully known at runtime. Previously, TypeScript allowed us to narrow away any types that don't explicitly list a property. interface RGB {
red: number;
green: number;
blue: number;
}
interface HSV {
hue: number;
saturation: number;
value: number;
}
function setColor(color: RGB | HSV) {
if ("hue" in color) {
// 'color' now has the type HSV
}
// ...
}Here, the type RGB didn't list the hue and got narrowed away, and leaving us with the type HSV. But what about examples where no type listed a given property? function tryGetPackageName(context) {
const packageJSON = context.packageJSON;
// Check to see if we have an object.
if (packageJSON && typeof packageJSON === "object") {
// Check to see if it has a string name property.
if ("name" in packageJSON && typeof packageJSON.name === "string") {
return packageJSON.name;
}
}
return undefined;
}Rewriting this to canonical TypeScript would just be a matter of defining and using a type for context; interface Context {
packageJSON: unknown;
}
function tryGetPackageName(context: Context) {
const packageJSON = context.packageJSON;
// Check to see if we have an object.
if (packageJSON && typeof packageJSON === "object") {
// Check to see if it has a string name property.
if ("name" in packageJSON && typeof packageJSON.name === "string") {
// ~~~~
// error! Property 'name' does not exist on type 'object.
return packageJSON.name;
// ~~~~
// error! Property 'name' does not exist on type 'object.
}
}
return undefined;
}This is because while the type of packageJSON was narrowed from unknown to object, the in operator strictly narrowed to types that actually defined the property being checked. TypeScript 4.9 makes the in operator a little bit more powerful when narrowing types that don't list the property at all. So in our example, packageJSON will have its type narrowed from unknown to object to object & Record<"name", unknown> interface Context {
packageJSON: unknown;
}
function tryGetPackageName(context: Context): string | undefined {
const packageJSON = context.packageJSON;
// Check to see if we have an object.
if (packageJSON && typeof packageJSON === "object") {
// Check to see if it has a string name property.
if ("name" in packageJSON && typeof packageJSON.name === "string") {
// Just works!
return packageJSON.name;
}
}
return undefined;
}TypeScript 4.9 also tightens up a few checks around how in is used, ensuring that the left side is assignable to the type string | number | symbol, and the right side is assignable to object. For more information, read the implementing pull request Auto-Accessors in ClassesTypeScript 4.9 supports an upcoming feature in ECMAScript called auto-accessors. class Person {
accessor name: string;
constructor(name: string) {
this.name = name;
}
}Under the covers, these auto-accessors "de-sugar" to a get and set accessor with an unreachable private property. class Person {
#__name: string;
get name() {
return this.#__name;
}
set name(value: string) {
this.#__name = name;
}
constructor(name: string) {
this.name = name;
}
}You can [read up more about the auto-accessors pull request on the original PR](https://github.com/microsoft/TypeScript/pull/49705). Checks For Equality on NaNA major gotcha for JavaScript developers is checking against the value NaN using the built-in equality operators. For some background, NaN is a special numeric value that stands for "Not a Number". console.log(NaN == 0) // false
console.log(NaN === 0) // false
console.log(NaN == NaN) // false
console.log(NaN === NaN) // falseBut at least symmetrically everything is always not-equal to NaN. console.log(NaN != 0) // true
console.log(NaN !== 0) // true
console.log(NaN != NaN) // true
console.log(NaN !== NaN) // trueThis technically isn't a JavaScript-specific problem, since any language that contains IEEE-754 floats has the same behavior; TypeScript now errors on direct comparisons against NaN, and will suggest using some variation of Number.isNaN instead. function validate(someValue: number) {
return someValue !== NaN;
// ~~~~~~~~~~~~~~~~~
// error: This condition will always return 'true'.
// Did you mean '!Number.isNaN(someValue)'?
}We believe that this change should strictly help catch beginner errors, similar to how TypeScript currently issues errors on comparisons against object and array literals. We'd like to extend our thanks to [Oleksandr Tarasiuk](https://github.com/a-tarasyuk) who [contributed this check](https://github.com/microsoft/TypeScript/pull/50626). Watching Files Using File System EventsIn previous versions, TypeScript used to spy on individual files. _polling_Heavily relied on. In general, a better approach is to use file system events. As a result, we chose the lowest common denominator of polling as the base value. Over time, we have provided the means to [choose a different file surveillance strategy](https://www.typescriptlang.org/docs/handbook/configuring-watch.html). In TypeScript 4.9, file watches are driven by file system events by default and only fall back to polling if you fail to set up an event-driven watcher. [The way file watches work is still based on environment variables and watchOptionscan be configured via [https://www.typescriptlang.org/docs/handbook/configuring-watch.html], and some editors, such as VS Code, watchOptionscan be supported independently.] (https://code.visualstudio.com/docs/getstarted/settings#:~:text=typescript%2etsserver%2ewatchOptions) You can learn more about this change (https://github.com/microsoft/TypeScript/pull/50366) on GitHub. "Remove Unused Imports" and "Sort Imports" Commands for EditorsPreviously, TypeScript only supported two editor commands to manage imports. import { Zebra, Moose, HoneyBadger } from "./zoo";
import { foo, bar } from "./helper";
let x: Moose | HoneyBadger = foo();The first was called "Organize Imports" which would remove unused imports, and then sort the remaining ones. import { foo } from "./helper";
import { HoneyBadger, Moose } from "./zoo";
let x: Moose | HoneyBadger = foo();In TypeScript 4.3, we introduced a command called "Sort Imports" which would only sort imports in the file, but not remove them - and would rewrite the file like this. import { bar, foo } from "./helper";
import { HoneyBadger, Moose, Zebra } from "./zoo";
let x: Moose | HoneyBadger = foo();The caveat with "Sort Imports" was that in Visual Studio Code, this feature was only available as an on-save command - not as a manually triggerable command. TypeScript 4.9 adds the other half, and now provides "Remove Unused Imports". import { Moose, HoneyBadger } from "./zoo";
import { foo } from "./helper";
let x: Moose | HoneyBadger = foo();This feature is available to all editors that wish to use either command; You can [view specifics of the feature here](https://github.com/microsoft/TypeScript/pull/50931). Go-to-Definition on return KeywordsIn the editor, when running a go-to-definition on the return keyword, TypeScript will now jump you to the top of the corresponding function. We expect TypeScript will expand this functionality to more keywords [such as await and yield](https://github.com/microsoft/TypeScript/issues/51223) or [switch, case, and default](https://github.com/microsoft/TypeScript/issues/51225). [This feature was implemented] (https://github.com/microsoft/TypeScript/pull/51227) thanks to [Oleksandr Tarasiuk](https://github.com/a-tarasyuk). Performance ImprovementsTypeScript has a few small, but notable, performance improvements. First, TypeScript's forEachChild function has been rewritten to use a function table lookup instead of a switch statement across all syntax nodes. Once we discovered this performance win for forEachChild, we tried it out on visitEachChild, a function we use for transforming nodes in the compiler and language service. The initial exploration in forEachChild was [inspired by a blog post](https://artemis.sh/2022/08/07/emulating-calculators-fast-in-js.html) by [Artemis Everfree](https://artemis.sh/). Finally, the way TypeScript preserves the information about a type in the true branch of a conditional type has been optimized. interface Zoo<T extends Animal> {
// ...
}
type MakeZoo<A> = A extends Animal ? Zoo<A> : never;TypeScript has to "remember" that A must also be an Animal when checking if Zoo<A> is valid. You can read up more on these optimizations on their respective pull requests:
Correctness Fixes and Breaking Changeslib.d.ts UpdatesWhile TypeScript strives to avoid major breaks, even small changes in the built-in libraries can cause issues. Better Types for Promise.resolvePromise.resolve now uses the Awaited type to unwrap Promise-like types passed to it. JavaScript Emit No Longer Elides ImportsWhen TypeScript first supported type-checking and compilation for JavaScript, it accidentally supported a feature called import elision. This behavior was questionable, especially the detection of whether the import doesn't refer to a value, since it means that TypeScript has to trust sometimes-inaccurate declaration files. // Input:
import { someValue, SomeClass } from "some-module";
/** @type {SomeClass} */
let val = someValue;
// Previous Output:
import { someValue } from "some-module";
/** @type {SomeClass} */
let val = someValue;
// Current Output:
import { someValue, SomeClass } from "some-module";
/** @type {SomeClass} */
let val = someValue;More information is available at [the implementing change](https://github.com/microsoft/TypeScript/pull/50404). exports is Prioritized Over typesVersionsPreviously, TypeScript incorrectly prioritized the typesVersions field over the exports field when resolving through a package.json under --moduleResolution node16. {
"type": "module",
"main": "./dist/main.js"
"typesVersions": {
"<4.8": { ".": ["4.8-types/main.d.ts"] },
"*": { ".": ["modern-types/main.d.ts"] }
},
"exports": {
".": {
+ "types@<4.8": "4.8-types/main.d.ts",
+ "types": "modern-types/main.d.ts",
"import": "./dist/main.js"
}
}
}For more information, [see this pull request](https://github.com/microsoft/TypeScript/pull/50890). substitute Replaced With constraint on SubstitutionTypesAs part of an optimization on substitution types, SubstitutionType objects no longer contain the substitute property representing the effective substitution (usually an intersection of the base type and the implicit constraint) - instead, they just contain the constraint property. For more details, [read more on the original pull request](https://github.com/microsoft/TypeScript/pull/50397). |
Sorry, something went wrong.
There was a problem hiding this comment.
LGTM
Sorry, something went wrong.
|
LGTM |
Sorry, something went wrong.
|
Merging because Kibeom Kwon (@bumkeyy) is a code-owner of all the changes - thanks! |
Sorry, something went wrong.
| Back | FazBrowse Home | New Git URL |
No description provided.