Function testApi

testApi<const Api extends Readonly<ApiImplementation>>(
    api: Readonly<Api>,
    testApiOptions?: Readonly<
        Omit<
            PartialWithUndefined<RunApiUserOptions>,
            "workerCount" | "preventWorkerRespawn",
        >,
    >,
): Promise<
    {
        connectWebSocket: ConnectTestWebSocket<Api>;
        fetchEndpoint: FetchTestEndpoint<Api>;
        server: Readonly<FastifyInstance>;
        kill(this: void): Promise<void>;
    },
>
Test your api with actual Request and Response objects! The returned object includes utilities for sending fetch requests and WebSocket connections to the api.

Make sure to use the kill method on the output after your tests are finished. To automatically kill the server, use describeApi instead.

By default, this uses Fastify's request injection strategy to avoid using up real system ports. To instead use an actual port, set port in the options parameter.
Type Parameters
- const Api extends Readonly<ApiImplementation>
Parameters
- api: Readonly<Api>
- testApiOptions: Readonly<
      Omit<
          PartialWithUndefined<RunApiUserOptions>,
          "workerCount" | "preventWorkerRespawn",
      >,
  > = {}
Returns Promise<
    {
        connectWebSocket: ConnectTestWebSocket<Api>;
        fetchEndpoint: FetchTestEndpoint<Api>;
        server: Readonly<FastifyInstance>;
        kill(this: void): Promise<void>;
    },
>
Example
```
import {testApi} from '@rest-vir/host';

const {connectWebSocket, kill, fetchEndpoint} = await testApi(myApiImplementation);

// run tests

await kill();
```
Package
@rest-vir/host
- Defined in packages/host/src/server/testing/test-api.ts:116

Function testApi

Type Parameters

Parameters

Returns Promise< { connectWebSocket: ConnectTestWebSocket<Api>; fetchEndpoint: FetchTestEndpoint<Api>; server: Readonly<FastifyInstance>; kill(this: void): Promise<void>; },>

Example

Package

Settings

Returns Promise<
{
connectWebSocket: ConnectTestWebSocket<Api>;
fetchEndpoint: FetchTestEndpoint<Api>;
server: Readonly<FastifyInstance>;
kill(this: void): Promise<void>;
},
>