DeliverAt

The DeliverAt module defines the protocol used by cluster message payloads that carry their own scheduled delivery time. A value implements the protocol by exposing a method at the DeliverAt symbol that returns the target DateTime.

4 exports Added in v4.0.0 Source

Accessors

toMillis

Added in v4.0.0 Source

Returns the scheduled delivery time in epoch milliseconds when the value implements DeliverAt, or null otherwise.

Signature

declare function toMillis(self: unknown): number | null

Guards

isDeliverAt

Added in v4.0.0 Source

Returns true if the value implements the DeliverAt scheduled-delivery protocol.

Signature

declare function isDeliverAt(self: unknown): self is DeliverAt

Models

DeliverAt interface

Added in v4.0.0 Source

Interface for payloads that specify when a cluster message should be delivered by returning the target delivery DateTime through the DeliverAt symbol method.

Signature

interface DeliverAt {
  "~effect/cluster/DeliverAt"(): DateTime;
}

Symbols

symbol

Added in v4.0.0 Source

Defines the property key used by values that provide a scheduled delivery time.

When to use

Use to implement the scheduled-delivery protocol on cluster message payloads by defining a method at this property key.

Signature

declare const symbol: "~effect/cluster/DeliverAt"