Skip to content

ShardingRegistrationEvent

6 exports Added in v1.0.0 Source

Constructors

EntityRegistered

Added in v1.0.0 Source

Signature

declare const EntityRegistered: ConstructorFrom<EntityRegistered, "_tag">;

SingletonRegistered

Added in v1.0.0 Source

Signature

declare const SingletonRegistered: ConstructorFrom<SingletonRegistered, "_tag">;

Models

EntityRegistered interface

Added in v1.0.0 Source

Represents an event that occurs when a new entity is registered with a runner.

Signature

interface EntityRegistered {
  readonly _tag: "EntityRegistered";
  readonly entity: Entity<any, any>;
}

ShardingRegistrationEvent type

Added in v1.0.0 Source

Represents events that can occur when a runner registers entities or singletons.

Signature

type ShardingRegistrationEvent = EntityRegistered | SingletonRegistered;

SingletonRegistered interface

Added in v1.0.0 Source

Represents an event that occurs when a new singleton is registered with a runner.

Signature

interface SingletonRegistered {
  readonly _tag: "SingletonRegistered";
  readonly address: SingletonAddress;
}

Pattern Matching

match

Added in v1.0.0 Source

Signature

declare const match: {
  <
    Cases extends {
      EntityRegistered: (args: EntityRegistered) => any;
      SingletonRegistered: (args: SingletonRegistered) => any;
    },
  >(
    cases: Cases,
  ): (
    value: ShardingRegistrationEvent,
  ) => Unify<ReturnType<Cases["EntityRegistered" | "SingletonRegistered"]>>;
  <
    Cases extends {
      EntityRegistered: (args: EntityRegistered) => any;
      SingletonRegistered: (args: SingletonRegistered) => any;
    },
  >(
    value: ShardingRegistrationEvent,
    cases: Cases,
  ): Unify<ReturnType<Cases["EntityRegistered" | "SingletonRegistered"]>>;
};