Skip to content
Effect Days 2026 Get your ticket

ClusterError

9 exports Added in v1.0.0 Source

Errors

AlreadyProcessingMessage

Added in v1.0.0 Source

Represents an error that occurs when the entity is already processing a request.

Signature

declare class AlreadyProcessingMessage extends {
  [key: string]: any;
} & YieldableError<this> {
  [key: string]: any;
  constructor(...args: [props?: {
    [key: string]: any;
  }, options?: MakeOptions]);
  readonly [TypeId]: symbol;
  static is(u: unknown): u is AlreadyProcessingMessage;
}

EntityNotAssignedToRunner

Added in v1.0.0 Source

Represents an error that occurs when a Runner receives a message for an entity that it is not assigned to it.

Signature

declare class EntityNotAssignedToRunner extends {
  readonly _tag: "EntityNotAssignedToRunner";
  readonly address: EntityAddress;
} & YieldableError<this> {
  constructor(...args: [props: {
    readonly _tag?: "EntityNotAssignedToRunner";
    readonly address: EntityAddress;
  }, options?: MakeOptions]);
  readonly [TypeId]: symbol;
  static is(u: unknown): u is EntityNotAssignedToRunner;
}

MailboxFull

Added in v1.0.0 Source

Represents an error that occurs when the entities mailbox is full.

Signature

declare class MailboxFull extends {
  readonly _tag: "MailboxFull";
  readonly address: EntityAddress;
} & YieldableError<this> {
  constructor(...args: [props: {
    readonly _tag?: "MailboxFull";
    readonly address: EntityAddress;
  }, options?: MakeOptions]);
  readonly [TypeId]: symbol;
  static is(u: unknown): u is MailboxFull;
}

MalformedMessage

Added in v1.0.0 Source

Represents an error that occurs when a message fails to be properly deserialized by an entity.

Signature

declare class MalformedMessage extends {
  [key: string]: unknown;
  [key: number]: unknown;
  [key: symbol]: unknown;
  readonly _tag: "MalformedMessage";
} & YieldableError<this> {
  [key: string]: unknown;
  [key: number]: unknown;
  [key: symbol]: unknown;
  constructor(...args: [props: {
    [key: string]: unknown;
    [key: number]: unknown;
    [key: symbol]: unknown;
    readonly _tag: "MalformedMessage";
  }, options?: MakeOptions]);
  readonly [TypeId]: symbol;
  static refail: <A, E, R>(effect: Effect<A, E, R>) => Effect<A, MalformedMessage, R>;
  static is(u: unknown): u is MalformedMessage;
}

PersistenceError

Added in v1.0.0 Source

Represents an error that occurs when a message fails to be persisted into cluster's mailbox storage.

Signature

declare class PersistenceError extends {
  [key: string]: unknown;
  [key: number]: unknown;
  [key: symbol]: unknown;
  readonly _tag: "PersistenceError";
} & YieldableError<this> {
  [key: string]: unknown;
  [key: number]: unknown;
  [key: symbol]: unknown;
  constructor(...args: [props: {
    [key: string]: unknown;
    [key: number]: unknown;
    [key: symbol]: unknown;
    readonly _tag: "PersistenceError";
  }, options?: MakeOptions]);
  readonly [TypeId]: symbol;
  static refail<A, E, R>(effect: Effect<A, E, R>): Effect<A, PersistenceError, R>;
}

RunnerNotRegistered

Added in v1.0.0 Source

Represents an error that occurs when a Runner is not registered with the shard manager.

Signature

declare class RunnerNotRegistered extends {
  readonly _tag: "RunnerNotRegistered";
  readonly address: RunnerAddress;
} & YieldableError<this> {
  constructor(...args: [props: {
    readonly _tag?: "RunnerNotRegistered";
    readonly address: RunnerAddress;
  }, options?: MakeOptions]);
  readonly [TypeId]: symbol;
}

RunnerUnavailable

Added in v1.0.0 Source

Represents an error that occurs when a Runner is unresponsive.

Signature

declare class RunnerUnavailable extends {
  readonly _tag: "RunnerUnavailable";
  readonly address: RunnerAddress;
} & YieldableError<this> {
  constructor(...args: [props: {
    readonly _tag?: "RunnerUnavailable";
    readonly address: RunnerAddress;
  }, options?: MakeOptions]);
  readonly [TypeId]: symbol;
  static is(u: unknown): u is RunnerUnavailable;
}

Symbols

TypeId

Added in v1.0.0 Source

Signature

declare const TypeId: unique symbol

TypeId type

Added in v1.0.0 Source

Signature

type TypeId = typeof TypeId