Skip to content
actor-ts
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
English
English
Deutsch
Español
Français
日本語
한국어
Português (BR)
Русский
简体中文
Menu
🚀 Get Started
What is actor-ts?
Why actors?
Installation
Quickstart
Learning path
Glossary
🎭 Build Actors
Fundamentals
Overview
Actor
Messages
Ask pattern
ActorSystem
Actor paths
Spawning actors
Become and stash
Death watch
Supervision
Dispatchers
Parallelism
Blocking and CPU-bound work
Mailboxes
Throttling
Timers and scheduling
Receive timeout
Coordinated shutdown
Event stream
Logging
PoisonPill and Kill
Pattern matching
Typed actors
Overview
TypedActor
Behaviors
Spawning typed
Routing
Overview
Router
Strategies
Scatter/gather
Pool vs group
Patterns
Circuit breaker
Backoff supervisor
Backoff policy
Retry
Future patterns
🌐 Distribute
Cluster
Overview
Joining and seeds
Cluster bootstrap
Failure detector
Downing strategies
Transports
Weakly-up
Refs across nodes
Distributed PubSub
Cluster event stream
Singleton
Overview
Manager
With lease
Sharding
Overview
Introspection
Allocation strategy
Rebalance
Remember entities
With lease
Sharded daemon
Cluster router
Cluster client
Cluster security
Worker mesh
Distributed Data
Overview
CRDT types
Counters
Registers
Sets
Maps
Designing data
Replication
Quorum reads/writes
Durable storage
Coordination
Overview
Lease API
In-memory lease
Kubernetes lease
Discovery
Overview
Seed providers
Config
DNS
Kubernetes API
Aggregate
Receptionist
💾 Persist
Event sourcing
Overview
PersistentActor
Event dispatcher
Snapshots
Durable state
Projections
Persistence query
Push-based query
Journals
In-memory
SQLite
Cassandra
PostgreSQL
MariaDB
libSQL / Turso
SQL Server
Cloudflare D1
DynamoDB
MongoDB
Wire-compatible databases
Snapshot stores
In-memory
SQLite
Cassandra
Cached snapshot store
Replicated event sourcing
Overview
Single-writer lease
Vector clocks
Conflict resolver
Snapshotting
Object storage
Overview
Compression
Encryption
Key rotation
Per-actor policies
Snapshot store backend
Migration
Overview
Recipes
Schema registry
Envelope format
Defaults adapter
Migrating adapter
Wrap legacy
FSM
Overview
In-memory FSM
Persistent FSM
Delivery
Overview
Producer controller
Consumer controller
Ack semantics
🔌 Integrate
IO (brokers)
Overview
BrokerActor base
Kafka
MQTT
AMQP
NATS
NATS JetStream
JetStream KV + Object Store
Redis Streams
gRPC
SSE
WebSocket client
TCP
UDP
Email bridge
HTTP
Overview
Route DSL
WebSocket server
Marshalling
Error handling
HTML & XSS
Static files
Backends
Fastify
Express
Hono
Middleware
Response cache
Rate limit
Idempotency key
CORS
CSRF
Security headers
CSP
Basic auth
Bearer token
JWT auth
IP allowlist
Request ID
Timeout
Security
Cache
Overview
In-memory
Memcached
Redis
Serialization
Overview
JSON
CBOR
Custom serializers
📊 Observe
Overview
Metrics
Core metrics
Prometheus exporter
prom-client adapter
Stock metrics
Logging
Multi-sink logging
File sink
Platform integrations
Tracing
Tracer API
OTel adapter
Recording tracer
Actor tracing
Management
Overview
Health checks
HTTP endpoints
DevTools
Overview
Actors & cluster
Tracing panel
Explain plan
Time travel
Profiler
Send message
Configuration
Event stream
Dead letters
Tap protocol
✅ Test
Overview
TestKit
TestProbe
ManualScheduler
MultiNodeSpec
ParallelMultiNodeSpec
Diagnosing flakes
⚙️ Operate
Overview
Deployment
Kubernetes
Docker Compose
Process manager
Tuning
Gossip cadence
Failure detector
Mailbox sizing
Dispatcher tuning
Security
Cluster security
Master key rotation
TLS everywhere
Supply chain
Upgrades
Rolling migration
Upgrade strategies
Dead letters
Troubleshooting
Runtime
Overview
Compatibility matrix
Bun
Node
Deno
💡 Examples
Overview
Chat sample
Voice sample
Stand-alone snippets
🚚 Migration
Overview
From Akka (JVM)
From Pekko
From Orleans
From Akka.NET
From vanilla TS
📖 Reference
Configuration
Full reference.conf
Utilities
Version policy
Benchmarks
FAQ
Glossary
🧰 API Reference
Enumerations
Directive
LogLevel
Classes
Actor
ActorInitializationError
ActorKilledError
ActorLifecycleEvent
ActorOptionsBuilder
ActorOptionsValidator
ActorPath
ActorRef
ActorRestarted
ActorSelection
ActorStarted
ActorStopped
ActorSystem
ActorSystemOptionsBuilder
ActorSystemTerminateReason
AllForOneStrategy
AskTimeoutError
BackoffSupervisor
BackoffSupervisorOptionsBuilder
BackoffSupervisorOptionsValidator
BidirectionalMap
BidirectionalMultiMap
BoundedMailbox
BoundedMailboxOptionsBuilder
BoundedMailboxOptionsValidator
Broadcast
CircuitBreaker
CircuitBreakerExtension
CircuitBreakerOpenError
CircuitBreakerOptionsBuilder
CircuitBreakerOptionsValidator
CircuitBreakerTimeoutError
ClusterDowningReason
ClusterJoinUnsuccessfulReason
ClusterLeavingReason
Config
ConfigError
ConsoleLogger
ControlAwareMailbox
ControlAwareMailboxOptionsBuilder
ControlAwareMailboxOptionsValidator
CoordinatedShutdown
CoordinatedStartup
CoordinatedStartupOptionsBuilder
CoordinatedStartupOptionsValidator
DeadLetter
DeadLetterQueue
DeadLetterQueueOptionsBuilder
DeadLetterQueueOptionsValidator
DeathPactError
DiagnosticsOptionsBuilder
DiagnosticsOptionsValidator
DispatcherError
DroppingMailbox
EventKey
EventStream
Extensions
Failure
HybridDispatcher
ImmediateDispatcher
JsonLogger
Kill
Lazy
Left
Mailbox
MailboxFullError
MessageBoundaryCheck
MessageBoundaryError
MessageBoundaryOptionsBuilder
MessageBoundaryOptionsValidator
MicrotaskDispatcher
NobodyRef
None
NoopLogger
OffloadAbortedError
OffloadArgumentsError
OffloadPoolUnavailableError
OffloadQueueFullError
OffloadTaskError
OffloadTimeoutError
OffloadWorkerLostError
OneForOneStrategy
OptionsBuilder
OptionsError
OptionsValidator
ParallelismExtension
ParallelismOptionsBuilder
ParallelismOptionsValidator
PendingRemoteActorRef
PoisonPill
PriorityMailbox
PriorityMailboxOptionsBuilder
PriorityMailboxOptionsValidator
ProcessTerminateReason
Reason
ReceiveTimeout
RestartBudget
Right
RingBuffer
ScatterGatherOptionsBuilder
ScatterGatherOptionsValidator
Scheduler
SchedulerError
Some
StartupFailedReason
StashOutsideHandlerError
StashOverflowError
Success
SystemClock
Terminated
ThrottleOptionsBuilder
ThrottleOptionsValidator
ThroughputDispatcher
TypedActor
UnknownReason
Interfaces
ActorContext
BackoffPolicy
Cancellable
CancellablePromise
Clock
Dispatcher
DropReportingMailbox
ExtensionId
JsonLogSink
Logger
StashBuffer
SuperviseBuilder
TimerScheduler
TypedActorContext
Type Aliases
ActorClassOrFactory
ActorFactory
ActorOptions
ActorOptionsType
ActorSystemOptions
ActorSystemOptionsType
BackoffSupervisorOptions
BackoffSupervisorOptionsType
Behavior
BehaviorInterceptor
BehaviorInterceptorTarget
BidirectionalMapJson
BidirectionalMultiMapJson
BoundedMailboxOptions
BoundedMailboxOptionsType
BoundedMailboxOverflow
CapturedPayload
CircuitBreakerKeys
CircuitBreakerOptions
CircuitBreakerOptionsType
CircuitState
ConfigObject
ConfigValue
ControlAwareMailboxOptions
ControlAwareMailboxOptionsType
CoordinatedStartupOptions
CoordinatedStartupOptionsType
DeadLetterAttribution
DeadLetterEntry
DeadLetterFilter
DeadLetterPayload
DeadLetterQueueOptions
DeadLetterQueueOptionsType
DeadLetterReplayResult
DeadLetterStore
Decider
DegradedPayload
DegradedPayloadResult
DiagnosticsOptions
DiagnosticsOptionsType
DispatcherErrorSink
Either
EmptyBehavior
EntityContext
Envelope
EventChannel
EventClass
ExistsPredicate
ExponentialBackoffOptions
Extension
ForwardStrategy
IgnoreBehavior
InterceptBehavior
KindOf
LazyImportOptions
LinearBackoffOptions
LoadOptions
LogContextData
LogContextEntry
LogMessagesOptions
MailboxDropObserver
MailboxDropReason
MailboxFactory
MeshLeader
MessageBoundaryHost
MessageBoundaryMode
MessageBoundaryOptions
MessageBoundaryOptionsType
OffloadRunOptions
OffloadTask
Option
ParallelismOptions
ParallelismOptionsType
ParallelismSpawnedMessage
ParallelismSpawnFailedMessage
ParallelismSpawnMessage
ParallelismTerminatedMessage
ParallelismTerminateMessage
ParallelismWireMessage
PhaseDefinition
PipeToOptions
PlacementStrategy
PriorityFunction
PriorityMailboxOptions
PriorityMailboxOptionsType
PriorityMailboxOverflow
ProcessSignal
QuarantinedResult
RandomStringOptions
Receive
ReceiveBehavior
ReplayedResult
ResetCounter
ResolvedDiagnostics
RetryOptions
RouterState
RoutingStrategy
SameBehavior
ScatterGatherOptions
ScatterGatherOptionsType
SchedulerErrorSink
SetupBehavior
ShutdownTask
Signal
StartupTask
StartupTaskRegistration
StoppedBehavior
StrategyOptions
SuperviseBehavior
SupervisorStrategy
TerminateOptions
TerminationTrigger
ThrottleOnExcess
ThrottleOptions
ThrottleOptionsType
Try
UnhandledBehavior
UnknownEntryResult
UnresolvedRecipientResult
WithStashBehavior
WithTimersBehavior
Variables
ActorOptions
ActorSystemOptions
BackoffSupervisorOptions
Behaviors
BoundedMailboxOptions
CircuitBreakerExtensionId
CircuitBreakerOptions
ConfigKeys
ControlAwareMailboxOptions
CoordinatedShutdownId
CoordinatedStartupId
CoordinatedStartupOptions
DEAD_LETTER_STORES
DeadLetterQueueOptions
DEFAULT_CIRCUIT_BREAKER_ID
DEFAULT_DEAD_LETTER_MAX_ENTRIES
DEFAULT_DEAD_LETTER_MAX_REPLAYS
DEFAULT_DEAD_LETTER_RETENTION_MS
DEFAULT_DEAD_LETTER_STORE
DEFAULT_DEBUG_EVENT_STREAM
DEFAULT_DEBUG_LIFECYCLE
DEFAULT_DEBUG_UNHANDLED
DEFAULT_LOG_CONFIG_ON_START
DEFAULT_LOG_DEAD_LETTERS
DEFAULT_LOG_DEAD_LETTERS_DURING_SHUTDOWN
DEFAULT_LOG_DEAD_LETTERS_SUSPEND_DURATION_MS
DEFAULT_MESSAGE_BOUNDARY_SERIALIZER_ROUND_TRIP
DEFAULT_MESSAGE_BOUNDARY_STRUCTURED_CLONE
DEFAULT_PARALLELISM_BUFFER_SIZE
DEFAULT_PARALLELISM_LEADER
DEFAULT_PARALLELISM_OFFLOAD
DEFAULT_PARALLELISM_PLACEMENT
DEFAULT_PARALLELISM_SPAWN_TIMEOUT_MS
DEFAULT_PARALLELISM_WORKERS
DEFAULT_STARTUP_PHASE_TIMEOUT_MS
defaultStrategy
DiagnosticsOptions
Dispatchers
DISPLAY_NAME_FIELD
escalatingStrategy
lazy
LogContext
MessageBoundaryOptions
Nobody
none
OffloadExtensionId
ParallelismExtensionId
ParallelismOptions
Phases
PriorityMailboxOptions
REFERENCE_CONF
Router
ScatterGatherOptions
StartupPhases
stoppingStrategy
systemClock
ThrottleOptions
Functions
after
broadcastStrategy
circuitBreakerKeysUnder
configDumpLines
decideBy
deepMerge
defaultDeadLetterPersistenceId
defineOffloadTask
describeMessageType
eitherOf
eitherSequence
empty
exponentialBackoff
extensionId
failure
firstSome
fromNullable
fromPredicate
gracefulStop
ignore
isPlainObject
lazyImportModule
left
linearBackoff
parseDuration
parseHocon
parseSelectionPath
parseSize
pipeTo
randomHex
randomId
randomStrategy
randomString
randomUuid
readCircuitBreakerOptionsFromConfig
readDeadLetterQueueOptionsFromConfig
readDiagnosticsOptionsFromConfig
readMessageBoundaryOptionsFromConfig
redactedUrlLabel
redactErrorCredentials
redactParsedUrlCredentials
redactUrlCredentials
resolveSubstitutions
retry
right
roundRobinStrategy
safeStringify
same
smallestMailboxStrategy
some
stopped
structuredCloneProblem
success
tryOf
trySequence
typedActor
unhandled
🎁 Extras
Design decisions
Architecture Decision Records
GitHub
Select theme
Dark
Light
Auto
English
English
Deutsch
Español
Français
日本語
한국어
Português (BR)
Русский
简体中文
Decider
Decider
= (
error
) =>
Directive
Defined in:
src/Supervision.ts:16
Parameters
Section titled “Parameters”
error
Section titled “error”
Error
Returns
Section titled “Returns”
Directive