From 2a08bfbcc62754debdcbdb2cec4962ca7352be39 Mon Sep 17 00:00:00 2001 From: Samuel Attard Date: Wed, 15 May 2019 18:20:37 -0700 Subject: [PATCH] docs: update type for responseHeaders in the webRequest module (#18302) Fixes #18298 --- docs/api/web-request.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/api/web-request.md b/docs/api/web-request.md index d255bf43ed..a17b121d32 100644 --- a/docs/api/web-request.md +++ b/docs/api/web-request.md @@ -131,11 +131,11 @@ response are visible by the time this listener is fired. * `timestamp` Double * `statusLine` String * `statusCode` Integer - * `responseHeaders` Object + * `responseHeaders` Record (Optional) * `callback` Function * `response` Object * `cancel` Boolean (optional) - * `responseHeaders` Object (optional) - When provided, the server is assumed + * `responseHeaders` Record (optional) - When provided, the server is assumed to have responded with these headers. * `statusLine` String (optional) - Should be provided when overriding `responseHeaders` to change header status otherwise original response @@ -160,7 +160,7 @@ The `callback` has to be called with an `response` object. * `resourceType` String * `referrer` String * `timestamp` Double - * `responseHeaders` Object + * `responseHeaders` Record (Optional) * `fromCache` Boolean - Indicates whether the response was fetched from disk cache. * `statusCode` Integer @@ -189,7 +189,7 @@ and response headers are available. * `ip` String (optional) - The server IP address that the request was actually sent to. * `fromCache` Boolean - * `responseHeaders` Object + * `responseHeaders` Record (Optional) The `listener` will be called with `listener(details)` when a server initiated redirect is about to occur. @@ -208,7 +208,7 @@ redirect is about to occur. * `resourceType` String * `referrer` String * `timestamp` Double - * `responseHeaders` Object + * `responseHeaders` Record (Optional) * `fromCache` Boolean * `statusCode` Integer * `statusLine` String