Function testEndpoint

testEndpoint<
    const EndpointImplementationToTest extends
        Readonly<
            {
                definition: Readonly<EndpointDefinition>;
                implementation: object;
                isEndpoint: true;
                isWebSocket: false;
                path: string;
            },
        >,
    const Endpoint extends
        EndpointDefinition = EndpointFromImplementation<
        EndpointImplementationToTest,
    >,
    const Method extends
        "GET"
        | "PUT"
        | "POST"
        | "DELETE"
        | "PATCH"
        | "TRACE" = EndpointDefinitionMethods<NoInfer<Endpoint>>,
>(
    endpoint: EndpointImplementationToTest,
    method: Method,
    createHostContext: CreateHostContext<
        HostContextFromImplementation<EndpointImplementationToTest>,
    >,
    ...restParams: EndpointFetchParams<NoInfer<Endpoint>, NoInfer<Method>>,
): Promise<Response>
Test your endpoint with real Request and Response objects.
Type Parameters
- const EndpointImplementationToTest extends Readonly<
      {
          definition: Readonly<EndpointDefinition>;
          implementation: object;
          isEndpoint: true;
          isWebSocket: false;
          path: string;
      },
  >
- const Endpoint extends EndpointDefinition = EndpointFromImplementation<EndpointImplementationToTest>
- const Method extends "GET" | "PUT" | "POST" | "DELETE" | "PATCH" | "TRACE" = EndpointDefinitionMethods<NoInfer<Endpoint>>
Parameters
- endpoint: EndpointImplementationToTest
- method: Method
- createHostContext: CreateHostContext<HostContextFromImplementation<EndpointImplementationToTest>>
- ...restParams: EndpointFetchParams<NoInfer<Endpoint>, NoInfer<Method>>
Returns Promise<Response>
Example
```
import {testEndpoint} from '@rest-vir/host';
import {HttpMethod} from '@rest-vir/api';

const response = await testEndpoint(
    myApiImplementation.implementation.endpoints['/my-endpoint'],
    HttpMethod.Get,
    () => ({context: undefined}),
);
```
Package
@rest-vir/host
- Defined in packages/host/src/server/testing/test-endpoint.ts:60

Function testEndpoint

Type Parameters

Parameters

Returns Promise<Response>

Example

Package

Settings