fetchData

Requires a Node.js runtime ('qsu/node')

This function is used to make node:fetch easier to use while ensuring data is returned regardless of the response status. By default, it uses the GET method, but other methods such as POST can also be used with separate options.

Depending on the Content-Type of the request URL, the returned data can be either a string or an object.

If the request fails, returns a 204 (No Content) status code, or an error occurs, it returns nullNone without throwing a separate exception.

However, you can receive error details via the onError event.

Parameters

Name	Type	Required	Default
url	stringstr	●	–
httpRequestOptions	HTTPRequestOption	–	–
Request options. See the table below.

HTTPRequestOption

Name	Type	Required	Default
auth	objectdict	–	–
Authentication credentials. See the table below.
get	booleanbool	–	–
Same as method: 'get'
post	booleanbool	–	–
Same as method: 'post'
put	booleanbool	–	–
Same as method: 'put'
delete	booleanbool	–	–
Same as method: 'delete'
patch	booleanbool	–	–
Same as method: 'patch'
toStream	booleanbool	–	–
timeout	numberint	–	–
method	'get' | 'post' | 'put' | 'delete' | 'patch'	–	–
host	stringstr	–	–
If this value is not specified, the URL must be a full path.
queryParameters	objectdict	–	–
body	object | string | FormData | nulldict | str | FormData | None	–	–
bodyType	'text' | 'json' | 'form-data' | 'x-www-form-urlencoded'	–	–
headers	object | nulldict | None	–	–
onError	functionCallable	–	–
(error) => void

auth

Name	Type	Required	Default
apiKey	stringstr	–	–
'x-API-key' header
bearer	stringstr	–	–
'Authorization Bearer' header

Returns

Promise<string | object | null>

str | dict | None

Examples

console.log(await fetchData('https://github.com'), { get: true });

print(fetchData('https://github.com'), { 'get': True })