Major refactoring (#921)

sindresorhus · Nov 16, 2019 · 518f0f5 · 518f0f5
1 parent 13c0990
commit 518f0f5
Show file tree

Hide file tree

Showing 42 changed files with 1,345 additions and 1,110 deletions.
diff --git a/documentation/advanced-creation.md b/documentation/advanced-creation.md
@@ -2,119 +2,6 @@
 
 > Make calling REST APIs easier by creating niche-specific `got` instances.
 
-#### got.create(settings)
-
-Example: [gh-got](https://github.com/sindresorhus/gh-got/blob/master/index.js)
-
-Configures a new `got` instance with the provided settings. You can access the resolved options with the `.defaults` property on the instance.
-
-**Note:** In contrast to [`got.extend()`](../readme.md#gotextendinstances), this method has no defaults.
-
-##### [options](readme.md#options)
-
-To inherit from the parent, set it to `got.defaults.options` or use [`got.mergeOptions(defaults.options, options)`](../readme.md#gotmergeoptionsparentoptions-newoptions).<br>
-**Note:** Avoid using [object spread](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_syntax#Spread_in_object_literals) as it doesn't work recursively.
-
-##### mutableDefaults
-
-Type: `boolean`<br>
-Default: `false`
-
-States if the defaults are mutable. It can be useful when you need to [update headers over time](readme.md#hooksafterresponse), for example, update an access token when it expires.
-
-##### handlers
-
-Type: `Function[]`<br>
-Default: `[]`
-
-An array of functions. You execute them directly by calling `got()`. They are some sort of "global hooks" - these functions are called first. The last handler (*it's hidden*) is either [`asPromise`](../source/as-promise.ts) or [`asStream`](../source/as-stream.ts), depending on the `options.stream` property.
-
-To inherit from the parent, set it as `got.defaults.handlers`.<br>
-To use the default handler, just omit specifying this.
-
-Each handler takes two arguments:
-
-###### [options](readme.md#options)
-
-**Note:** These options are [normalized](source/normalize-arguments.js).
-
-###### next()
-
-Returns a `Promise` or a `Stream` depending on [`options.stream`](readme.md#stream).
-
-```js
-const settings = {
-	handlers: [
-		(options, next) => {
-			if (options.stream) {
-				// It's a Stream, so we can perform stream-specific actions on it
-				return next(options)
-					.on('request', request => {
-						setTimeout(() => {
-							request.abort();
-						}, 50);
-					});
-			}
-
-			// It's a Promise
-			return next(options);
-		}
-	],
-	options: got.mergeOptions(got.defaults.options, {
-		responseType: 'json'
-	})
-};
-
-const jsonGot = got.create(settings);
-```
-
-Sometimes you don't need to use `got.create(defaults)`. You should go for `got.extend(options)` if you don't want to overwrite the defaults:
-
-```js
-const settings = {
-	handler: got.defaults.handler,
-	options: got.mergeOptions(got.defaults.options, {
-		headers: {
-			unicorn: 'rainbow'
-		}
-	})
-};
-
-const unicorn = got.create(settings);
-
-// Same as:
-const unicorn = got.extend({headers: {unicorn: 'rainbow'}});
-```
-
-**Note:** Handlers can be asynchronous. The recommended approach is:
-
-```js
-const handler = (options, next) => {
-	if (options.stream) {
-		// It's a Stream
-		return next(options);
-	}
-
-	// It's a Promise
-	return (async () => {
-		try {
-			const response = await next(options);
-
-			response.yourOwnProperty = true;
-
-			return response;
-		} catch (error) {
-			// Every error will be replaced by this one.
-			// Before you receive any error here,
-			// it will be passed to the `beforeError` hooks first.
-
-			// Note: this one won't be passed to `beforeError` hook. It's final.
-			throw new Error('Your very own error.');
-		}
-	})();
-};
-```
-
 ### Merging instances
 
 Got supports composing multiple instances together. This is very powerful. You can create a client that limits download speed and then compose it with an instance that signs a request. It's like plugins without any of the plugin mess. You just create instances and then compose them together.

diff --git a/documentation/examples/gh-got.js b/documentation/examples/gh-got.js
@@ -24,7 +24,7 @@ const instance = got.extend({
 			}
 
 			// Don't touch streams
-			if (options.stream) {
+			if (options.isStream) {
 				return next(options);
 			}
 

diff --git a/documentation/lets-make-a-plugin.md b/documentation/lets-make-a-plugin.md
@@ -128,7 +128,7 @@ We should name our errors, just to know if the error is from the API response. S
 			}
 
 			// Don't touch streams
-			if (options.stream) {
+			if (options.isStream) {
 				return next(options);
 			}
 
@@ -197,7 +197,7 @@ const getRateLimit = ({headers}) => ({
 			}
 
 			// Don't touch streams
-			if (options.stream) {
+			if (options.isStream) {
 				return next(options);
 			}