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

ShardingConfig.ts overview

Since v1.0.0

Exports Grouped by Category

Config

config

Signature

declare const config: Config.Config<{
  readonly runnerAddress: Option.Option<RunnerAddress>
  readonly serverVersion: number
  readonly numberOfShards: number
  readonly shardManagerAddress: RunnerAddress
  readonly shardManagerUnavailableTimeout: DurationInput
  readonly entityMailboxCapacity: number | "unbounded"
  readonly entityMaxIdleTime: DurationInput
  readonly entityTerminationTimeout: DurationInput
  readonly entityMessagePollInterval: DurationInput
  readonly entityReplyPollInterval: DurationInput
  readonly refreshAssignmentsInterval: DurationInput
  readonly sendRetryInterval: DurationInput
  readonly simulateRemoteSerialization: boolean
}>

Source

Since v1.0.0

configFromEnv

Signature

declare const configFromEnv: Effect.Effect<
  {
    readonly runnerAddress: Option.Option<RunnerAddress>
    readonly serverVersion: number
    readonly numberOfShards: number
    readonly shardManagerAddress: RunnerAddress
    readonly shardManagerUnavailableTimeout: DurationInput
    readonly entityMailboxCapacity: number | "unbounded"
    readonly entityMaxIdleTime: DurationInput
    readonly entityTerminationTimeout: DurationInput
    readonly entityMessagePollInterval: DurationInput
    readonly entityReplyPollInterval: DurationInput
    readonly refreshAssignmentsInterval: DurationInput
    readonly sendRetryInterval: DurationInput
    readonly simulateRemoteSerialization: boolean
  },
  ConfigError,
  never
>

Source

Since v1.0.0

Layers

layer

Signature

declare const layer: (options?: Partial<ShardingConfig["Type"]>) => Layer.Layer<ShardingConfig>

Source

Since v1.0.0

layerFromEnv

Signature

declare const layerFromEnv: (
  options?: Partial<ShardingConfig["Type"]> | undefined
) => Layer.Layer<ShardingConfig, ConfigError>

Source

Since v1.0.0

defaults

defaults

Signature

declare const defaults: {
  readonly runnerAddress: Option.Option<RunnerAddress>
  readonly serverVersion: number
  readonly numberOfShards: number
  readonly shardManagerAddress: RunnerAddress
  readonly shardManagerUnavailableTimeout: DurationInput
  readonly entityMailboxCapacity: number | "unbounded"
  readonly entityMaxIdleTime: DurationInput
  readonly entityTerminationTimeout: DurationInput
  readonly entityMessagePollInterval: DurationInput
  readonly entityReplyPollInterval: DurationInput
  readonly refreshAssignmentsInterval: DurationInput
  readonly sendRetryInterval: DurationInput
  readonly simulateRemoteSerialization: boolean
}

Source

Since v1.0.0

layerDefaults

Signature

declare const layerDefaults: Layer.Layer<ShardingConfig, never, never>

Source

Since v1.0.0

models

ShardingConfig (class)

Represents the configuration for the Sharding service on a given runner.

Signature

declare class ShardingConfig

Source

Since v1.0.0