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

App overview

Added in v1.0.0


Table of contents


combinators

toHandled

Signature

export declare const toHandled: <E, R, _, RH>(
  self: Default<E, R>,
  handleResponse: (
    request: ServerRequest.ServerRequest,
    exit: Exit.Exit<ServerResponse.ServerResponse, ServerError.ResponseError | E>
  ) => Effect.Effect<_, never, RH>,
  middleware?: Middleware | undefined
) => Default<ServerError.ResponseError | E, Exclude<R, Scope.Scope> | Exclude<RH, Scope.Scope>>

Added in v1.0.0

conversions

toWebHandler

Signature

export declare const toWebHandler: <E>(self: Default<E, Scope.Scope>) => (request: Request) => Promise<Response>

Added in v1.0.0

toWebHandlerLayer

Signature

export declare const toWebHandlerLayer: <R, E, RE>(
  self: Default<E, any>,
  layer: Layer.Layer<R, RE>
) => { readonly close: () => Promise<void>; readonly handler: (request: Request) => Promise<Response> }

Added in v1.0.0

toWebHandlerRuntime

Signature

export declare const toWebHandlerRuntime: <R>(
  runtime: Runtime.Runtime<R>
) => <E>(self: Default<E, any>) => (request: Request) => Promise<Response>

Added in v1.0.0

fiber refs

appendPreResponseHandler

Signature

export declare const appendPreResponseHandler: (handler: PreResponseHandler) => Effect.Effect<void>

Added in v1.0.0

currentPreResponseHandlers

Signature

export declare const currentPreResponseHandlers: FiberRef.FiberRef<Option.Option<PreResponseHandler>>

Added in v1.0.0

withPreResponseHandler

Signature

export declare const withPreResponseHandler: any

Added in v1.0.0

models

Default (type alias)

Signature

export type Default<E = never, R = never> = HttpApp<ServerResponse.ServerResponse, E, R>

Added in v1.0.0

HttpApp (interface)

Signature

export interface HttpApp<A = ServerResponse.ServerResponse, E = never, R = never>
  extends Effect.Effect<A, E, R | ServerRequest.ServerRequest> {}

Added in v1.0.0

PreResponseHandler (type alias)

Signature

export type PreResponseHandler = (
  request: ServerRequest.ServerRequest,
  response: ServerResponse.ServerResponse
) => Effect.Effect<ServerResponse.ServerResponse, ServerError.ResponseError>

Added in v1.0.0