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

HttpRunner.ts overview

Since v1.0.0

Exports Grouped by Category

Http App

toHttpApp

Signature

declare const toHttpApp: Effect.Effect<HttpApp.Default<never, Scope>, never, any>

Source

Since v1.0.0

toHttpAppWebsocket

Signature

declare const toHttpAppWebsocket: Effect.Effect<HttpApp.Default<never, Scope>, never, any>

Source

Since v1.0.0

Layers

layer

A HTTP layer for the Runners services, that adds a route to the provided HttpRouter.Tag.

By default, it uses the HttpRouter.Default tag.

Signature

declare const layer: <I = HttpRouter.Default>(options: {
  readonly path: HttpRouter.PathInput
  readonly routerTag?: HttpRouter.HttpRouter.TagClass<I, string, any, any>
  readonly logAddress?: boolean | undefined
}) => Layer.Layer<
  Sharding.Sharding | Runners.Runners,
  never,
  | RpcSerialization.RpcSerialization
  | ShardingConfig.ShardingConfig
  | Runners.RpcClientProtocol
  | HttpServer.HttpServer
  | MessageStorage
  | ShardStorage
>

Source

Since v1.0.0

layerClient

Signature

declare const layerClient: Layer.Layer<
  Sharding.Sharding | Runners.Runners,
  never,
  ShardStorage | MessageStorage | ShardingConfig.ShardingConfig | Runners.RpcClientProtocol
>

Source

Since v1.0.0

layerHttp

Signature

declare const layerHttp: Layer.Layer<Sharding.Sharding | Runners.Runners, never, any>

Source

Since v1.0.0

layerHttpClientOnly

Signature

declare const layerHttpClientOnly: Layer.Layer<Sharding.Sharding | Runners.Runners, never, any>

Source

Since v1.0.0

layerWebsocket

Signature

declare const layerWebsocket: Layer.Layer<Sharding.Sharding | Runners.Runners, never, any>

Source

Since v1.0.0

layerWebsocketClientOnly

Signature

declare const layerWebsocketClientOnly: Layer.Layer<Sharding.Sharding | Runners.Runners, never, any>

Source

Since v1.0.0

layerWebsocketOptions

Signature

declare const layerWebsocketOptions: <I = HttpRouter.Default>(options: {
  readonly path: HttpRouter.PathInput
  readonly routerTag?: HttpRouter.HttpRouter.TagClass<I, string, any, any>
  readonly logAddress?: boolean | undefined
}) => Layer.Layer<
  Sharding.Sharding | Runners.Runners,
  never,
  | RpcSerialization.RpcSerialization
  | ShardingConfig.ShardingConfig
  | Runners.RpcClientProtocol
  | HttpServer.HttpServer
  | MessageStorage
  | ShardStorage
>

Source

Since v1.0.0