Skip to main content Link Search Menu Expand Document (external link)
effect-http

NodeTesting overview

Testing of the Server implementation.

Added in v1.0.0

Table of contents

constructors

make

Create a testing client for the Server.

Signature

export declare const make: <R, E, A extends Api.Api.Any>(
  app: HttpServer.app.Default<E, R>,
  api: A,
  options?: any
) => Effect.Effect<
  Client.Client<A>,
  never,
  | Scope.Scope
  | Exclude<
      Exclude<
        Exclude<
          Exclude<R, Scope.Scope | HttpServer.request.ServerRequest>,
          HttpServer.server.Server | HttpServer.platform.Platform | HttpServer.etag.Generator | NodeContext.NodeContext
        >,
        SwaggerRouter.SwaggerFiles
      >,
      NodeContext.NodeContext
    >
>

Added in v1.0.0

makeRaw

Create a testing client for the Server. Instead of the Client.Client interface it returns a raw @effect/platform/Http/Client Client with base url set.

Signature

export declare const makeRaw: <R, E>(
  app: HttpServer.app.Default<E, R>
) => Effect.Effect<
  HttpClient.client.Client<HttpClient.response.ClientResponse, HttpClient.error.HttpClientError, Scope.Scope>,
  never,
  | Scope.Scope
  | Exclude<
      Exclude<
        Exclude<
          Exclude<R, Scope.Scope | HttpServer.request.ServerRequest>,
          HttpServer.server.Server | HttpServer.platform.Platform | HttpServer.etag.Generator | NodeContext.NodeContext
        >,
        SwaggerRouter.SwaggerFiles
      >,
      NodeContext.NodeContext
    >
>

Added in v1.0.0