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

ShardManager.ts overview

Since v1.0.0


Exports Grouped by Category


Client

ShardManagerClient (class)

Represents a client which can be used to communicate with the ShardManager.

Signature

declare class ShardManagerClient

Source

Since v1.0.0

layerClientLocal

Signature

declare const layerClientLocal: Layer.Layer<ShardManagerClient, never, ShardingConfig>

Source

Since v1.0.0

layerClientRpc

Signature

declare const layerClientRpc: Layer.Layer<ShardManagerClient, never, ShardingConfig | RpcClientProtocol>

Source

Since v1.0.0

makeClientLocal

Signature

declare const makeClientLocal: any

Source

Since v1.0.0

makeClientRpc

Signature

declare const makeClientRpc: Effect.Effect<any, never, any>

Source

Since v1.0.0

Config

Config (class)

Signature

declare class Config

Source

Since v1.0.0

configConfig

Signature

declare const configConfig: Config_.Config<any>

Source

Since v1.0.0

configFromEnv

Signature

declare const configFromEnv: Effect.Effect<any, ConfigError>

Source

Since v1.0.0

layerConfig

Signature

declare const layerConfig: (config?: Partial<Config["Type"]>) => Layer.Layer<Config>

Source

Since v1.0.0

layerConfigFromEnv

Signature

declare const layerConfigFromEnv: Layer.Layer<Config, ConfigError>

Source

Since v1.0.0

Constructors

make

Signature

declare const make: any

Source

Since v1.0.0

Rpcs

Rpcs (class)

The messaging protocol for the ShardManager.

Signature

declare class Rpcs

Source

Since v1.0.0

Server

layerServer

Signature

declare const layerServer: Layer.Layer<never, never, any>

Source

Since v1.0.0

layerServerHandlers

Signature

declare const layerServerHandlers: any

Source

Since v1.0.0

layer

layer

Signature

declare const layer: Layer.Layer<ShardManager, never, ShardStorage | ShardingConfig | RunnerHealth | Config | Runners>

Source

Since v1.0.0

models

ShardManager (class)

Signature

declare class ShardManager

Source

Since v1.0.0

ShardingEvent

Signature

declare const ShardingEvent: any

Source

Since v1.0.0

ShardingEvent (type alias)

Signature

type ShardingEvent = Data.TaggedEnum<{
  StreamStarted: {}
  ShardsAssigned: {
    address: RunnerAddress
    shards: ReadonlyArray<ShardId>
  }
  ShardsUnassigned: {
    address: RunnerAddress
    shards: ReadonlyArray<ShardId>
  }
  RunnerRegistered: { address: RunnerAddress }
  RunnerUnregistered: { address: RunnerAddress }
}>

Source

Since v1.0.0

ShardingEventSchema

Signature

declare const ShardingEventSchema: Schema.Schema<
  Data.TaggedEnum<{
    StreamStarted: {}
    ShardsAssigned: { address: RunnerAddress; shards: ReadonlyArray<ShardId> }
    ShardsUnassigned: { address: RunnerAddress; shards: ReadonlyArray<ShardId> }
    RunnerRegistered: { address: RunnerAddress }
    RunnerUnregistered: { address: RunnerAddress }
  }>,
  any
>

Source

Since v1.0.0