HttpApiTest.ts

HttpApiTest.ts overview

Tests HttpApi implementations through an in-memory generated client.

The helpers use the same request encoding, routing, response encoding, and client decoding as the normal HttpApiBuilder and HttpApiClient pipeline, but they do not start an HTTP server. This is useful for focused handler tests, schema round trips, middleware behavior, and typed client calls.

Since v4.0.0

---

Exports Grouped by Category

• testing
  • groups

---

testing

groups

Creates an in-memory client for testing selected groups of an HttpApi.

Details

Handlers for the selected groups are taken from the environment; unselected groups are wired with placeholder handlers that fail if called.

Signature

declare const groups: <
  ApiId extends string,
  Groups extends HttpApiGroup.Any,
  const Names extends ReadonlyArray<HttpApiGroup.Name<Groups>>,
  SelectedGroups = Extract<Groups, { readonly identifier: Names[number] }>
>(
  api: HttpApi.HttpApi<ApiId, Groups>,
  groupNames: Names,
  options?: { readonly baseUrl?: string | URL | undefined } | undefined
) => Effect.Effect<
  Simplify<
    {
      readonly [Group in Extract<
        Groups,
        { readonly topLevel: false }
      > as HttpApiGroup.Name<Group>]: HttpApiClient.Client.Group<Group, Group["identifier"], never, never>
    } & { readonly [Method in HttpApiClient.Client.TopLevelMethods<Groups, never, never> as Method[0]]: Method[1] }
  >,
  never,
  | Scope
  | Path
  | FileSystem
  | HttpApiGroup.ToService<ApiId, SelectedGroups>
  | HttpApiEndpoint.Middleware<HttpApiGroup.Endpoints<Groups>>
  | MiddlewareClient<HttpApiEndpoint.Middleware<HttpApiGroup.Endpoints<Groups>>>
  | Generator
  | HttpPlatform
>

Source

Since v4.0.0