rest-vir - v2.2.0
    Preparing search index...

      rest-vir - v2.2.0

      API

      createRouteDefiners
      defineApi
      defineEndpoint
      defineWebSocket

      Client

      RestVirClient
      EndpointRequestType
      EndpointResponseType

      Host

      createApiImplementor
      implementApi

      Host Server

      ApiServerOptions
      attachApi
      startApiServer

      Error

      DefineApiError
      ImplementApiError

      Util : API

      WebSocketMessageType
      formDataShape
      buildRoutePath
      extractHttpMethod
      extractHttpStatus

      Util : Client

      EndpointFetchOutput
      EndpointFetchStreamOutput
      extractEndpointResult
      readResponseHeaders

      Testing : Client

      MockWebSocket
      MockWebSocketOptions
      createMockEndpointFetch
      createMockEndpointResponse
      createMockHost
      getLastMockWebSocket

      Testing : Host

      describeApi
      describeEndpoint
      testEndpoint
      withWebSocketTest

      Package : @rest-vir/api

      CommonWebSocketState
      WebSocketLocation
      CommonWebSocket
      DefineApiError
      MockResponseBodyStream
      MockWebSocket
      RestVirClient
      AllowedHeaders
      AllowedSearchParamValue
      AllowedSingleSearchParamValue
      AnyOrigin
      ApiDefinition
      ApiInit
      BaseCommonRouteDefinition
      BaseCreateHostContextParams
      BaseEndpointMethodDefinition
      BaseEndpointMethodImplementationParams
      BaseRequiredResponseHeaders
      BaseRoutePath
      BaseSearchParams
      BaseWebSocketDefinition
      BaseWebSocketImplementationParams
      BuildRoutePathOptions
      BuildRoutePathParams
      ClientFetch
      ClientWebSocket
      CommonRouteDefinition
      CommonRouteDefinitionWithRequiredCustomProps
      CommonWebSocketEventMap
      CommonWebSocketListenerOptions
      ConnectWebSocketListeners
      CreateHostContextBase
      CreateHostContextOutput
      DefaultEndpointMethodStatusOutputs
      DefaultErrorResponseType
      DefaultOutgoingResponseHeadersType
      DefaultResponseHeadersType
      DefaultResponseType
      DefaultWebSocketProtocol
      DefinableHttpMethod
      DefinedEndpointFetchOutputResponseData
      DefinedEndpointFetchOutputs
      DefinedEndpointFetchStatusOutput
      DefinedEndpointFetchStreamOutputs
      EndpointDefinition
      EndpointDefinitionMethods
      EndpointDefinitionResponseStatuses
      EndpointDefinitionWithRequiredCustomProps
      EndpointFetchOutput
      EndpointFetchParamObject
      EndpointFetchParams
      EndpointFetchStreamOutput
      EndpointImplementationBase
      EndpointImplementationStatusOutput
      EndpointMethodDefinedStatusOutputs
      EndpointMethodDefinition
      EndpointMethodDefinitionResponseStatuses
      EndpointMethodDefinitionWithRequiredCustomProps
      EndpointMethodImplementationErrorOutput
      EndpointMethodImplementationOutput
      EndpointMethodImplementationsBase
      EndpointRequestHeadersType
      EndpointRequestType
      EndpointResponseHeadersType
      EndpointResponseOutgoingHeadersType
      EndpointResponseType
      ExtractEndpointMethodDefinition
      ExtractEndpointMethodDefinitionWithNoParam
      ExtractPathParams
      ExtractRequiredHeaderValue
      ExtractSearchParamValue
      FindPortOptions
      FlipWebSocketLocation
      GenericPathParams
      HandleDeclaredResponseStatusOverride
      HandleDeclaredResponseStatusOverrideParams
      HasWildcardParam
      HttpMethodsWithBodies
      HttpStatusByKey
      IsOptionalSearchParamRequirement
      MockCreateHostContext
      MockCreateHostContextParamsExtras
      MockEndpointImplementation
      MockEndpointMethodImplementations
      MockEndpointParamsExtras
      MockEndpointResponseOptions
      MockHostEndpointMap
      MockHostFetchOptions
      MockHostParams
      MockHostWebSocket
      MockHostWebSocketConstructorOptions
      MockHostWebSocketMap
      MockResponseParams
      MockWebSocketImplementation
      MockWebSocketListenerImplementations
      MockWebSocketOptions
      MockWebSocketParamsExtras
      NamedPathParams
      NoParam
      OriginCheckCallback
      OriginRequirement
      OriginRequirementResult
      OverwriteWebSocketMethods
      PathParams
      ResolveNamedParams
      ResolveShapeType
      ResolveWildcard
      ResponseDefinitions
      ResponseStatusDefinition
      RoutePathDefinition
      RouteSearchParamsType
      SearchParamRequirement
      SearchParamShape
      SearchParamShapeRuntimeType
      SearchParamsObjectType
      SendAndWaitForReplyParamObject
      SetNullishPropertiesAsOptional
      UnknownFetchOutput
      WebSocketClientMessageType
      WebSocketConnectParamObject
      WebSocketConnectParams
      WebSocketConnectProtocolRequirement
      WebSocketConnectProtocolType
      WebSocketConnectWebSocketConstructor
      WebSocketConnectWebSocketConstructorParams
      WebSocketDefinition
      WebSocketDefinitionWithRequiredCustomProps
      WebSocketHostMessageType
      WebSocketImplementationBase
      WebSocketListener
      WebSocketListenerImplementationsBase
      WebSocketListenerParams
      WebSocketLocationMessageType
      WebSocketMessageType
      WebSocketSendAndWaitForReplyParams
      WebSocketSendMessageParams
      WithResponse
      AnyOrigin
      definableHttpMethods
      formDataShape
      httpMethodsWithBodies
      httpStatusToKey
      NoParam
      restVirApiNameHeader
      assertValidWebSocketProtocols
      buildMethodNotAllowedMessage
      buildRoutePath
      checkOriginRequirement
      condenseResponse
      consolidateHeaders
      createEndpointResponseOutput
      createMockEndpointFetch
      createMockEndpointResponse
      createMockFetch
      createMockHost
      createMockHostFetch
      createMockHostWebSocketConstructor
      createMockResponse
      createRouteDefiners
      defaultHandleDeclaredResponseStatus
      defineApi
      defineEndpoint
      defineWebSocket
      extractEndpointMethodDefinition
      extractEndpointResult
      extractHttpMethod
      extractHttpStatus
      extractRequiredHeaders
      extractSearchParams
      finalizeClientWebSocket
      findDevServerPort
      findLivePort
      getLastMockWebSocket
      getOppositeWebSocketLocation
      headersToObject
      isFormDataShape
      isJsonContentType
      matchesOriginRequirement
      matchesWebSocketProtocolRequirement
      mergeHeaders
      overwriteWebSocketMethods
      parseJsonWithUndefined
      parseSecWebSocketProtocolHeader
      readHeaderValue
      readResponseBodyAsJsonOrText
      readResponseBodyAsText
      readResponseHeaders
      removeClientHeaders
      resolveMockHostContext
      verifyWebSocketMessage
      waitForOpenWebSocket

      Package : @rest-vir/host

      ImplementApiError
      RejectRequestError
      RestVirHandlerError
      ApiImplementation
      ApiImplementationStored
      ApiRouteImplementations
      ApiServerOptions
      ApiTestSuite
      AssembleEndpointTestResult
      ConnectTestWebSocket
      CreateEndpointCaseTestParams
      CreateHostContext
      CreateHostContextParams
      DescribeEndpointParams
      EndpointCases
      EndpointCaseSuiteParams
      EndpointFromImplementation
      EndpointImplementation
      EndpointImplementationMethods
      EndpointMethodImplementationParams
      EndpointMethodImplementations
      EndpointTestCase
      EndpointTestCasesArray
      FastifyPlugins
      FetchTestEndpoint
      HandledOutput
      HandleRouteOptions
      HostContextFromImplementation
      HostCreateContextParamsExtras
      HostEndpointParamsExtras
      HostWebSocketParamsExtras
      IndividualEndpointTestCallback
      IndividualEndpointTestInputs
      IndividualEndpointTestResult
      Match
      MatchedServicePath
      MatchFunction
      MatchResult
      ParamData
      PostRouteHook
      PostRouteHookOutput
      PostRouteHookParams
      RestVirRequestContext
      RouteHandler
      RouteHandlerParams
      RunApiOptions
      RunApiUserOptions
      RunningServerInfo
      ServerLogger
      ServerRequest
      ServerResponse
      ServerWebSocket
      StartApiServerOutput
      TeardownEndpointCase
      TestApiOptions
      TestCreateHostContext
      UserServerLogger
      WebSocketImplementation
      WebSocketImplementationParams
      WebSocketListenerImplementations
      WithWebSocketTestCallback
      defaultServerLogger
      runApiOptionsShape
      silentServerLogger
      attachApi
      buildHandlerParams
      createApiImplementor
      createRestVirHandlerErrorPrefix
      createServerLogger
      describeApi
      describeEndpoint
      extractRunningServerInfo
      finalizeOptions
      handleCors
      handleEndpointRequest
      handleHandlerOutput
      handleHandlerOutputWithoutSending
      handleRoute
      handleSearchParams
      handleWebSocketRequest
      implementApi
      match
      matchUrlToRoute
      preHandler
      rawMessageToString
      runPostRouteHook
      setRawServerResponseHeaders
      setServerResponseHeaders
      startApiServer
      testApi
      testEndpoint
      testExistingServer
      testWebSocket
      withWebSocketTest

      Internal

      CommonWebSocketState
      WebSocketLocation
      CommonWebSocket
      MockResponseBodyStream
      RejectRequestError
      RestVirHandlerError
      AllowedHeaders
      AllowedSearchParamValue
      AllowedSingleSearchParamValue
      AnyOrigin
      ApiDefinition
      ApiImplementation
      ApiImplementationStored
      ApiInit
      ApiRouteImplementations
      ApiTestSuite
      AssembleEndpointTestResult
      BaseCommonRouteDefinition
      BaseCreateHostContextParams
      BaseEndpointMethodDefinition
      BaseEndpointMethodImplementationParams
      BaseRequiredResponseHeaders
      BaseRoutePath
      BaseSearchParams
      BaseWebSocketDefinition
      BaseWebSocketImplementationParams
      BuildRoutePathOptions
      BuildRoutePathParams
      ClientFetch
      ClientWebSocket
      CommonRouteDefinition
      CommonRouteDefinitionWithRequiredCustomProps
      CommonWebSocketEventMap
      CommonWebSocketListenerOptions
      ConnectTestWebSocket
      ConnectWebSocketListeners
      CreateEndpointCaseTestParams
      CreateHostContext
      CreateHostContextBase
      CreateHostContextOutput
      CreateHostContextParams
      DefaultEndpointMethodStatusOutputs
      DefaultErrorResponseType
      DefaultOutgoingResponseHeadersType
      DefaultResponseHeadersType
      DefaultResponseType
      DefaultWebSocketProtocol
      DefinableHttpMethod
      DefinedEndpointFetchOutputResponseData
      DefinedEndpointFetchOutputs
      DefinedEndpointFetchStatusOutput
      DefinedEndpointFetchStreamOutputs
      DescribeEndpointParams
      EndpointCases
      EndpointCaseSuiteParams
      EndpointDefinition
      EndpointDefinitionMethods
      EndpointDefinitionResponseStatuses
      EndpointDefinitionWithRequiredCustomProps
      EndpointFetchParamObject
      EndpointFetchParams
      EndpointFromImplementation
      EndpointImplementation
      EndpointImplementationBase
      EndpointImplementationMethods
      EndpointImplementationStatusOutput
      EndpointMethodDefinedStatusOutputs
      EndpointMethodDefinition
      EndpointMethodDefinitionResponseStatuses
      EndpointMethodDefinitionWithRequiredCustomProps
      EndpointMethodImplementationErrorOutput
      EndpointMethodImplementationOutput
      EndpointMethodImplementationParams
      EndpointMethodImplementations
      EndpointMethodImplementationsBase
      EndpointRequestHeadersType
      EndpointResponseHeadersType
      EndpointResponseOutgoingHeadersType
      EndpointTestCase
      EndpointTestCasesArray
      ExtractEndpointMethodDefinition
      ExtractEndpointMethodDefinitionWithNoParam
      ExtractPathParams
      ExtractRequiredHeaderValue
      ExtractSearchParamValue
      FastifyPlugins
      FetchTestEndpoint
      FindPortOptions
      FlipWebSocketLocation
      GenericPathParams
      HandleDeclaredResponseStatusOverride
      HandleDeclaredResponseStatusOverrideParams
      HandledOutput
      HandleRouteOptions
      HasWildcardParam
      HostContextFromImplementation
      HostCreateContextParamsExtras
      HostEndpointParamsExtras
      HostWebSocketParamsExtras
      HttpMethodsWithBodies
      HttpStatusByKey
      IndividualEndpointTestCallback
      IndividualEndpointTestInputs
      IndividualEndpointTestResult
      IsOptionalSearchParamRequirement
      Match
      MatchedServicePath
      MatchFunction
      MatchResult
      MockCreateHostContext
      MockCreateHostContextParamsExtras
      MockEndpointImplementation
      MockEndpointMethodImplementations
      MockEndpointParamsExtras
      MockEndpointResponseOptions
      MockHostEndpointMap
      MockHostFetchOptions
      MockHostParams
      MockHostWebSocket
      MockHostWebSocketConstructorOptions
      MockHostWebSocketMap
      MockResponseParams
      MockWebSocketImplementation
      MockWebSocketListenerImplementations
      MockWebSocketParamsExtras
      NamedPathParams
      NoParam
      OriginCheckCallback
      OriginRequirement
      OriginRequirementResult
      OverwriteWebSocketMethods
      ParamData
      PathParams
      PostRouteHook
      PostRouteHookOutput
      PostRouteHookParams
      ResolveNamedParams
      ResolveShapeType
      ResolveWildcard
      ResponseDefinitions
      ResponseStatusDefinition
      RestVirRequestContext
      RouteHandler
      RouteHandlerParams
      RoutePathDefinition
      RouteSearchParamsType
      RunApiOptions
      RunApiUserOptions
      RunningServerInfo
      SearchParamRequirement
      SearchParamShape
      SearchParamShapeRuntimeType
      SearchParamsObjectType
      SendAndWaitForReplyParamObject
      ServerLogger
      ServerRequest
      ServerResponse
      ServerWebSocket
      SetNullishPropertiesAsOptional
      StartApiServerOutput
      TeardownEndpointCase
      TestApiOptions
      TestCreateHostContext
      UnknownFetchOutput
      UserServerLogger
      WebSocketClientMessageType
      WebSocketConnectParamObject
      WebSocketConnectParams
      WebSocketConnectProtocolRequirement
      WebSocketConnectProtocolType
      WebSocketConnectWebSocketConstructor
      WebSocketConnectWebSocketConstructorParams
      WebSocketDefinition
      WebSocketDefinitionWithRequiredCustomProps
      WebSocketHostMessageType
      WebSocketImplementation
      WebSocketImplementationBase
      WebSocketImplementationParams
      WebSocketListener
      WebSocketListenerImplementations
      WebSocketListenerImplementationsBase
      WebSocketListenerParams
      WebSocketLocationMessageType
      WebSocketSendAndWaitForReplyParams
      WebSocketSendMessageParams
      WithResponse
      WithWebSocketTestCallback
      AnyOrigin
      defaultServerLogger
      definableHttpMethods
      httpMethodsWithBodies
      httpStatusToKey
      NoParam
      restVirApiNameHeader
      runApiOptionsShape
      silentServerLogger
      assertValidWebSocketProtocols
      buildHandlerParams
      buildMethodNotAllowedMessage
      checkOriginRequirement
      condenseResponse
      consolidateHeaders
      createEndpointResponseOutput
      createMockFetch
      createMockHostFetch
      createMockHostWebSocketConstructor
      createMockResponse
      createRestVirHandlerErrorPrefix
      createServerLogger
      defaultHandleDeclaredResponseStatus
      extractEndpointMethodDefinition
      extractRequiredHeaders
      extractRunningServerInfo
      extractSearchParams
      finalizeClientWebSocket
      finalizeOptions
      findDevServerPort
      findLivePort
      getOppositeWebSocketLocation
      handleCors
      handleEndpointRequest
      handleHandlerOutput
      handleHandlerOutputWithoutSending
      handleRoute
      handleSearchParams
      handleWebSocketRequest
      headersToObject
      isFormDataShape
      isJsonContentType
      match
      matchesOriginRequirement
      matchesWebSocketProtocolRequirement
      matchUrlToRoute
      mergeHeaders
      overwriteWebSocketMethods
      parseJsonWithUndefined
      parseSecWebSocketProtocolHeader
      preHandler
      rawMessageToString
      readHeaderValue
      readResponseBodyAsText
      removeClientHeaders
      resolveMockHostContext
      runPostRouteHook
      setRawServerResponseHeaders
      setServerResponseHeaders
      testApi
      testExistingServer
      testWebSocket
      verifyWebSocketMessage
      waitForOpenWebSocket