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

ShardingConfig overview

Added in v1.0.0


Table of contents


context

ShardingConfig

Signature

export declare const ShardingConfig: Context.Tag<ShardingConfig, ShardingConfig>

Added in v1.0.0

layers

defaults

Provides the default values for the ShardingConfig.

Signature

export declare const defaults: Layer.Layer<ShardingConfig>

Added in v1.0.0

fromConfig

Reads the ShardingConfig from the effect/ConfigProvider

Signature

export declare const fromConfig: Layer.Layer<ShardingConfig, ConfigError.ConfigError>

Added in v1.0.0

withDefaults

Provides the ShardingConfig, values that are omitted will be read from the defaults

Signature

export declare const withDefaults: (customs: Partial<ShardingConfig>) => Layer.Layer<ShardingConfig>

Added in v1.0.0

models

ShardingConfig (interface)

Sharding configuration

Signature

export interface ShardingConfig {
  readonly numberOfShards: number
  readonly selfHost: string
  readonly shardingPort: number
  readonly shardManagerUri: string
  readonly serverVersion: string
  readonly entityMaxIdleTime: Duration.Duration
  readonly entityTerminationTimeout: Duration.Duration
  readonly refreshAssignmentsRetryInterval: Duration.Duration
  readonly unhealthyPodReportInterval: Duration.Duration
}

Added in v1.0.0

symbols

ShardingConfigTypeId

Signature

export declare const ShardingConfigTypeId: typeof ShardingConfigTypeId

Added in v1.0.0

ShardingConfigTypeId (type alias)

Signature

export type ShardingConfigTypeId = typeof ShardingConfigTypeId

Added in v1.0.0