rest-vir - v1.0.0
Preparing search index...
ContextInitParams
Type Alias ContextInitParams<ServiceName, EndpointsInit, WebSocketsInit>
Parameters for
ContextInit
.
Package
@rest-vir/implement-service
type
ContextInitParams
<
ServiceName
extends
string
=
any
,
EndpointsInit
extends
BaseServiceEndpointsInit
|
NoParam
=
NoParam
,
WebSocketsInit
extends
BaseServiceWebSocketsInit
|
NoParam
=
NoParam
,
>
=
{
endpointDefinition
?:
EndpointsInit
extends
NoParam
?
EndpointDefinition
:
WithFinalEndpointProps
<
Values
<
EndpointsInit
>
,
Extract
<
keyof
EndpointsInit
,
EndpointPathBase
>
,
>
;
method
:
HttpMethod
;
pathParams
:
EndpointsInit
extends
NoParam
?
Readonly
<
Record
<
string
,
string
>
>
:
PathParams
<
WithFinalWebSocketProps
<
Values
<
WebSocketsInit
>
,
any
>
[
"path"
]
>
extends
string
?
Readonly
<
Record
<
PathParams
<
WithFinalWebSocketProps
<
Values
<
WebSocketsInit
>
,
any
>
[
"path"
]
,
>
,
string
,
>
,
>
:
Readonly
<
Record
<
string
,
string
>
>
;
request
:
ServerRequest
;
requestData
:
EndpointsInit
extends
NoParam
?
unknown
:
WithFinalEndpointProps
<
Values
<
EndpointsInit
>
,
Extract
<
keyof
EndpointsInit
,
EndpointPathBase
>
,
>
[
"RequestType"
]
;
requestHeaders
:
IncomingHttpHeaders
;
response
:
ServerResponse
;
searchParams
:
ReplaceUndefinedWithEmptyObject
<
|
(
WebSocketsInit
extends
NoParam
?
BaseSearchParams
|
undefined
:
WithFinalWebSocketProps
<
Values
<
WebSocketsInit
>
,
any
>
[
"SearchParamsType"
]
)
|
(
EndpointsInit
extends
NoParam
?
BaseSearchParams
|
undefined
:
WithFinalEndpointProps
<
Values
<
EndpointsInit
>
,
any
>
[
"SearchParamsType"
]
)
,
>
;
server
:
RunningServerInfo
;
service
:
MinimalService
<
ServiceName
>
;
webSocketDefinition
?:
WebSocketsInit
extends
NoParam
?
WebSocketDefinition
:
WithFinalWebSocketProps
<
Values
<
WebSocketsInit
>
,
Extract
<
keyof
WebSocketsInit
,
EndpointPathBase
>
,
>
;
}
Type Parameters
ServiceName
extends
string
=
any
EndpointsInit
extends
BaseServiceEndpointsInit
|
NoParam
=
NoParam
WebSocketsInit
extends
BaseServiceWebSocketsInit
|
NoParam
=
NoParam
Index
Properties
endpoint
Definition?
method
path
Params
request
request
Data
request
Headers
response
search
Params
server
service
web
Socket
Definition?
Properties
Optional
endpoint
Definition
endpointDefinition
?:
EndpointsInit
extends
NoParam
?
EndpointDefinition
:
WithFinalEndpointProps
<
Values
<
EndpointsInit
>
,
Extract
<
keyof
EndpointsInit
,
EndpointPathBase
>
,
>
method
method
:
HttpMethod
path
Params
pathParams
:
EndpointsInit
extends
NoParam
?
Readonly
<
Record
<
string
,
string
>
>
:
PathParams
<
WithFinalWebSocketProps
<
Values
<
WebSocketsInit
>
,
any
>
[
"path"
]
>
extends
string
?
Readonly
<
Record
<
PathParams
<
WithFinalWebSocketProps
<
Values
<
WebSocketsInit
>
,
any
>
[
"path"
]
,
>
,
string
,
>
,
>
:
Readonly
<
Record
<
string
,
string
>
>
request
request
:
ServerRequest
request
Data
requestData
:
EndpointsInit
extends
NoParam
?
unknown
:
WithFinalEndpointProps
<
Values
<
EndpointsInit
>
,
Extract
<
keyof
EndpointsInit
,
EndpointPathBase
>
,
>
[
"RequestType"
]
request
Headers
requestHeaders
:
IncomingHttpHeaders
response
response
:
ServerResponse
search
Params
searchParams
:
ReplaceUndefinedWithEmptyObject
<
|
(
WebSocketsInit
extends
NoParam
?
BaseSearchParams
|
undefined
:
WithFinalWebSocketProps
<
Values
<
WebSocketsInit
>
,
any
>
[
"SearchParamsType"
]
)
|
(
EndpointsInit
extends
NoParam
?
BaseSearchParams
|
undefined
:
WithFinalEndpointProps
<
Values
<
EndpointsInit
>
,
any
>
[
"SearchParamsType"
]
)
,
>
server
server
:
RunningServerInfo
The actual running server info.
service
service
:
MinimalService
<
ServiceName
>
Optional
web
Socket
Definition
webSocketDefinition
?:
WebSocketsInit
extends
NoParam
?
WebSocketDefinition
:
WithFinalWebSocketProps
<
Values
<
WebSocketsInit
>
,
Extract
<
keyof
WebSocketsInit
,
EndpointPathBase
>
,
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Properties
endpoint
Definition
method
path
Params
request
request
Data
request
Headers
response
search
Params
server
service
web
Socket
Definition
rest-vir - v1.0.0
Loading...
Parameters for ContextInit.
Package
@rest-vir/implement-service