@minotaur-ergo/http

@minotaur-ergo/http

Cors Free Http Client

Install

npm install @minotaur-ergo/http
npx cap sync

API

• request(...)
• get(...)
• post(...)
• put(...)
• patch(...)
• delete(...)
• Interfaces
• Type Aliases

request(...)

request(options: HttpOptions) => Promise<HttpResponse>

Param	Type
options	HttpOptions

Returns: Promise<HttpResponse>

get(...)

get(options: HttpOptions) => Promise<HttpResponse>

Param	Type
options	HttpOptions

Returns: Promise<HttpResponse>

post(...)

post(options: HttpOptions) => Promise<HttpResponse>

Param	Type
options	HttpOptions

Returns: Promise<HttpResponse>

put(...)

put(options: HttpOptions) => Promise<HttpResponse>

Param	Type
options	HttpOptions

Returns: Promise<HttpResponse>

patch(...)

patch(options: HttpOptions) => Promise<HttpResponse>

Param	Type
options	HttpOptions

Returns: Promise<HttpResponse>

delete(...)

delete(options: HttpOptions) => Promise<HttpResponse>

Param	Type
options	HttpOptions

Returns: Promise<HttpResponse>

Interfaces

HttpResponse

Prop	Type
data	any
status	number
headers	HttpHeaders
url	string

HttpHeaders

HttpOptions

Prop	Type	Description
url	string
method	string
params	HttpParams
data	any	Note: On Android and iOS, data can only be a string or a JSON. FormData, Blob, ArrayBuffer, and other complex types are only directly supported on web or through enabling CapacitorHttp in the config and using the patched window.fetch or XMLHttpRequest. If you need to send a complex type, you should serialize the data to base64 and set the headers["Content-Type"] and dataType attributes accordingly.
headers	HttpHeaders
readTimeout	number	How long to wait to read additional data. Resets each time new data is received
connectTimeout	number	How long to wait for the initial connection.
disableRedirects	boolean	Sets whether automatic HTTP redirects should be disabled
webFetchExtra	RequestInit	Extra arguments for fetch when running on the web
responseType	HttpResponseType	This is used to parse the response appropriately before returning it to the requestee. If the response content-type is "json", this value is ignored.
shouldEncodeUrlParams	boolean	Use this option if you need to keep the URL unencoded in certain cases (already encoded, azure/firebase testing, etc.). The default is true.
dataType	'file' | 'formData'	This is used if we've had to convert the data from a JS type that needs special handling in the native layer

HttpParams

Type Aliases

HttpResponseType

'arraybuffer' | 'blob' | 'json' | 'text' | 'document'