Skip to content
Effect Days 2026 Get your ticket

ShardingConfig

8 exports Added in v1.0.0 Source

Config

config

Added in v1.0.0 Source

Signature

declare const config: Config.Config<ShardingConfig["Type"]>

Signature

declare const configFromEnv: never

Defaults

defaults

Added in v1.0.0 Source

Signature

declare const defaults: ShardingConfig["Type"]

Signature

declare const layerDefaults: Layer.Layer<ShardingConfig>

Layers

layer

Added in v1.0.0 Source

Signature

declare function layer(options?: any): Layer<ShardingConfig>

layerFromEnv

Added in v1.0.0 Source

Signature

declare function layerFromEnv(options?: any): Layer<ShardingConfig, ConfigError>

Models

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

Signature

declare class ShardingConfig extends any {
constructor();
}

Shard Groups

Normalizes the provided ShardingConfig to calculate the available and assigned shard groups.

Signature

declare function shardGroupConfig(config: any): {
readonly assigned: ReadonlySet<string>;
readonly available: ReadonlySet<string>;
}