From 119f83bb44665816a7d2e434988d36e4613c4dd8 Mon Sep 17 00:00:00 2001 From: Ruben Bridgewater Date: Sun, 24 Mar 2019 23:37:12 +0100 Subject: [PATCH] doc: mark settings as optional and add callback The settings are currently not required and the callback was not documented so far. Refs: https://github.com/nodejs/node/pull/26811 PR-URL: https://github.com/nodejs/node/pull/26894 Refs: https://github.com/nodejs/node/pull/26811 Reviewed-By: James M Snell Reviewed-By: Luigi Pinca --- doc/api/http2.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/api/http2.md b/doc/api/http2.md index 0f28124881f4a3..04a4972de785d2 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -572,12 +572,17 @@ Provides miscellaneous information about the current state of the An object describing the current status of this `Http2Session`. -#### http2session.settings(settings) +#### http2session.settings([settings][, callback]) * `settings` {HTTP/2 Settings Object} +* `callback` {Function} Callback that is called once the session is connected or + right away if the session is already connected. + * `err` {Error|null} + * `settings` {HTTP/2 Settings Object} The updated `settings` object. + * `duration` {integer} Updates the current local settings for this `Http2Session` and sends a new `SETTINGS` frame to the connected HTTP/2 peer. @@ -2232,7 +2237,7 @@ Returns an object containing the default settings for an `Http2Session` instance. This method returns a new object instance every time it is called so instances returned may be safely modified for use. -### http2.getPackedSettings(settings) +### http2.getPackedSettings([settings])