EntityAddress.ts overview

Since v1.0.0

Exports Grouped by Category

• constructors
  • make
• models
  • EntityAddress (class)
    • [Equal.symbol] (method)
    • [Hash.symbol] (method)
    • [TypeId] (property)
• schemas
  • EntityAddressFromSelf
• type ids
  • TypeId
  • TypeId (type alias)

constructors

make

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 v1.0.0

[Equal.symbol] (method)

Signature

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

Source

Since v1.0.0

[Hash.symbol] (method)

Signature

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

Source

Since v1.0.0

[TypeId] (property)

Signature

readonly [TypeId]: symbol

Source

Since v1.0.0

schemas

EntityAddressFromSelf

Represents the unique address of an entity within the cluster.

Signature

declare const EntityAddressFromSelf: Schema.Schema<EntityAddress, EntityAddress, never>

Source

Since v1.0.0

type ids

TypeId

Signature

declare const TypeId: unique symbol

Source

Since v1.0.0

TypeId (type alias)

Signature

type TypeId = typeof TypeId

Source

Since v1.0.0