Wrong default value on responseType parameter in Request Config document

[yunnysunny]

Section/Content To Improve

https://github.com/axios/axios?tab=readme-ov-file#request-config
The default value of responseType is json. But I found the default object defined in https://github.com/axios/axios/blob/v1.x/lib/defaults/index.js has no responseType, in other words, the responseType value is undefined.

Suggested Improvement

In node adapter, the default response format is data string when request with data: schema or string when request with normal schema; and in browser adapter, it will been returned in string format default.

axios/lib/adapters/http.js

Lines 221 to 263 in d844227

	// Parse url
	const fullPath = buildFullPath(config.baseURL, config.url);
	const parsed = new URL(fullPath, 'http://localhost');
	const protocol = parsed.protocol || supportedProtocols[0];
	if (protocol === 'data:') {
	let convertedData;
	if (method !== 'GET') {
	return settle(resolve, reject, {
	status: 405,
	statusText: 'method not allowed',
	headers: {},
	config
	});
	}
	try {
	convertedData = fromDataURI(config.url, responseType === 'blob', {
	Blob: config.env && config.env.Blob
	});
	} catch (err) {
	throw AxiosError.from(err, AxiosError.ERR_BAD_REQUEST, config);
	}
	if (responseType === 'text') {
	convertedData = convertedData.toString(responseEncoding);
	if (!responseEncoding || responseEncoding === 'utf8') {
	convertedData = utils.stripBOM(convertedData);
	}
	} else if (responseType === 'stream') {
	convertedData = stream.Readable.from(convertedData);
	}
	return settle(resolve, reject, {
	data: convertedData,
	status: 200,
	statusText: 'OK',
	headers: new AxiosHeaders(),
	config
	});
	}

axios/lib/adapters/http.js

Lines 535 to 591 in d844227

	if (responseType === 'stream') {
	response.data = responseStream;
	settle(resolve, reject, response);
	} else {
	const responseBuffer = [];
	let totalResponseBytes = 0;
	responseStream.on('data', function handleStreamData(chunk) {
	responseBuffer.push(chunk);
	totalResponseBytes += chunk.length;
	// make sure the content length is not over the maxContentLength if specified
	if (config.maxContentLength > -1 && totalResponseBytes > config.maxContentLength) {
	// stream.destroy() emit aborted event before calling reject() on Node.js v16
	rejected = true;
	responseStream.destroy();
	reject(new AxiosError('maxContentLength size of ' + config.maxContentLength + ' exceeded',
	AxiosError.ERR_BAD_RESPONSE, config, lastRequest));
	}
	});
	responseStream.on('aborted', function handlerStreamAborted() {
	if (rejected) {
	return;
	}
	const err = new AxiosError(
	'maxContentLength size of ' + config.maxContentLength + ' exceeded',
	AxiosError.ERR_BAD_RESPONSE,
	config,
	lastRequest
	);
	responseStream.destroy(err);
	reject(err);
	});
	responseStream.on('error', function handleStreamError(err) {
	if (req.destroyed) return;
	reject(AxiosError.from(err, null, config, lastRequest));
	});
	responseStream.on('end', function handleStreamEnd() {
	try {
	let responseData = responseBuffer.length === 1 ? responseBuffer[0] : Buffer.concat(responseBuffer);
	if (responseType !== 'arraybuffer') {
	responseData = responseData.toString(responseEncoding);
	if (!responseEncoding || responseEncoding === 'utf8') {
	responseData = utils.stripBOM(responseData);
	}
	}
	response.data = responseData;
	} catch (err) {
	return reject(AxiosError.from(err, null, config, response.request, response));
	}
	settle(resolve, reject, response);
	});
	}

axios/lib/adapters/xhr.js

Lines 100 to 101 in d844227

	const responseData = !responseType || responseType === 'text' || responseType === 'json' ?
	request.responseText : request.response;

Relevant File(s)

README.md
lib/defaults/index.js
lib/adapters/http.js
lib/adapters/xhr.js