API Reference

Full API documentation is available on pkg.go.dev:

Packages

Package	Description	Link
event	Core interfaces (Event, Bus, Invoker, Registry)	pkg.go.dev
invoker	Execution pipeline components	pkg.go.dev
json	JSON serialization with envelope format	pkg.go.dev
jetstream	NATS JetStream transport	pkg.go.dev
nats	NATS Core transport	pkg.go.dev
redis	Redis-backed stores	pkg.go.dev
telemetry	OpenTelemetry tracing	pkg.go.dev
prometheus	Prometheus metrics provider	pkg.go.dev

Key Types

Core

• Event - Base event interface
• Bus - Bus interface (Subscribe, Close)
• Invoker - Middleware interface
• Registry - Serialization interface
• Envelope - Wire format
• LocalBus - In-process bus
• Subscriber - Grouped handler interface
• SubscribeOptionsProvider - Optional interface for subscriber-level subscribe options
• EmitOption - Functional option for Emit
• WithSubject - Overrides the publish subject (defaults to evt.Name())
• SubscribeOption - Functional option for Subscribe
• WithHandlerName - Sets handler name for metrics/logging
• WithStream - JetStream stream name (required for JetStream)
• WithConsumer - JetStream durable consumer name

Invoker

• Chain - Invoker chain composition
• Retry - Retry with backoff
• CircuitBreaker - Circuit breaker
• RateLimiter - Rate limiting
• Idempotency - Duplicate detection
• DLQ - Dead letter queue
• Metrics - Metrics collection
• MetricProvider - Metrics interface

Error Types

• PermanentError - Terminal error
• RetryableError - Retryable error
• ErrDuplicate - Duplicate detection
• ErrRateLimited - Rate limit exceeded
• ErrCircuitOpen - Circuit breaker open
• ErrSendToDLQ - Terminal error signal