rest-vir - v2.2.0
Preparing search index...
createEndpointResponseOutput
Function createEndpointResponseOutput
createEndpointResponseOutput
<
Endpoint
extends
EndpointDefinition
,
Method
extends
"GET"
|
"PUT"
|
"POST"
|
"DELETE"
|
"PATCH"
|
"TRACE"
,
IncludeResponse
extends
boolean
,
>
(
__namedParameters
:
Readonly
<
{
endpoint
:
Endpoint
;
handleDeclaredResponseStatusOverride
?:
HandleDeclaredResponseStatusOverride
;
includeResponse
:
IncludeResponse
;
method
:
Method
;
response
:
Response
;
shouldCondenseResponse
:
boolean
;
}
,
>
,
)
:
Promise
<
If
<
IsAny
<
DefinedEndpointFetchOutputs
<
Endpoint
,
Method
,
IncludeResponse
>
&
{
unexpectedError
:
UnknownFetchOutput
<
IncludeResponse
>
;
}
,
>
,
any
,
If
<
IsNever
<
DefinedEndpointFetchOutputs
<
Endpoint
,
Method
,
IncludeResponse
>
&
{
unexpectedError
:
UnknownFetchOutput
<
IncludeResponse
>
;
}
,
>
,
never
,
If
<
IsNever
<
|
"unexpectedError"
|
keyof
DefinedEndpointFetchOutputs
<
Endpoint
,
Method
,
IncludeResponse
>
,
>
,
never
,
_RequireExactlyOne
<
DefinedEndpointFetchOutputs
<
Endpoint
,
Method
,
IncludeResponse
>
&
{
unexpectedError
:
UnknownFetchOutput
<
IncludeResponse
>
;
}
,
If
<
IsAny
<
|
"unexpectedError"
|
keyof
DefinedEndpointFetchOutputs
<
Endpoint
,
Method
,
IncludeResponse
,
>
,
>
,
|
"unexpectedError"
|
keyof
DefinedEndpointFetchOutputs
<
Endpoint
,
Method
,
IncludeResponse
>
,
|
"unexpectedError"
|
keyof
DefinedEndpointFetchOutputs
<
Endpoint
,
Method
,
IncludeResponse
,
>
,
>
,
>
,
>
,
>
,
>
,
>
Type Parameters
Endpoint
extends
EndpointDefinition
Method
extends
"GET"
|
"PUT"
|
"POST"
|
"DELETE"
|
"PATCH"
|
"TRACE"
IncludeResponse
extends
boolean
Parameters
__namedParameters
:
Readonly
<
{
endpoint
:
Endpoint
;
handleDeclaredResponseStatusOverride
?:
HandleDeclaredResponseStatusOverride
;
includeResponse
:
IncludeResponse
;
method
:
Method
;
response
:
Response
;
shouldCondenseResponse
:
boolean
;
}
,
>
Returns
Promise
<
If
<
IsAny
<
DefinedEndpointFetchOutputs
<
Endpoint
,
Method
,
IncludeResponse
>
&
{
unexpectedError
:
UnknownFetchOutput
<
IncludeResponse
>
;
}
,
>
,
any
,
If
<
IsNever
<
DefinedEndpointFetchOutputs
<
Endpoint
,
Method
,
IncludeResponse
>
&
{
unexpectedError
:
UnknownFetchOutput
<
IncludeResponse
>
;
}
,
>
,
never
,
If
<
IsNever
<
|
"unexpectedError"
|
keyof
DefinedEndpointFetchOutputs
<
Endpoint
,
Method
,
IncludeResponse
>
,
>
,
never
,
_RequireExactlyOne
<
DefinedEndpointFetchOutputs
<
Endpoint
,
Method
,
IncludeResponse
>
&
{
unexpectedError
:
UnknownFetchOutput
<
IncludeResponse
>
;
}
,
If
<
IsAny
<
|
"unexpectedError"
|
keyof
DefinedEndpointFetchOutputs
<
Endpoint
,
Method
,
IncludeResponse
,
>
,
>
,
|
"unexpectedError"
|
keyof
DefinedEndpointFetchOutputs
<
Endpoint
,
Method
,
IncludeResponse
>
,
|
"unexpectedError"
|
keyof
DefinedEndpointFetchOutputs
<
Endpoint
,
Method
,
IncludeResponse
,
>
,
>
,
>
,
>
,
>
,
>
,
>
Package
@rest-vir/api
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
rest-vir - v2.2.0
Loading...
Package
@rest-vir/api