Skip to content

Commit

Permalink
doc: improve doc Http2Session:Timeout
Browse files Browse the repository at this point in the history
Add line in doc/http2.md for 'timeout' event which tell readers
that 'timeout' event doesn't except any arguments.

Refs: nodejs/help#877
PR-URL: #30161
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: David Carlier <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
  • Loading branch information
dev-script authored and targos committed Nov 11, 2019
1 parent b88314f commit 7b50474
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions doc/api/http2.md
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,7 @@ added: v8.4.0
After the `http2session.setTimeout()` method is used to set the timeout period
for this `Http2Session`, the `'timeout'` event is emitted if there is no
activity on the `Http2Session` after the configured number of milliseconds.
Its listener does not expect any arguments.

```js
session.setTimeout(2000);
Expand Down

0 comments on commit 7b50474

Please sign in to comment.