EntityAddress.ts

EntityAddress.ts overview

The EntityAddress module defines the value used to locate an entity within a cluster. An address combines the entity type, entity id, and shard id so messages, persisted envelopes, workflow executions, and entity managers can agree on the same routing target.

Since v4.0.0

---

Exports Grouped by Category

• constructors
  • make
• models
  • EntityAddress (class)
    • toString (method)
    • [Equal.symbol] (method)
    • [Hash.symbol] (method)
    • [TypeId] (property)

---

constructors

make

Constructs an EntityAddress from a shard ID, entity type, and entity ID.

When to use

Use to create the routing target for a known entity type and entity id after resolving that id to the ShardId assigned by the entity’s shard group.

Details

The returned EntityAddress stores the supplied shardId, entityType, and entityId. Equality and hashing include all three fields.

Gotchas

make does not choose the shard for an entity. Use the same shard group logic as the entity definition; a different shardId makes a different address even when the entity type and entity id match.

See

• EntityAddress for the equality, hashing, and string formatting behavior of constructed addresses
• ShardId for the shard identifier included in the address

Signature

declare const make: (options: {
  readonly shardId: ShardId
  readonly entityType: EntityType
  readonly entityId: EntityId
}) => EntityAddress

Source

Since v4.0.0

models

EntityAddress (class)

Represents the unique address of an entity within the cluster.

Signature

declare class EntityAddress

Source

Since v4.0.0

toString (method)

Formats the entity type, entity id, and shard id as a readable address.

Signature

declare const toString: () => string

Source

Since v4.0.0

[Equal.symbol] (method)

Compares entity addresses by entity type, entity id, and shard id.

Signature

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

Source

Since v4.0.0

[Hash.symbol] (method)

Computes a structural hash from the entity type, entity id, and shard id.

Signature

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

Source

Since v4.0.0

[TypeId] (property)

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

Signature

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

Source

Since v4.0.0