microsoft / microsoft/TypeScript

Mechanism for late inferred types in control flow analysis

Open
#60,907 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.4k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

🔍 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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the linked Playground example and reading the issue's control-flow array inference discussion. A complete change would need a decided mechanism for carrying the later-inferred type to the outer scope, with behavior defined for the shown callback and inaccessible-type cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.