Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/fx

RefHashRing.getShards

Get shard distribution across nodes.

Package version
2.0.0-beta.7
Category
Derived queries
Since
1.18.0
Member of
RefHashRing

Import

import { RefHashRing } from "@typed/fx";

Access RefHashRing.getShards through the imported RefHashRing export. Its declaration below describes the member.

This public exposure is a re-export. Its import path is supported; declaration documentation is shared with the other public exposures below.

Signatures

export declare const getShards: {
    (count: number): <A extends PrimaryKey.PrimaryKey, E, R>(ref: RefHashRing<A, E, R>) => RefSubject.Computed<Array<A> | undefined, E, R>;
    <A extends PrimaryKey.PrimaryKey, E, R>(ref: RefHashRing<A, E, R>, count: number): RefSubject.Computed<Array<A> | undefined, E, R>;
};

Why

Projects the shard distribution for current reads and later pushes. An empty ring is represented by undefined inside the Computed value; it does not become Filtered or add NoSuchElementError.

Ownership and lifetime

The get shards view retains no independent state. An Effect read samples the source once; Fx observation follows later pushes and its observing Scope owns subscription cleanup.

Other public imports

These import paths expose the same declaration. Each page retains its own public name and signature.

Source