rest-vir - v1.0.0
Preparing search index...
rest-vir - v1.0.0
Define Service
formDataShape
defineService
Implement Service
implementService
Run Service
attachService
startService
Client (Frontend) Connection
connectWebSocket
fetchEndpoint
mapServiceDevPort
Create API
generateApi
Testing : Client (Frontend)
createMockClientWebSocketConstructor
createMockEndpointFetch
createMockEndpointResponse
makeMockApi
Testing : Backend
describeService
testEndpoint
withWebSocketTest
MISSING CATEGORY
RejectRequestError
OriginRequirementResult
ServiceTestSuite
Package : @rest-vir/define-service
CommonWebSocketState
WebSocketLocation
CommonWebSocket
MockClientWebSocket
MockResponseBodyStream
RestVirApi
ServiceDefinitionError
AnyOrigin
BaseEndpointForExecutorData
BaseSearchParams
BaseServiceEndpointsInit
BaseServiceWebSocketsInit
ClientWebSocket
CollapsedConnectWebSocketParams
CollapsedFetchEndpointParams
CollapsedSendAndWaitForReplyParams
CommonWebSocketEventMap
CommonWebSocketListenerOptions
ConnectWebSocketListeners
ConnectWebSocketParams
EndpointDefinition
EndpointExecutorData
EndpointInit
EndpointMustStartWithSlashTypeError
EndpointPathBase
FetchEndpointOutput
FetchEndpointParams
FetchMethod
FindPortOptions
FlipWebSocketLocation
GenerateApiOptions
GenericConnectWebSocketParams
GenericEndpointDefinition
GenericFetchEndpointParams
GenericWebSocketDefinition
GetWebSocketMessageTypeFromLocation
Match
MatchFunction
MatchResult
MinimalService
MockClientWebSocketClientSendCallback
MockClientWebSocketClientSendCallbackParams
MockClientWebSocketListeners
MockClientWebSocketOptions
MockEndpointResponseOptions
MockExistingApi
MockResponseParams
NarrowOriginalDefinition
NoParam
OriginRequirement
OverwriteWebSocketMethods
ParamData
PathParams
RestVirApiMocks
SendAndWaitForReplyParams
ServiceDefinition
ServiceDefinitionErrorParams
ServiceInit
WebSocketDefinition
WebSocketInit
WebSocketListener
WebSocketListenerParams
WithFinalEndpointProps
WithFinalWebSocketProps
AnyOrigin
endpointInitShape
formDataShape
NoParam
originRequirementShape
restVirServiceNameHeader
webSocketInitShape
assertValidEndpoint
assertValidEndpointPath
assertValidServiceDefinition
assertValidWebSocketDefinition
assertValidWebSocketProtocols
attachEndpointShapeTypeGetters
attachWebSocketShapeTypeGetters
buildEndpointRequestInit
buildEndpointUrl
buildWebSocketUrl
checkOriginRequirement
connectWebSocket
createMockClientWebSocketConstructor
createMockEndpointFetch
createMockEndpointResponse
createMockFetch
createMockResponse
defineService
ensureServiceDefinitionError
fetchEndpoint
finalizeWebSocket
findDevServicePort
findLivePort
generateApi
getAllowedEndpointMethods
getOppositeWebSocketLocation
isAnyOrigin
isFormDataShape
makeMockApi
mapServiceDevPort
match
matchesOriginRequirement
overwriteWebSocketMethods
parseJsonWithUndefined
parseSecWebSocketProtocolHeader
verifyWebSocketMessage
waitForOpenWebSocket
Package : @rest-vir/implement-service
RestVirHandlerError
ContextInit
ContextInitOutput
ContextInitParams
CustomErrorHandler
EndpointImplementation
EndpointImplementationErrorOutput
EndpointImplementationOutput
EndpointImplementationParams
EndpointImplementations
GenericEndpointImplementationParams
GenericServiceImplementation
ImplementedEndpoint
ImplementedWebSocket
MatchedServicePath
PostHook
PostHookParams
ReplaceUndefinedWithEmptyObject
RunningServerInfo
ServerRequest
ServerResponse
ServerWebSocket
ServiceImplementation
ServiceImplementationFromServiceDefinition
ServiceImplementationInit
ServiceImplementationsParams
ServiceLogger
ServiceLoggerOption
WebSocketImplementation
WebSocketImplementationParams
WebSocketImplementations
defaultServiceLogger
silentServiceLogger
assertValidEndpointImplementations
assertValidWebSocketImplementations
createRestVirHandlerErrorPrefix
createServiceLogger
implementService
matchUrlToService
Package : @rest-vir/run-service
CondenseResponseOptions
ConnectTestServiceWebSocket
ConnectTestWebSocket
EndpointHandler
EndpointHandlerParams
FastifyPlugins
FetchTestEndpoint
FetchTestService
HandledOutput
HandleRouteOptions
RestVirRequestContext
StartServiceOptions
StartServiceOutput
StartServiceUserOptions
TestEndpoint
TestServiceOptions
TestWebSocket
WithWebSocketTestCallback
startServiceOptionsShape
applyDebugLogger
attachService
condenseResponse
describeService
finalizeOptions
handleCors
handleEndpointRequest
handleHandlerOutput
handleHandlerOutputWithoutSending
handleRequestMethod
handleRoute
handleSearchParams
handleWebSocketRequest
preHandler
setResponseHeaders
startService
testEndpoint
testExistingServer
testService
testWebSocket
withWebSocketTest
Internal
CommonWebSocketState
WebSocketLocation
CommonWebSocket
MockClientWebSocket
MockResponseBodyStream
RestVirApi
RestVirHandlerError
ServiceDefinitionError
AnyOrigin
BaseEndpointForExecutorData
BaseSearchParams
BaseServiceEndpointsInit
BaseServiceWebSocketsInit
ClientWebSocket
CollapsedConnectWebSocketParams
CollapsedFetchEndpointParams
CollapsedSendAndWaitForReplyParams
CommonWebSocketEventMap
CommonWebSocketListenerOptions
CondenseResponseOptions
ConnectTestServiceWebSocket
ConnectTestWebSocket
ConnectWebSocketListeners
ConnectWebSocketParams
ContextInit
ContextInitOutput
ContextInitParams
CustomErrorHandler
EndpointDefinition
EndpointExecutorData
EndpointHandler
EndpointHandlerParams
EndpointImplementation
EndpointImplementationErrorOutput
EndpointImplementationOutput
EndpointImplementationParams
EndpointImplementations
EndpointInit
EndpointMustStartWithSlashTypeError
EndpointPathBase
FastifyPlugins
FetchEndpointOutput
FetchEndpointParams
FetchMethod
FetchTestEndpoint
FetchTestService
FindPortOptions
FlipWebSocketLocation
GenerateApiOptions
GenericConnectWebSocketParams
GenericEndpointDefinition
GenericEndpointImplementationParams
GenericFetchEndpointParams
GenericServiceImplementation
GenericWebSocketDefinition
GetWebSocketMessageTypeFromLocation
HandledOutput
HandleRouteOptions
ImplementedEndpoint
ImplementedWebSocket
Match
MatchedServicePath
MatchFunction
MatchResult
MinimalService
MockClientWebSocketClientSendCallback
MockClientWebSocketClientSendCallbackParams
MockClientWebSocketListeners
MockClientWebSocketOptions
MockEndpointResponseOptions
MockExistingApi
MockResponseParams
NarrowOriginalDefinition
NoParam
OriginRequirement
OverwriteWebSocketMethods
ParamData
PathParams
PostHook
PostHookParams
ReplaceUndefinedWithEmptyObject
RestVirApiMocks
RestVirRequestContext
RunningServerInfo
SendAndWaitForReplyParams
ServerRequest
ServerResponse
ServerWebSocket
ServiceDefinition
ServiceDefinitionErrorParams
ServiceImplementation
ServiceImplementationFromServiceDefinition
ServiceImplementationInit
ServiceImplementationsParams
ServiceInit
ServiceLogger
ServiceLoggerOption
StartServiceOptions
StartServiceOutput
StartServiceUserOptions
TestEndpoint
TestServiceOptions
TestWebSocket
WebSocketDefinition
WebSocketImplementation
WebSocketImplementationParams
WebSocketImplementations
WebSocketInit
WebSocketListener
WebSocketListenerParams
WithFinalEndpointProps
WithFinalWebSocketProps
WithWebSocketTestCallback
AnyOrigin
defaultServiceLogger
endpointInitShape
NoParam
originRequirementShape
restVirServiceNameHeader
silentServiceLogger
startServiceOptionsShape
webSocketInitShape
applyDebugLogger
assertValidEndpoint
assertValidEndpointImplementations
assertValidEndpointPath
assertValidServiceDefinition
assertValidWebSocketDefinition
assertValidWebSocketImplementations
assertValidWebSocketProtocols
attachEndpointShapeTypeGetters
attachWebSocketShapeTypeGetters
buildEndpointRequestInit
buildEndpointUrl
buildWebSocketUrl
checkOriginRequirement
condenseResponse
createMockFetch
createMockResponse
createRestVirHandlerErrorPrefix
createServiceLogger
ensureServiceDefinitionError
extractRunningServerInfo
finalizeOptions
finalizeWebSocket
findDevServicePort
findLivePort
getAllowedEndpointMethods
getOppositeWebSocketLocation
handleCors
handleEndpointRequest
handleHandlerOutput
handleHandlerOutputWithoutSending
handleRequestMethod
handleRoute
handleSearchParams
handleWebSocketRequest
isAnyOrigin
isFormDataShape
match
matchesOriginRequirement
matchUrlToService
overwriteWebSocketMethods
parseJsonWithUndefined
parseSecWebSocketProtocolHeader
preHandler
setResponseHeaders
testExistingServer
testService
testWebSocket
verifyWebSocketMessage
waitForOpenWebSocket
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Define Service
form
Data
Shape
define
Service
Implement Service
implement
Service
Run Service
attach
Service
start
Service
Client (Frontend) Connection
connect
Web
Socket
fetch
Endpoint
map
Service
Dev
Port
Create API
generate
Api
Testing : Client (Frontend)
create
Mock
Client
Web
Socket
Constructor
create
Mock
Endpoint
Fetch
create
Mock
Endpoint
Response
make
Mock
Api
Testing : Backend
describe
Service
test
Endpoint
with
Web
Socket
Test
MISSING CATEGORY
Reject
Request
Error
Origin
Requirement
Result
Service
Test
Suite
Package : @rest-vir/define-service
Common
Web
Socket
State
Web
Socket
Location
Common
Web
Socket
Mock
Client
Web
Socket
Mock
Response
Body
Stream
Rest
Vir
Api
Service
Definition
Error
Any
Origin
Base
Endpoint
For
Executor
Data
Base
Search
Params
Base
Service
Endpoints
Init
Base
Service
Web
Sockets
Init
Client
Web
Socket
Collapsed
Connect
Web
Socket
Params
Collapsed
Fetch
Endpoint
Params
Collapsed
Send
And
Wait
For
Reply
Params
Common
Web
Socket
Event
Map
Common
Web
Socket
Listener
Options
Connect
Web
Socket
Listeners
Connect
Web
Socket
Params
Endpoint
Definition
Endpoint
Executor
Data
Endpoint
Init
Endpoint
Must
Start
With
Slash
Type
Error
Endpoint
Path
Base
Fetch
Endpoint
Output
Fetch
Endpoint
Params
Fetch
Method
Find
Port
Options
Flip
Web
Socket
Location
Generate
Api
Options
Generic
Connect
Web
Socket
Params
Generic
Endpoint
Definition
Generic
Fetch
Endpoint
Params
Generic
Web
Socket
Definition
Get
Web
Socket
Message
Type
From
Location
Match
Match
Function
Match
Result
Minimal
Service
Mock
Client
Web
Socket
Client
Send
Callback
Mock
Client
Web
Socket
Client
Send
Callback
Params
Mock
Client
Web
Socket
Listeners
Mock
Client
Web
Socket
Options
Mock
Endpoint
Response
Options
Mock
Existing
Api
Mock
Response
Params
Narrow
Original
Definition
No
Param
Origin
Requirement
Overwrite
Web
Socket
Methods
Param
Data
Path
Params
Rest
Vir
Api
Mocks
Send
And
Wait
For
Reply
Params
Service
Definition
Service
Definition
Error
Params
Service
Init
Web
Socket
Definition
Web
Socket
Init
Web
Socket
Listener
Web
Socket
Listener
Params
With
Final
Endpoint
Props
With
Final
Web
Socket
Props
Any
Origin
endpoint
Init
Shape
form
Data
Shape
No
Param
origin
Requirement
Shape
rest
Vir
Service
Name
Header
web
Socket
Init
Shape
assert
Valid
Endpoint
assert
Valid
Endpoint
Path
assert
Valid
Service
Definition
assert
Valid
Web
Socket
Definition
assert
Valid
Web
Socket
Protocols
attach
Endpoint
Shape
Type
Getters
attach
Web
Socket
Shape
Type
Getters
build
Endpoint
Request
Init
build
Endpoint
Url
build
Web
Socket
Url
check
Origin
Requirement
connect
Web
Socket
create
Mock
Client
Web
Socket
Constructor
create
Mock
Endpoint
Fetch
create
Mock
Endpoint
Response
create
Mock
Fetch
create
Mock
Response
define
Service
ensure
Service
Definition
Error
fetch
Endpoint
finalize
Web
Socket
find
Dev
Service
Port
find
Live
Port
generate
Api
get
Allowed
Endpoint
Methods
get
Opposite
Web
Socket
Location
is
Any
Origin
is
Form
Data
Shape
make
Mock
Api
map
Service
Dev
Port
match
matches
Origin
Requirement
overwrite
Web
Socket
Methods
parse
Json
With
Undefined
parse
Sec
Web
Socket
Protocol
Header
verify
Web
Socket
Message
wait
For
Open
Web
Socket
Package : @rest-vir/implement-service
Rest
Vir
Handler
Error
Context
Init
Context
Init
Output
Context
Init
Params
Custom
Error
Handler
Endpoint
Implementation
Endpoint
Implementation
Error
Output
Endpoint
Implementation
Output
Endpoint
Implementation
Params
Endpoint
Implementations
Generic
Endpoint
Implementation
Params
Generic
Service
Implementation
Implemented
Endpoint
Implemented
Web
Socket
Matched
Service
Path
Post
Hook
Post
Hook
Params
Replace
Undefined
With
Empty
Object
Running
Server
Info
Server
Request
Server
Response
Server
Web
Socket
Service
Implementation
Service
Implementation
From
Service
Definition
Service
Implementation
Init
Service
Implementations
Params
Service
Logger
Service
Logger
Option
Web
Socket
Implementation
Web
Socket
Implementation
Params
Web
Socket
Implementations
default
Service
Logger
silent
Service
Logger
assert
Valid
Endpoint
Implementations
assert
Valid
Web
Socket
Implementations
create
Rest
Vir
Handler
Error
Prefix
create
Service
Logger
implement
Service
match
Url
To
Service
Package : @rest-vir/run-service
Condense
Response
Options
Connect
Test
Service
Web
Socket
Connect
Test
Web
Socket
Endpoint
Handler
Endpoint
Handler
Params
Fastify
Plugins
Fetch
Test
Endpoint
Fetch
Test
Service
Handled
Output
Handle
Route
Options
Rest
Vir
Request
Context
Start
Service
Options
Start
Service
Output
Start
Service
User
Options
Test
Endpoint
Test
Service
Options
Test
Web
Socket
With
Web
Socket
Test
Callback
start
Service
Options
Shape
apply
Debug
Logger
attach
Service
condense
Response
describe
Service
finalize
Options
handle
Cors
handle
Endpoint
Request
handle
Handler
Output
handle
Handler
Output
Without
Sending
handle
Request
Method
handle
Route
handle
Search
Params
handle
Web
Socket
Request
pre
Handler
set
Response
Headers
start
Service
test
Endpoint
test
Existing
Server
test
Service
test
Web
Socket
with
Web
Socket
Test
Internal
Common
Web
Socket
State
Web
Socket
Location
Common
Web
Socket
Mock
Client
Web
Socket
Mock
Response
Body
Stream
Rest
Vir
Api
Rest
Vir
Handler
Error
Service
Definition
Error
Any
Origin
Base
Endpoint
For
Executor
Data
Base
Search
Params
Base
Service
Endpoints
Init
Base
Service
Web
Sockets
Init
Client
Web
Socket
Collapsed
Connect
Web
Socket
Params
Collapsed
Fetch
Endpoint
Params
Collapsed
Send
And
Wait
For
Reply
Params
Common
Web
Socket
Event
Map
Common
Web
Socket
Listener
Options
Condense
Response
Options
Connect
Test
Service
Web
Socket
Connect
Test
Web
Socket
Connect
Web
Socket
Listeners
Connect
Web
Socket
Params
Context
Init
Context
Init
Output
Context
Init
Params
Custom
Error
Handler
Endpoint
Definition
Endpoint
Executor
Data
Endpoint
Handler
Endpoint
Handler
Params
Endpoint
Implementation
Endpoint
Implementation
Error
Output
Endpoint
Implementation
Output
Endpoint
Implementation
Params
Endpoint
Implementations
Endpoint
Init
Endpoint
Must
Start
With
Slash
Type
Error
Endpoint
Path
Base
Fastify
Plugins
Fetch
Endpoint
Output
Fetch
Endpoint
Params
Fetch
Method
Fetch
Test
Endpoint
Fetch
Test
Service
Find
Port
Options
Flip
Web
Socket
Location
Generate
Api
Options
Generic
Connect
Web
Socket
Params
Generic
Endpoint
Definition
Generic
Endpoint
Implementation
Params
Generic
Fetch
Endpoint
Params
Generic
Service
Implementation
Generic
Web
Socket
Definition
Get
Web
Socket
Message
Type
From
Location
Handled
Output
Handle
Route
Options
Implemented
Endpoint
Implemented
Web
Socket
Match
Matched
Service
Path
Match
Function
Match
Result
Minimal
Service
Mock
Client
Web
Socket
Client
Send
Callback
Mock
Client
Web
Socket
Client
Send
Callback
Params
Mock
Client
Web
Socket
Listeners
Mock
Client
Web
Socket
Options
Mock
Endpoint
Response
Options
Mock
Existing
Api
Mock
Response
Params
Narrow
Original
Definition
No
Param
Origin
Requirement
Overwrite
Web
Socket
Methods
Param
Data
Path
Params
Post
Hook
Post
Hook
Params
Replace
Undefined
With
Empty
Object
Rest
Vir
Api
Mocks
Rest
Vir
Request
Context
Running
Server
Info
Send
And
Wait
For
Reply
Params
Server
Request
Server
Response
Server
Web
Socket
Service
Definition
Service
Definition
Error
Params
Service
Implementation
Service
Implementation
From
Service
Definition
Service
Implementation
Init
Service
Implementations
Params
Service
Init
Service
Logger
Service
Logger
Option
Start
Service
Options
Start
Service
Output
Start
Service
User
Options
Test
Endpoint
Test
Service
Options
Test
Web
Socket
Web
Socket
Definition
Web
Socket
Implementation
Web
Socket
Implementation
Params
Web
Socket
Implementations
Web
Socket
Init
Web
Socket
Listener
Web
Socket
Listener
Params
With
Final
Endpoint
Props
With
Final
Web
Socket
Props
With
Web
Socket
Test
Callback
Any
Origin
default
Service
Logger
endpoint
Init
Shape
No
Param
origin
Requirement
Shape
rest
Vir
Service
Name
Header
silent
Service
Logger
start
Service
Options
Shape
web
Socket
Init
Shape
apply
Debug
Logger
assert
Valid
Endpoint
assert
Valid
Endpoint
Implementations
assert
Valid
Endpoint
Path
assert
Valid
Service
Definition
assert
Valid
Web
Socket
Definition
assert
Valid
Web
Socket
Implementations
assert
Valid
Web
Socket
Protocols
attach
Endpoint
Shape
Type
Getters
attach
Web
Socket
Shape
Type
Getters
build
Endpoint
Request
Init
build
Endpoint
Url
build
Web
Socket
Url
check
Origin
Requirement
condense
Response
create
Mock
Fetch
create
Mock
Response
create
Rest
Vir
Handler
Error
Prefix
create
Service
Logger
ensure
Service
Definition
Error
extract
Running
Server
Info
finalize
Options
finalize
Web
Socket
find
Dev
Service
Port
find
Live
Port
get
Allowed
Endpoint
Methods
get
Opposite
Web
Socket
Location
handle
Cors
handle
Endpoint
Request
handle
Handler
Output
handle
Handler
Output
Without
Sending
handle
Request
Method
handle
Route
handle
Search
Params
handle
Web
Socket
Request
is
Any
Origin
is
Form
Data
Shape
match
matches
Origin
Requirement
match
Url
To
Service
overwrite
Web
Socket
Methods
parse
Json
With
Undefined
parse
Sec
Web
Socket
Protocol
Header
pre
Handler
set
Response
Headers
test
Existing
Server
test
Service
test
Web
Socket
verify
Web
Socket
Message
wait
For
Open
Web
Socket
rest-vir - v1.0.0
Loading...