Skip to content

Commit

Permalink
fix(doctest): doctest:async:1000 で非同期テストをサポート
Browse files Browse the repository at this point in the history
  • Loading branch information
azu committed Oct 17, 2018
1 parent 2a8994a commit 6c076c2
Show file tree
Hide file tree
Showing 5 changed files with 236 additions and 76 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,27 @@ Doctestの正常系は実行結果と期待結果が一致することです。
NO_DEFINE++; // => ReferenceError
```

#### Doctest非同期のテスト

DoctestでPromiseやAsync Functionを使った非同期のテストも書けます。
非同期処理を期待する場合は、`doctest:async:タイムアウトミリ秒`をHTMLコメントに書きます。

例) 実行結果が`1000`ミリ秒以内に完了する非同期処理をテストする

<!-- doctest:async:1000 -->
```js
function wait(ms){
return new Promise((resolve) => {
setTimeout(() => resolve(ms), ms)
})
}
wait(1000).then(() => {
console.log(value); // => 1000
});
```

Note: `vm`モジュールの制約からタイムアウト指定の時間が正しく指定させていることが前提となっています。

#### Doctestの無視

CodeBlockの手前に`<!-- doctest:disable -->`というHTMLコメントがある場合はDoctestをしません。
Expand Down
Loading

0 comments on commit 6c076c2

Please sign in to comment.