New intrinsic for Hashing a type to a string

🔍 Search Terms

Intrinsic hash type

✅ Viability Checklist

• This wouldn't be a breaking change in existing TypeScript/JavaScript code
• This wouldn't change the runtime behavior of existing JavaScript code
• This could be implemented without emitting different JS based on the types of the expressions
• This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
• This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
• This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals

⭐ Suggestion

I'd like an intrinsic type, called something along the lines of HashOf, which computes a small hash string of a TypeScript type. Together with versioning and comparisons between the generated hash and a string literal type, it can be used as a "contract" between the developer and implementer that "guarantees" that the underlying assumptions of a type have not changed. This can make it easier for library authors to signal minor breaking changes that do not alter the type signature.

The way it is used is outside the scope of this proposal. The proposal is only for an intrinsic type, HashOf or a similar name, that, given a TypeScript type, returns a small string representing the hash of the type. As pseudocode, imagine hash(JSON.stringify(myType)). Currently, this cannot be implemented efficiently within the type system.

📃 Motivating Example

When working with TypeScript, I tend to rely heavily on type inference of const objects and extensive use of satisfies to "remind" me of changes I need to make whenever I update an object. I'll use the example of translations to explain further.

Often, I have an object like:

const instrument = {
    piano: "Piano",
    guitar: "Guitar",
    electricGuitar: "Electric Guitar"
    //...
} as const 

type Instruments = typeof instrument
type InstrumentName = keyof Instruments

Then, somewhere else in the code, I might have a translation or a mapping from the InstrumentName key to some other constant:

const ItalianTranslation = {
    piano: "Pianoforte",
    guitar: "Chitarra",
    electricGuitar: "Chitarra elettrica",
} satisfies Record<InstrumentName, string>

Here, I'm using satisfies to encode the "contract" between the instrument names and their Italian translations. So whenever I add a new instrument, I am reminded by a type error that I also need to translate it.

This works, but imagine a user complains about the name "Guitar" and requests a clearer name to avoid confusion with "Electric Guitar." I decide to rename Guitar to Acoustic Guitar. TypeScript does not remind me to change the translation because the key hasn't changed, only the value has. This is a minor breaking change that I would like to signal to the consumers of my code (in this case, myself). It doesn't break the type, but it changes the underlying assumptions.

If there were a HashOf intrinsic, I could first compute the hash of the type when I initially use it, save it in a literal, and later compare it with the hash of the type itself:

const ItalianTranslation = {
    piano: "Pianoforte",
    guitar: "Chitarra",
    electricGuitar: "Chitarra elettrica",
} satisfies Record<InstrumentName, string>

// Pretend I had already calculated the hash of the instrument
// object when I first implemented ItalianTranslation.
// And the hash back then was "dhgb123a"
IsEqual<HashOf<Instruments>, "dhgb123a">

// Or alternatively, I can make a utility type that combines IsEqual and HashOf

This way, whenever Instruments changes, I am reminded to update the translation implementation.

The example is relevant to any scenario that requires a "mapping" from one type to another, where we need to remember to change something when one type changes. Another example is saving information to a database. We might have a service that saves an object but only cares about a subset of its properties. If the original object is updated, we might want to include additional properties in the database. Without a mechanism like HashOf, we must manually remember to update all relevant mapping points.

💻 Use Cases

1. I'd mostly use this to handle prompt translations in LLMs, where I have one prompt in English and need to maintain the variants that are translated in other languages. Or when I have to save an object when using Prisma ORM, and the object has optional keys that I need to remind myself to add whenever I add a new optional key to the object. In short, wherever I map type A to type B.
2. It is currently hard to efficiently compute the hash of a type using typescript type system.
3. An alternative and what I'm doing now is something somewhat similar, aka doing the hash by hand by using versioning. I can create a new type which has only the versions of objects in it (or the version of one object) and then do the same comparison in the place I need to remind myself to modify

该 issue 没有指定任何文件、测试或入口点。首先应根据 TypeScript 的类型系统设计目标和所述用例，评估提议的 HashOf intrinsic；只有确定了设计，并制定了计算和比较类型哈希的实现计划，才算完成。