DeliverAt.ts

DeliverAt.ts overview

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.

Since v4.0.0

---

Exports Grouped by Category

• accessors
  • toMillis
• guards
  • isDeliverAt
• models
  • DeliverAt (interface)
• symbols
  • symbol

---

accessors

toMillis

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

Signature

declare const toMillis: (self: unknown) => number | null

Source

Since v4.0.0

guards

isDeliverAt

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

Signature

declare const isDeliverAt: (self: unknown) => self is DeliverAt

Source

Since v4.0.0

models

DeliverAt (interface)

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

Signature

export interface DeliverAt {
  [symbol](): DateTime
}

Source

Since v4.0.0

symbols

symbol

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"

Source

Since v4.0.0