TypeScriptのイタレータの型について

Question

以下のSymbolメソッドの部分で方のエラーが出てしまいます
どのように修正するのがいいでしょうか？
たしかに//typescript/lib/lib.es2015.iterable.d.ts内のイタレーターの型を確認しても
Symbol.iteratorやnextメソッドの内容に互換性がないということにはならないのでは？と思っています。
特にわからないのは以下の、エラーメッセージの最後の部分です。このメッセージが出てくる原因は何でしょうか？
「プロパティ 'done' の型に互換性がありません。
型 'boolean' を型 'true' に割り当てることはできません。」

class Users implements Iterable<object[]> {
  Users: object[]
  constructor(users: object[]) {
    this.Users = users
  }
  [Symbol.iterator]() { // Error
    let i = 0
    let users = this.Users
    return {
      next() {
        if (i < users.length) {
          return { done: false, value: users[i++] }
        }
        return { done: true }
      },
    }
  }
}

const allUsers = new Users([
  { name: 'Tanaka' },
  { name: 'Suzuki' },
  { name: 'Yamada' },
])

for (const u of allUsers) {
  console.log(u.name)
}

型 'Users' のプロパティ '[Symbol.iterator]' を基本データ型 'Iterable<object[]>' の同じプロパティに割り当てることはできません。
  型 '() => { next(): { done: boolean; value: object; } | { done: boolean; value?: undefined; }; }' を型 '() => Iterator<object[], any, undefined>' に割り当てることはできません。
    型 '{ next(): { done: boolean; value: object; } | { done: boolean; value?: undefined; }; }' を型 'Iterator<object[], any, undefined>' に割り当てることはできません。
      プロパティ 'next' の型に互換性がありません。
        型 '() => { done: boolean; value: object; } | { done: boolean; value?: undefined; }' を型 '(...args: [] | [undefined]) => IteratorResult<object[], any>' に割り当てることはできません。
          型 '{ done: boolean; value: object; } | { done: boolean; value?: undefined; }' を型 'IteratorResult<object[], any>' に割り当てることはできません。
            型 '{ done: boolean; value: object; }' を型 'IteratorResult<object[], any>' に割り当てることはできません。
              型 '{ done: boolean; value: object; }' を型 'IteratorReturnResult<any>' に割り当てることはできません。
                プロパティ 'done' の型に互換性がありません。
                  型 'boolean' を型 'true' に割り当てることはできません。ts(2416)

Answer 1

こんにちは。
一例としまして、以下のような感じかなと思います。

$ ls -l

total 16
-rw-r--r-- 1 jun68ykt staff 442 11 24 18:51 test.ts
-rw-r--r-- 1 jun68ykt staff 297 11 24 18:51 tsconfig.json
$ node -v
v12.13.0
$ tsc -v
Version 3.7.2
$ **cat tsconfig.json **

{
  "compilerOptions": {
    "target": "ES5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "forceConsistentCasingInFileNames": true,
    "lib": [
      "dom",
      "es2015",
      "scripthost",
      "es2015.iterable"
    ],
    "downlevelIteration": true
  }
}

$ cat test.ts

interface User { name: string }

class Users implements Iterable<User> {

  constructor(private users: User[]) {}

  [Symbol.iterator](): Iterator<User> {
    let i = 0
    return {
      next: () => ({
        done: i >= this.users.length,
        value: this.users[i ++]
      })
    }
  }
}

const allUsers = new Users([
  { name: 'Tanaka' },
  { name: 'Suzuki' },
  { name: 'Yamada' }
])

for (const u of allUsers) {
  console.log(u.name)
}

$ tsc

$ ls -l test.*
-rw-r--r-- 1 jun68ykt staff 1421 11 24 18:52 test.js
-rw-r--r-- 1 jun68ykt staff 442 11 24 18:51 test.ts
$ node test.js
Tanaka
Suzuki
Yamada
$

参考になれば幸いです。

Comments

[TOMIYASU_chan]

ありがとうございました。
[Symbol.iterator]()の返り値の型の部分を追加することで
エラーが出なくなりました。なるほどと思いました。
ここにその型を示してやらなかったためどのようなものを返してもエラーになりえますね。また返り値の型にIterator<User>を指定したためにnextメソッドの返すイタレーターオブジェクトも{ done: true }では型に合わないため、
{ done: true, value: null }に変更しました

また自分の環境を記述すべきでした

[jun68ykt]

どういたしまして。解決されたようで、よかったです 。