Update docs for response.ok

sindresorhus · May 19, 2022 · 249dc9a · 249dc9a
1 parent 0781198
commit 249dc9a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/documentation/3-streams.md b/documentation/3-streams.md
@@ -358,11 +358,14 @@ Whether the response comes from cache or not.
 
 **Type: `boolean`**
 
+Whether the response was successful
+
 **Note:**
+> - A request is successful when the status code of the final request is `2xx` or `3xx`.
+> - When [following redirects](2-options.md#followredirect), a request is successful **only** when the status code of the final request is `2xx`.
+> - `304` responses are always considered successful.
 > - Got throws automatically when `response.ok` is `false` and `throwHttpErrors` is `true`.
 
-Whether the response was successful (status code in the range 200-299).
-
 ### `statusCode`
 
 **Type: `number`**

diff --git a/source/core/response.ts b/source/core/response.ts
@@ -93,8 +93,9 @@ export interface PlainResponse extends IncomingMessageWithTimings {
 	body?: unknown;
 
 	/**
-	Whether the response was successful (status code in the range 200-299).
-	This property need not be checked if throwHttpErrors is true.
+	Whether the response was successful.
+
+	__Note__: Got throws automatically when `response.ok` is `false` and `throwHttpErrors` is `true`.
 	*/
 	ok: boolean;
 }