SingletonAddress.ts

SingletonAddress.ts overview

The SingletonAddress module models the runtime address assigned to a cluster singleton registration. The address pairs the singleton name with the ShardId selected from that name and its shard group, giving sharding one stable value for registration events, equality, hashing, and local singleton fiber tracking.

Since v4.0.0

---

Exports Grouped by Category

• address
  • SingletonAddress (class)
    • [Hash.symbol] (method)
    • [Equal.symbol] (method)
    • [TypeId] (property)

---

address

SingletonAddress (class)

Represents the unique address of an singleton within the cluster.

Signature

declare class SingletonAddress

Source

Since v4.0.0

[Hash.symbol] (method)

Computes a structural hash from the singleton name and shard id.

Signature

declare const [Hash.symbol]: () => number

Source

Since v4.0.0

[Equal.symbol] (method)

Compares singleton addresses by name and shard id.

Signature

declare const [Equal.symbol]: (that: SingletonAddress) => boolean

Source

Since v4.0.0

[TypeId] (property)

Marks this value as a cluster singleton address for runtime guards.

Signature

readonly [TypeId]: "~effect/cluster/SingletonAddress"

Source

Since v4.0.0