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

NodeClusterRunnerSocket.ts overview

Since v1.0.0


Exports Grouped by Category


Layers

layer

Signature

declare const layer: <
  const ClientOnly extends boolean = false,
  const Storage extends "noop" | "sql" = "noop"
>(options?: {
  readonly serialization?: "msgpack" | "ndjson" | undefined
  readonly clientOnly?: ClientOnly | undefined
  readonly storage?: Storage | undefined
  readonly shardingConfig?: Partial<ShardingConfig.ShardingConfig["Type"]> | undefined
}) => ClientOnly extends true
  ? Layer.Layer<Sharding | Runners.Runners, ConfigError, Storage extends "sql" ? SqlClient : never>
  : Layer.Layer<
      Sharding | Runners.Runners,
      SocketServer.SocketServerError | ConfigError | (Storage extends "sql" ? SqlError : never),
      Storage extends "sql" ? SqlClient : never
    >

Source

Since v1.0.0

layerSocketServer

Signature

declare const layerSocketServer: Layer.Layer<
  SocketServer.SocketServer,
  SocketServer.SocketServerError,
  ShardingConfig.ShardingConfig
>

Source

Since v1.0.0