microsoft / microsoft/TypeScript

Asserts on `this` from a member function does not narrow `this`

Open
#44,212 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

In Discussion Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Bug Report

🔎 Search Terms
  • assert type guard
  • this type guard

possibly related to #43368

🕗 Version & Regression Information

Seems to effect all versions

⏯ Playground Link

Playground link with relevant code

💻 Code
/* Setup */
class SuccessResult<T> {
  success: true = true;
  constructor(public value: T) {}
  throwOnFailure(): asserts this is SuccessResult<T> {}
  isSuccess(): this is SuccessResult<T> {
    return this.success;
  }
}

class FailureResult<T, E extends Error> {
  success: false = false;
  constructor(public error: E) {}
  throwOnFailure(): asserts this is SuccessResult<T> {
    throw this.error;
  }
  isSuccess(): this is SuccessResult<T> {
    return this.success;
  }
}

type OperationResult<T = never, E extends Error = Error> =
  | SuccessResult<T>
  | FailureResult<T, E>;

function workingAssertGuard<T>(result: OperationResult<T>): asserts result is SuccessResult<T> {
  if (!result.success){
    throw result.error
  }
}
/* End Setup */



const result: OperationResult<string> = {} as OperationResult<string>

/* This is the issue */
function assertThisType(){
  result.throwOnFailure()
  // type is unchanged
  result // OperationResult<string, Error>
}
/* End of issue */


/* The rest below works as intended */
function narrowOnProperty(){
  // Working narrowing from prop
  if (result.success){
    result.value // SuccessResult<string>
  } else {
    result.error // FailureResult<string, Error>
  }

}

function assertTypeGuard(){

  // Working narrowing from Assert Type Guard Function 
  workingAssertGuard(result)
  result.value // SuccessResult<string>

}

function narrowThisTypeGuard(){
 // Working narrowing from boolean Type Guard Member Function 
    if (result.isSuccess()) {
    result.value // SuccessResult<string>
  } else {
    result.error // FailureResult<string, Error>
  }
}
🙁 Actual behavior

Asserts on this from a member function does not narrow this

🙂 Expected behavior

Asserts on this from a member function does narrow this

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 with the linked TypeScript Playground reproduction and compare the member-function assertion with the working standalone assertion and boolean type-guard examples. Done means an assertion on this narrows the result to the asserted type after the member function call, with the behavior covered by an appropriate compiler test.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.