microsoft / microsoft/TypeScript

Mechanism for late inferred types in control flow analysis

Offen
#60,907 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Awaiting More Feedback Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
132

Beschreibung

🔍 Search Terms

"control flow analysis" with variations of array, widening, callbacks, etc

✅ Viability Checklist
⭐ Suggestion

I have an issue where I want to capture a type defined in a scope that is inaccessible from my current scope. For example, I want to create a wrapper for some OpenAI function.

Playground

import 'openai'; // Just to get the types to load

type Magic = never;
// let expandingArray: Array<Magic> = []

let expandingArray = []

type Client = InstanceType<typeof import('openai').OpenAI>

const openai = {} as Client;

type Options = {
    onMessageResponse: (message: typeof expandingArray[number]) => void
}

const doStuff = (options: Options) => {
    openai.chat.completions.create({
        model: 'chatgpt-4o-latest',
        messages: []
    }).then(response => {
        const {role, ...rest} = response.choices[0].message

        // Here's where I finally resolve how I want the shape to look like
        expandingArray.push(
            {...rest, type: 'my-custom-type' as const}
        )
        type Good = typeof expandingArray[number]; // Good is typed correctly but local to this scope

        options.onMessageResponse(expandingArray[0]) // This should be type-safe and not just never
    })
}

type Bad = typeof expandingArray;

As you can see, the goal is to have an auto-widening type based on usage later on (within the same file). This somewhat already works with control flow analysis for arrays, as you can see in the type Good = ... type above.

Realistically, when this situation occurs, application authors will type onMessageResponse as (message: any) => void, which is unfortunate because all the type information is there and just needs a way to be bubbled up to the higher scope.

It would be nice if there was an escape hatch to tell the type system that I care about the typeof a value declared somewhere inaccessible to the current type scope within the file. Obviously, this wouldn't actually use an untyped array with some annotation on the type; this would probably be a special new named type like LateInferredType or something similar, e.g.:

type Message = LateInferredType;

type Options = {
    onMessageResponse: (message: Message) => void
}

/// ...
    .then(response => {
        const {role, ...rest} = response.choices[0].message

        // Here's where I finally resolve how I want the shape to look like
        const message = {...rest, type: 'my-custom-type' as const}

        options.onMessageResponse(message as Message) // Perhaps casting signals to the type system to recognize it
    })

Or perhaps there's a non-breaking way of declaring this syntax that I'm not thinking of.

📃 Motivating Example

This allows smarter inference without needing to chase down every derived property. Sometime the specific types aren't even exported by the upstream libraries and there's no good way to mention them without recreating a large complex type which is fragile and error prone.

💻 Use Cases
  1. What do you want to use this for?
    This is useful for writing type safe code where you want to expose a complex type that doesn't have a concrete definition and is more tied to the specific shape of a single step in a complex application
  2. What shortcomings exist with current approaches?
    There's no way to signal later in a program or without a callback that a type should be widened, but sometimes that exact functionality is needed
  3. What workarounds are you using in the meantime?
    None

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, das verlinkte Playground-Beispiel zu reproduzieren und die Diskussion zur Control-Flow-Array-Inferenz im Issue zu lesen. Eine vollständige Änderung würde einen festgelegten Mechanismus benötigen, um den später inferierten Typ in den äußeren Gültigkeitsbereich zu übertragen, wobei das Verhalten für den gezeigten callback und Fälle mit nicht zugänglichen Typen definiert sein muss.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
compilers
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.