Addressed all comments

sindresorhus · May 18, 2022 · 5344340 · 5344340
1 parent b8572e7
commit 5344340
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 4 deletions.
diff --git a/documentation/3-streams.md b/documentation/3-streams.md
@@ -354,6 +354,15 @@ The server's IP address.
 
 Whether the response comes from cache or not.
 
+### `ok`
+
+**Type: `boolean`**
+
+**Note:**
+> - This property need not be checked if throwHttpErrors is true.
+
+Whether the response was successful (status code in the range 200-299).
+
 ### `statusCode`
 
 **Type: `number`**

diff --git a/source/core/index.ts b/source/core/index.ts
@@ -633,7 +633,7 @@ export default class Request extends Duplex implements RequestEvents<Request> {
 		typedResponse.isFromCache = (this._nativeResponse as any).fromCache ?? false;
 		typedResponse.ip = this.ip;
 		typedResponse.retryCount = this.retryCount;
-		typedResponse.ok = (statusCode >= 200 && statusCode <= 299);
+		typedResponse.ok = isResponseOk(typedResponse);
 
 		this._isFromCache = typedResponse.isFromCache;
 

diff --git a/source/core/response.ts b/source/core/response.ts
@@ -93,9 +93,10 @@ export interface PlainResponse extends IncomingMessageWithTimings {
 	body?: unknown;
 
 	/**
-	Whether the response status code is 2xx.
+	Whether the response was successful (status code in the range 200-299).
+	This property need not be checked if throwHttpErrors is true.
 	*/
-	ok?: boolean;
+	ok: boolean;
 }
 
 // For Promise support

diff --git a/test/http.ts b/test/http.ts
@@ -385,7 +385,7 @@ test('status code 200 has response ok is true', withServer, async (t, server, go
 	const promise = got('');
 	await t.notThrowsAsync(promise);
 	const {statusCode, body, ok} = await promise;
-	t.is(ok, true);
+	t.true(ok);
 	t.is(statusCode, 200);
 	t.is(body, '');
 });