yaschema-api-fetcher
Preparing search index...
apiFetch
Function apiFetch
apiFetch
<
ReqHeadersT
extends
AnyHeaders
,
ReqParamsT
extends
AnyParams
,
ReqQueryT
extends
AnyQuery
,
ReqBodyT
extends
unknown
,
ResStatusT
extends
number
,
ResHeadersT
extends
AnyHeaders
,
ResBodyT
extends
unknown
,
ErrResStatusT
extends
number
,
ErrResHeadersT
extends
AnyHeaders
,
ErrResBodyT
extends
unknown
,
>
(
api
:
HttpApi
<
ReqHeadersT
,
ReqParamsT
,
ReqQueryT
,
ReqBodyT
,
ResStatusT
,
ResHeadersT
,
ResBodyT
,
ErrResStatusT
,
ErrResHeadersT
,
ErrResBodyT
,
>
,
req
:
ApiRequest
<
ReqHeadersT
,
ReqParamsT
,
ReqQueryT
,
ReqBodyT
>
,
__namedParameters
?:
ApiFetchOptions
<
ReqHeadersT
,
ReqParamsT
,
ReqQueryT
,
ReqBodyT
,
ResStatusT
,
ResHeadersT
,
ResBodyT
,
ErrResStatusT
,
ErrResHeadersT
,
ErrResBodyT
,
>
&
{
context
?:
ApiRoutingContext
}
,
)
:
Promise
<
ApiFetchResult
<
ResStatusT
,
ResHeadersT
,
ResBodyT
,
ErrResStatusT
,
ErrResHeadersT
,
ErrResBodyT
,
>
,
>
Uses
fetch
to access the specified API
Type Parameters
ReqHeadersT
extends
AnyHeaders
ReqParamsT
extends
AnyParams
ReqQueryT
extends
AnyQuery
ReqBodyT
extends
unknown
ResStatusT
extends
number
ResHeadersT
extends
AnyHeaders
ResBodyT
extends
unknown
ErrResStatusT
extends
number
ErrResHeadersT
extends
AnyHeaders
ErrResBodyT
extends
unknown
Parameters
api
:
HttpApi
<
ReqHeadersT
,
ReqParamsT
,
ReqQueryT
,
ReqBodyT
,
ResStatusT
,
ResHeadersT
,
ResBodyT
,
ErrResStatusT
,
ErrResHeadersT
,
ErrResBodyT
,
>
req
:
ApiRequest
<
ReqHeadersT
,
ReqParamsT
,
ReqQueryT
,
ReqBodyT
>
__namedParameters
:
ApiFetchOptions
<
ReqHeadersT
,
ReqParamsT
,
ReqQueryT
,
ReqBodyT
,
ResStatusT
,
ResHeadersT
,
ResBodyT
,
ErrResStatusT
,
ErrResHeadersT
,
ErrResBodyT
,
>
&
{
context
?:
ApiRoutingContext
}
= {}
Returns
Promise
<
ApiFetchResult
<
ResStatusT
,
ResHeadersT
,
ResBodyT
,
ErrResStatusT
,
ErrResHeadersT
,
ErrResBodyT
,
>
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
yaschema-api-fetcher
Loading...
Uses
fetch
to access the specified API