Browse Source

docs: update type for responseHeaders in the webRequest module (#18302)

Fixes #18298
Samuel Attard 6 years ago
parent
commit
2a08bfbcc6
1 changed files with 5 additions and 5 deletions
  1. 5 5
      docs/api/web-request.md

+ 5 - 5
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<string, string> (Optional)
   * `callback` Function
     * `response` Object
       * `cancel` Boolean (optional)
-      * `responseHeaders` Object (optional) - When provided, the server is assumed
+      * `responseHeaders` Record<string, string> (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<string, string> (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<string, string> (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<string, string> (Optional)
     * `fromCache` Boolean
     * `statusCode` Integer
     * `statusLine` String