| 
									
										
										
										
											2019-06-28 16:25:30 +09:00
										 |  |  | # ProtocolResponse Object
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | * `error` Integer (optional) - When assigned, the `request` will fail with the | 
					
						
							|  |  |  |   `error` number . For the available error numbers you can use, please see the | 
					
						
							|  |  |  |   [net error list][net-error]. | 
					
						
							|  |  |  | * `statusCode` Number (optional) - The HTTP response code, default is 200. | 
					
						
							|  |  |  | * `charset` String (optional) - The charset of response body, default is | 
					
						
							|  |  |  |   `"utf-8"`. | 
					
						
							|  |  |  | * `mimeType` String (optional) - The MIME type of response body, default is | 
					
						
							|  |  |  |   `"text/html"`. Setting `mimeType` would implicitly set the `content-type` | 
					
						
							|  |  |  |   header in response, but if `content-type` is already set in `headers`, the | 
					
						
							|  |  |  |   `mimeType` would be ignored. | 
					
						
							|  |  |  | * `headers` Record<string, string | string[]> (optional) - An object containing the response headers. The | 
					
						
							|  |  |  |   keys must be String, and values must be either String or Array of String. | 
					
						
							|  |  |  | * `data` (Buffer | String | ReadableStream) (optional) - The response body. When | 
					
						
							|  |  |  |   returning stream as response, this is a Node.js readable stream representing | 
					
						
							|  |  |  |   the response body. When returning `Buffer` as response, this is a `Buffer`. | 
					
						
							|  |  |  |   When returning `String` as response, this is a `String`. This is ignored for | 
					
						
							|  |  |  |   other types of responses. | 
					
						
							|  |  |  | * `path` String (optional) - Path to the file which would be sent as response | 
					
						
							|  |  |  |   body. This is only used for file responses. | 
					
						
							|  |  |  | * `url` String (optional) - Download the `url` and pipe the result as response | 
					
						
							|  |  |  |   body. This is only used for URL responses. | 
					
						
							|  |  |  | * `referrer` String (optional) - The `referrer` URL. This is only used for file | 
					
						
							|  |  |  |   and URL responses. | 
					
						
							|  |  |  | * `method` String (optional) - The HTTP `method`. This is only used for file | 
					
						
							|  |  |  |   and URL responses. | 
					
						
							|  |  |  | * `session` Session (optional) - The session used for requesting URL, by default | 
					
						
							|  |  |  |   the HTTP request will reuse the current session. Setting `session` to `null` | 
					
						
							|  |  |  |   would use a random independent session. This is only used for URL responses. | 
					
						
							| 
									
										
										
										
											2019-06-29 03:19:01 +09:00
										 |  |  | * `uploadData` ProtocolResponseUploadData (optional) - The data used as upload data. This is only | 
					
						
							| 
									
										
										
										
											2019-06-28 16:25:30 +09:00
										 |  |  |   used for URL responses when `method` is `"POST"`. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | [net-error]: https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h |