Umi — API References - v1.3.0
Preparing search index...
umi
HttpRequestBuilder
Class HttpRequestBuilder<D>
A builder for constructing
HttpRequest
instances.
Type Parameters
D
Implements
HttpRequest
<
D
>
Index
Constructors
constructor
Accessors
data
headers
max
Redirects
method
signal
timeout
url
Methods
accept
as
Form
as
Json
as
Multipart
content
Type
delete
dont
Follow
Redirects
follow
Redirects
get
patch
post
put
user
Agent
with
Abort
Signal
with
Data
with
Endpoint
with
Header
with
Headers
without
Timeout
with
Params
with
Timeout
with
Token
Constructors
constructor
new
HttpRequestBuilder
<
D
>
(
request
:
HttpRequest
<
D
>
)
:
HttpRequestBuilder
<
D
>
Type Parameters
D
Parameters
request
:
HttpRequest
<
D
>
Returns
HttpRequestBuilder
<
D
>
Accessors
data
get
data
()
:
D
Returns
D
headers
get
headers
()
:
HttpRequestHeaders
Returns
HttpRequestHeaders
max
Redirects
get
maxRedirects
()
:
undefined
|
number
Returns
undefined
|
number
method
get
method
()
:
HttpMethod
Returns
HttpMethod
signal
get
signal
()
:
undefined
|
GenericAbortSignal
Returns
undefined
|
GenericAbortSignal
timeout
get
timeout
()
:
undefined
|
number
Returns
undefined
|
number
url
get
url
()
:
string
Returns
string
Methods
accept
accept
(
contentType
:
string
)
:
HttpRequestBuilder
<
D
>
Parameters
contentType
:
string
Returns
HttpRequestBuilder
<
D
>
as
Form
asForm
()
:
HttpRequestBuilder
<
D
>
Returns
HttpRequestBuilder
<
D
>
as
Json
asJson
()
:
HttpRequestBuilder
<
D
>
Returns
HttpRequestBuilder
<
D
>
as
Multipart
asMultipart
()
:
HttpRequestBuilder
<
D
>
Returns
HttpRequestBuilder
<
D
>
content
Type
contentType
(
contentType
:
string
)
:
HttpRequestBuilder
<
D
>
Parameters
contentType
:
string
Returns
HttpRequestBuilder
<
D
>
delete
delete
(
url
:
string
)
:
HttpRequestBuilder
<
D
>
Parameters
url
:
string
Returns
HttpRequestBuilder
<
D
>
dont
Follow
Redirects
dontFollowRedirects
()
:
HttpRequestBuilder
<
D
>
Returns
HttpRequestBuilder
<
D
>
follow
Redirects
followRedirects
(
maxRedirects
?:
number
)
:
HttpRequestBuilder
<
D
>
Parameters
Optional
maxRedirects
:
number
Returns
HttpRequestBuilder
<
D
>
get
get
(
url
:
string
)
:
HttpRequestBuilder
<
D
>
Parameters
url
:
string
Returns
HttpRequestBuilder
<
D
>
patch
patch
(
url
:
string
)
:
HttpRequestBuilder
<
D
>
Parameters
url
:
string
Returns
HttpRequestBuilder
<
D
>
post
post
(
url
:
string
)
:
HttpRequestBuilder
<
D
>
Parameters
url
:
string
Returns
HttpRequestBuilder
<
D
>
put
put
(
url
:
string
)
:
HttpRequestBuilder
<
D
>
Parameters
url
:
string
Returns
HttpRequestBuilder
<
D
>
user
Agent
userAgent
(
userAgent
:
string
)
:
HttpRequestBuilder
<
D
>
Parameters
userAgent
:
string
Returns
HttpRequestBuilder
<
D
>
with
Abort
Signal
withAbortSignal
(
signal
?:
GenericAbortSignal
)
:
HttpRequestBuilder
<
D
>
Parameters
Optional
signal
:
GenericAbortSignal
Returns
HttpRequestBuilder
<
D
>
with
Data
withData
<
T
>
(
data
:
T
)
:
HttpRequestBuilder
<
T
>
Type Parameters
T
Parameters
data
:
T
Returns
HttpRequestBuilder
<
T
>
with
Endpoint
withEndpoint
(
method
:
HttpMethod
,
url
:
string
)
:
HttpRequestBuilder
<
D
>
Parameters
method
:
HttpMethod
url
:
string
Returns
HttpRequestBuilder
<
D
>
with
Header
withHeader
(
key
:
string
,
value
:
HttpHeaderValue
)
:
HttpRequestBuilder
<
D
>
Parameters
key
:
string
value
:
HttpHeaderValue
Returns
HttpRequestBuilder
<
D
>
with
Headers
withHeaders
(
headers
:
HttpRequestHeaders
)
:
HttpRequestBuilder
<
D
>
Parameters
headers
:
HttpRequestHeaders
Returns
HttpRequestBuilder
<
D
>
without
Timeout
withoutTimeout
()
:
HttpRequestBuilder
<
D
>
Returns
HttpRequestBuilder
<
D
>
with
Params
withParams
(
params
:
string
|
URLSearchParams
|
Record
<
string
,
string
>
|
string
[]
[]
,
)
:
HttpRequestBuilder
<
D
>
Parameters
params
:
string
|
URLSearchParams
|
Record
<
string
,
string
>
|
string
[]
[]
Returns
HttpRequestBuilder
<
D
>
with
Timeout
withTimeout
(
timeout
?:
number
)
:
HttpRequestBuilder
<
D
>
Parameters
Optional
timeout
:
number
Returns
HttpRequestBuilder
<
D
>
with
Token
withToken
(
token
:
string
,
type
?:
string
)
:
HttpRequestBuilder
<
D
>
Parameters
token
:
string
type
:
string
= 'Bearer'
Returns
HttpRequestBuilder
<
D
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Accessors
data
headers
max
Redirects
method
signal
timeout
url
Methods
accept
as
Form
as
Json
as
Multipart
content
Type
delete
dont
Follow
Redirects
follow
Redirects
get
patch
post
put
user
Agent
with
Abort
Signal
with
Data
with
Endpoint
with
Header
with
Headers
without
Timeout
with
Params
with
Timeout
with
Token
Umi — API References - v1.3.0
Loading...
A builder for constructing HttpRequest instances.