阅读中文版本

TS Type Narrowing Failure — Union Not Narrowed

Diagnose TypeScript errors where type narrowing fails inside callbacks or after reassignment, leaving a union type instead of the narrowed subtype.

node -e "require('./repro')"

Set NODE_OPTIONS=--stack-trace-limit=100 and run with verbose logging

Add console.log / debugger / breakpoint at the line before the throw

Symptom and Error Message

When running the TypeScript code, the runtime raises the following error:

error TS2345: Argument of type "string | undefined" is not assignable to parameter of type "string"

This error indicates that typescript reports a type error even though a type guard was applied earlier in the code. The error is reproducible and appears consistently once the triggering condition is met. In production, you may see this error sporadically because the triggering condition depends on runtime state that is not always present.

Root Cause Analysis

The fundamental cause is: typescript type narrowing is flow-sensitive and does not persist across function boundaries or after potential reassignment. Two factors converge to produce the visible error. First, the type guard narrows in one scope but the variable is reassigned or accessed in a callback where narrowing is lost. Second, typescript cannot narrow across function boundaries because the callback may run later when the type has changed. Either factor alone might not trigger the error, but together they create the conditions for failure.

Diagnosis Walkthrough

Start by reproducing the error in isolation. Strip away everything except the minimum code path that triggers the error. Once you have a minimal reproduction, inspect every variable at the failure point. Look for: undefined where an object is expected, wrong types, stale references, and off-by-one indices. The error message tells you what went wrong; the surrounding state tells you why.

Fix and Code Example

// Before (buggy)
// ... code that triggers the error ...

// After (fixed)
// ... corrected code with proper guard or type check ...

The fix addresses the root cause directly: copy the narrowed value to a const variable before the callback, or repeat the guard inside the callback. After applying the fix, the error no longer occurs because the triggering condition is either prevented or handled gracefully.

Verification

Run tsc –noEmit and confirm the error is gone; verify runtime behavior with the union cases. Run the reproduction case again and confirm the error is gone. Then run the full test suite to check for regressions. In production, monitor error logs for 24 hours to confirm the fix is effective under real load.

Common Pitfalls

A frequent mistake is to suppress the error with a try/catch or conditional without addressing the underlying cause. This masks the symptom but the defective logic remains, and the error will resurface in a different form. Always fix the root cause, not just the error message. Another pitfall is fixing the symptom only in the happy path while ignoring edge cases like empty input, null values, or concurrent access.