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

toHttpEffect

Signature

declare const toHttpEffect: Effect.Effect<
  Effect.Effect<HttpServerResponse, never, Scope | HttpServerRequest>,
  never,
  Scope | MessageStorage | Sharding.Sharding | RpcSerialization.RpcSerialization
>

Source

Since v1.0.0

toHttpEffectWebsocket

Signature

declare const toHttpEffectWebsocket: Effect.Effect<
  Effect.Effect<HttpServerResponse, never, Scope | HttpServerRequest>,
  never,
  Scope | MessageStorage | Sharding.Sharding | RpcSerialization.RpcSerialization
>

Source

Since v1.0.0

Layers

layerClient

Signature

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

Source

Since v1.0.0

layerClientProtocolHttp

Signature

declare const layerClientProtocolHttp: (options: {
  readonly path: string
  readonly https?: boolean | undefined
}) => Layer.Layer<RpcClientProtocol, never, RpcSerialization.RpcSerialization | HttpClient.HttpClient>

Source

Since v1.0.0

layerClientProtocolHttpDefault

Signature

declare const layerClientProtocolHttpDefault: Layer.Layer<
  Runners.RpcClientProtocol,
  never,
  RpcSerialization.RpcSerialization | HttpClient.HttpClient
>

Source

Since v1.0.0

layerClientProtocolWebsocket

Signature

declare const layerClientProtocolWebsocket: (options: {
  readonly path: string
  readonly https?: boolean | undefined
}) => Layer.Layer<RpcClientProtocol, never, RpcSerialization.RpcSerialization | Socket.WebSocketConstructor>

Source

Since v1.0.0

layerClientProtocolWebsocketDefault

Signature

declare const layerClientProtocolWebsocketDefault: Layer.Layer<
  Runners.RpcClientProtocol,
  never,
  RpcSerialization.RpcSerialization | Socket.WebSocketConstructor
>

Source

Since v1.0.0

layerHttp

Signature

declare const layerHttp: Layer.Layer<
  Sharding.Sharding | Runners.Runners,
  never,
  | RunnerStorage
  | ShardingConfig.ShardingConfig
  | MessageStorage
  | RpcSerialization.RpcSerialization
  | RunnerHealth
  | HttpClient.HttpClient
  | HttpServer.HttpServer
>

Source

Since v1.0.0

layerHttpClientOnly

Signature

declare const layerHttpClientOnly: Layer.Layer<
  Sharding.Sharding | Runners.Runners,
  never,
  | RunnerStorage
  | ShardingConfig.ShardingConfig
  | MessageStorage
  | RpcSerialization.RpcSerialization
  | HttpClient.HttpClient
>

Source

Since v1.0.0

layerHttpOptions

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

Signature

declare const layerHttpOptions: (options: {
  readonly path: HttpRouter.PathInput
}) => Layer.Layer<
  Sharding.Sharding | Runners.Runners,
  never,
  | RunnerStorage
  | RunnerHealth
  | RpcSerialization.RpcSerialization
  | MessageStorage
  | ShardingConfig.ShardingConfig
  | Runners.RpcClientProtocol
  | HttpRouter.HttpRouter
>

Source

Since v1.0.0

layerWebsocket

Signature

declare const layerWebsocket: Layer.Layer<
  Sharding.Sharding | Runners.Runners,
  never,
  | RunnerStorage
  | ShardingConfig.ShardingConfig
  | MessageStorage
  | RpcSerialization.RpcSerialization
  | RunnerHealth
  | Socket.WebSocketConstructor
  | HttpServer.HttpServer
>

Source

Since v1.0.0

layerWebsocketClientOnly

Signature

declare const layerWebsocketClientOnly: Layer.Layer<
  Sharding.Sharding | Runners.Runners,
  never,
  | RunnerStorage
  | ShardingConfig.ShardingConfig
  | MessageStorage
  | RpcSerialization.RpcSerialization
  | Socket.WebSocketConstructor
>

Source

Since v1.0.0

layerWebsocketOptions

Signature

declare const layerWebsocketOptions: (options: {
  readonly path: HttpRouter.PathInput
}) => Layer.Layer<
  Sharding.Sharding | Runners.Runners,
  never,
  | ShardingConfig.ShardingConfig
  | Runners.RpcClientProtocol
  | MessageStorage
  | RunnerStorage
  | RunnerHealth
  | RpcSerialization.RpcSerialization
  | HttpRouter.HttpRouter
>

Source

Since v1.0.0