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

Route overview

Create @effect/platform/Http/Router Router

Added in v1.0.0


Table of contents


constructors

fromEndpoint

Signature

export declare const fromEndpoint: <Endpoint extends ApiEndpoint.ApiEndpoint.Any, R, E>(
  fn: HandlerFunction<Endpoint, R, E>,
  options?: Partial<RouterBuilder.Options>
) => (endpoint: Endpoint) => Router.Route<Exclude<E, HttpError.HttpError>, R>

Added in v1.0.0

make

Signature

export declare const make: <A extends Api.Api.Any, Id extends Api.Api.Ids<A>, R, E>(
  id: Id,
  fn: HandlerFunction<Api.Api.EndpointById<A, Id>, R, E>,
  options?: Partial<RouterBuilder.Options>
) => (api: A) => Router.Route<Exclude<E, HttpError.HttpError>, R>

Added in v1.0.0

models

HandlerFunction (type alias)

Signature

export type HandlerFunction<Endpoint extends ApiEndpoint.ApiEndpoint.Any, R, E> = (
  request: ToRequest<ApiEndpoint.ApiEndpoint.Request<Endpoint>>,
  security: ToSecurity<ApiEndpoint.ApiEndpoint.Security<Endpoint>>
) => Effect.Effect<ToResponse<utils.FilterNon200Responses<ApiEndpoint.ApiEndpoint.Response<Endpoint>>>, E, R>

Added in v1.0.0