Type Alias TestApp<Ctx, Ports, TProvidedHeaders>

Beignet app harness for route/runtime tests.

type TestApp<
    Ctx,
    Ports extends AnyPorts,
    TProvidedHeaders extends string = never,
> = {
    contracts: FetchServer<Ctx, Ports>["contracts"];
    fetch: typeof fetch;
    ports: Ports;
    request: <CLike extends ContractLike>(
        contract: CLike,
        ...args: CallArgs<ResolveContract<CLike>, TProvidedHeaders>,
    ) => Promise<InferSuccessResponse<ResolveContract<CLike>>>;
    safeRequest: <CLike extends ContractLike>(
        contract: CLike,
        ...args: CallArgs<ResolveContract<CLike>, TProvidedHeaders>,
    ) => Promise<
        EndpointResult<
            ResolveContract<CLike>,
            InferEndpointContractError<ResolveContract<CLike>>,
        >,
    >;
    server: FetchServer<Ctx, Ports>;
    stop: () => Promise<void>;
}

Properties

Contracts registered through the server route list.

fetch: typeof fetch

Fetch implementation bound to the in-memory Beignet server.

ports: Ports

Final app ports after provider setup.

request: <CLike extends ContractLike>(
contract: CLike,
...args: CallArgs<ResolveContract<CLike>, TProvidedHeaders>,
) => Promise<InferSuccessResponse<ResolveContract<CLike>>>

Call a contract through the test app and return the parsed success body.

safeRequest: <CLike extends ContractLike>(
    contract: CLike,
    ...args: CallArgs<ResolveContract<CLike>, TProvidedHeaders>,
) => Promise<
    EndpointResult<
        ResolveContract<CLike>,
        InferEndpointContractError<ResolveContract<CLike>>,
    >,
>

Call a contract through the test app and return a typed success/error result instead of throwing.

Underlying Web Fetch server.

stop: () => Promise<void>

Stop installed providers.