microsoft / microsoft/TypeScript

Cannot assign to ... because it is a read-only property when using type guard in ctor

オープン
#37,823 コメント 4 件 リアクション 2 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Bug Domain: classes Help Wanted
主要言語
Go
スター
111k
フォーク
14.4k
平均マージ
1日 19時間
マージ済み PR(30日)
117

説明

A common pattern is declaring narrower types for members in derived classes. However, when combined with type guards, assignement to readonly members fails with an unexpected "Cannot assign to ... because it is a read-only property" error.

TypeScript Version: 3.7.2

Search Terms:
class member read-only property type narrowing covariant type guard

Code

class Foo {
    public readonly x: string | number;

    constructor() {
        if (isBar(this))
            // error TS2540: Cannot assign to 'x' because it is a read-only property.
            this.x = 'string';
        else
            // no error here
            this.x = 123;
    }
}

class Bar extends Foo {
    // Declare narrower type for member in derived class
    public readonly x: string;
}

function isBar(foo: Foo): foo is Bar {
    return foo instanceof Bar;
}

Expected behavior:

Assignment to this.x should be allowed with or without type guard in the constructor

Actual behavior:

error TS2540: Cannot assign to 'x' because it is a read-only property.

Playground Link:

https://www.typescriptlang.org/play/?ssl=2&ssc=1&pln=22&pc=1#code/FAYwNghgzlAEBiB7RsDexadgBwK4CMwBLEWAJwFMIATRAOzAE9YAPALligBcyi6BzWAB9YdXAFt8FMgG5gGLCHrcyuEF0RkAFAEo0CrFiIAzWFqJQAQhG1cAFhZ06Dh1wHo3saWU2wAKgDKAEwArAAsAAwcAMIQdHSIXLDQUET8dLAasADkLNmwUiAQuFAUsERJFsnkVNQAtPRMOD7Y0lyMAHQurlj2Fh0ssAC8sACMQQDMcj2YFGCl3TMeoijevnbSFIs9fVADw2OT01gAvsBnoJAwsNZkXixcFHTUcEgo6IZ4hCQ1NI3M7E4PD4-DkF2MuDo6iI9HKVhsWmMyA4bx0HCRKCqt30hkoXFwZAyGPKdG4cRAFEQpluYOAQA

Related Issues:

It is as if the type guard creates an invisible alias (cf https://github.com/microsoft/TypeScript/issues/14241), and asignment inside the type guard fails.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、リンク先の Playground で TypeScript 3.7.2 の例を再現し、guarded assignment と unguarded assignment を比較します。次に、コンパイラーの型ガードと readonly プロパティのチェックを追跡し、その後、例の回帰テストを追加します。両方のコンストラクター代入が TS2540 を発生させずに受け入れられれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
compilers
issue の種類
バグ
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。