Major refactoring

readme.md

@@ -242,11 +242,11 @@ const instance = got.extend({
 ###### responseType
 
 Type: `string`<br>
-Default: `text`
+Default: `'default'`
 
 **Note:** When using streams, this option is ignored.
 
-Parsing method used to retrieve the body from the response. Can be `text`, `json` or `buffer`. The promise has `.json()` and `.buffer()` and `.text()` functions which set this option automatically.
+Parsing method used to retrieve the body from the response. Can be `'default'`, `'text'`, `'json'` or `'buffer'`. The promise has `.json()` and `.buffer()` and `.text()` functions which set this option automatically.
 
 Example:
 

source/as-promise.ts

@@ -21,7 +21,7 @@ const parseBody = (body: Response['body'], responseType: NormalizedOptions['resp
 		return body.toString();
 	}
 
-	if (responseType === '') {
+	if (responseType === 'default') {
 		return body;
 	}
 

source/create.ts

@@ -1,3 +1,4 @@
+import {Merge} from 'type-fest';
 import * as errors from './errors';
 import {
 	Options,
@@ -23,13 +24,34 @@ export type HTTPAlias =
 	| 'head'
 	| 'delete';
 
-export type ReturnResponse = (url: URLOrOptions | Options & {isStream?: false}, options?: Options & {isStream?: false}) => CancelableRequest<Response>;
 export type ReturnStream = (url: URLOrOptions | Options & {isStream: true}, options?: Options & {isStream: true}) => ProxyStream;
 export type GotReturn = ProxyStream | CancelableRequest<Response>;
 
 const getPromiseOrStream = (options: NormalizedOptions): GotReturn => options.isStream ? asStream(options) : asPromise(options);
 
-export interface Got extends Record<HTTPAlias, ReturnResponse> {
+type OptionsOfDefaultResponseBody = Options & {isStream?: false; resolveBodyOnly?: false; responseType?: 'default'};
+type OptionsOfTextResponseBody = Options & {isStream?: false; resolveBodyOnly?: false; responseType: 'text'};
+type OptionsOfJSONResponseBody = Options & {isStream?: false; resolveBodyOnly?: false; responseType: 'json'};
+type OptionsOfBufferResponseBody = Options & {isStream?: false; resolveBodyOnly?: false; responseType: 'buffer'};
+type BodyOnly = {resolveBodyOnly: true};
+
+interface GotFunctions {
+	// `asPromise` usage
+	(url: URLOrOptions | OptionsOfDefaultResponseBody, options?: OptionsOfDefaultResponseBody): CancelableRequest<Response>;
+	(url: URLOrOptions | OptionsOfTextResponseBody, options?: OptionsOfTextResponseBody): CancelableRequest<Response<string>>;
+	(url: URLOrOptions | OptionsOfJSONResponseBody, options?: OptionsOfJSONResponseBody): CancelableRequest<Response<object>>;
+	(url: URLOrOptions | OptionsOfBufferResponseBody, options?: OptionsOfBufferResponseBody): CancelableRequest<Response<Buffer>>;
+
+	(url: URLOrOptions | OptionsOfDefaultResponseBody & BodyOnly, options?: OptionsOfDefaultResponseBody & BodyOnly): CancelableRequest<any>;
+	(url: URLOrOptions | OptionsOfTextResponseBody & BodyOnly, options?: OptionsOfTextResponseBody & BodyOnly): CancelableRequest<string>;
+	(url: URLOrOptions | OptionsOfJSONResponseBody & BodyOnly, options?: OptionsOfJSONResponseBody & BodyOnly): CancelableRequest<object>;
+	(url: URLOrOptions | OptionsOfBufferResponseBody & BodyOnly, options?: OptionsOfBufferResponseBody & BodyOnly): CancelableRequest<Buffer>;
+
+	// `asStream` usage
+	(url: URLOrOptions | Options & {isStream: true}, options?: Options & {isStream: true}): ProxyStream;
+}
+
+export interface Got extends Merge<Record<HTTPAlias, GotFunctions>, GotFunctions> {
 	stream: GotStream;
 	defaults: Defaults | Readonly<Defaults>;
 	GotError: typeof errors.GotError;
@@ -43,9 +65,6 @@ export interface Got extends Record<HTTPAlias, ReturnResponse> {
 	TimeoutError: typeof errors.TimeoutError;
 	CancelError: typeof errors.CancelError;
 
-	(url: URLOrOptions | Options & {isStream?: false}, options?: Options & {isStream?: false}): CancelableRequest<Response>;
-	(url: URLOrOptions | Options & {isStream: true}, options?: Options & {isStream: true}): ProxyStream;
-	(url: URLOrOptions, options?: Options): CancelableRequest<Response> | ProxyStream;
 	extend(...instancesOrOptions: Array<Got | ExtendedOptions>): Got;
 	mergeInstances(parent: Got, ...instances: Got[]): Got;
 	mergeOptions<T extends Options>(...sources: T[]): T & {hooks: Partial<Hooks>};
@@ -149,7 +168,8 @@ const create = (defaults: Defaults): Got => {
 	got.stream = (url, options) => got(url, {...options, isStream: true});
 
 	for (const method of aliases) {
-		got[method] = (url, options) => got(url, {...options, method});
+		// @ts-ignore
+		got[method] = (url: URLOrOptions, options?: Options): GotReturn => got(url, {...options, method});
 		got.stream[method] = (url, options) => got.stream(url, {...options, method});
 	}
 

source/index.ts

@@ -53,7 +53,7 @@ const defaults: Defaults = {
 		cache: false,
 		dnsCache: false,
 		useElectronNet: false,
-		responseType: '',
+		responseType: 'default',
 		resolveBodyOnly: false,
 		maxRedirects: 10,
 		prefixUrl: ''
@@ -76,7 +76,6 @@ export * from './utils/types';
 export {
 	Got,
 	GotStream,
-	ReturnResponse,
 	ReturnStream,
 	GotReturn
 } from './create';

source/progress.ts

@@ -2,6 +2,7 @@ import {ClientRequest} from 'http';
 import {Transform as TransformStream} from 'stream';
 import {Socket} from 'net';
 import EventEmitter = require('events');
+import is from '@sindresorhus/is';
 
 export function downloadProgress(emitter: EventEmitter, downloadBodySize?: number): TransformStream {
 	let downloadedBytes = 0;
@@ -71,6 +72,19 @@ export function uploadProgress(request: ClientRequest, emitter: EventEmitter, up
 		const onSocketConnect = (): void => {
 			progressInterval = setInterval(() => {
 				const lastUploadedBytes = uploadedBytes;
+
+				/* istanbul ignore next: future versions of Node may not have this property */
+				if (!is.string((request as any)._header)) {
+					clearInterval(progressInterval);
+
+					const url = new URL('https://github.com/sindresorhus/got/issues/new');
+					url.searchParams.set('title', '`request._header` is not present');
+					url.searchParams.set('body', 'It causes `uploadProgress` to fail.');
+
+					console.warn('`request._header` is not present. Please report this as a bug:\n' + url.href);
+					return;
+				}
+
 				const headersSize = Buffer.byteLength((request as any)._header);
 				uploadedBytes = socket.bytesWritten - headersSize;
 

source/utils/types.ts

@@ -43,10 +43,10 @@ export type ErrorCode =
 	| 'ENETUNREACH'
 	| 'EAI_AGAIN';
 
-export type ResponseType = 'json' | 'buffer' | 'text' | '';
+export type ResponseType = 'json' | 'buffer' | 'text' | 'default';
 
-export interface Response extends http.IncomingMessage {
-	body: any;
+export interface Response<BodyType = any> extends http.IncomingMessage {
+	body: BodyType;
 	statusCode: number;
 
 	/**