Skip to content
ddd-cqrs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Select language
English
Ελληνικά
Menu
Start
Overview
Getting started
Concepts
How an operation is wrapped
Execution order
The pipeline context
Architecture Map
Guides
Plain Node.js
Class methods
CQRS without NestJS
NestJS & @cqrs-ddd: Integrating or Migrating
DDD without a framework
Custom behaviors
HTTP errors
HTTP with Express and Fastify
Multi-tenancy
Background jobs
Testing handlers
Packages
@cqrs-ddd/pipeline
@cqrs-ddd/cqrs
@cqrs-ddd/nestjs
@cqrs-ddd/pipeline-zod
@cqrs-ddd/pipeline-casl
@cqrs-ddd/pipeline-cache
@cqrs-ddd/pipeline-idempotency
@cqrs-ddd/pipeline-rate-limit
@cqrs-ddd/pipeline-resilience
@cqrs-ddd/pipeline-feature-flags
@cqrs-ddd/pipeline-audit
@cqrs-ddd/pipeline-deadletter
@cqrs-ddd/pipeline-opentelemetry
@cqrs-ddd/pipeline-tenant
@cqrs-ddd/pipeline-correlation
@cqrs-ddd/pipeline-job-context
@cqrs-ddd/core
@cqrs-ddd/mikro-orm
@cqrs-ddd/safe-stringify
@cqrs-ddd/untyped
@cqrs-ddd/uuidv7
API reference
@cqrs-ddd/core
Classes
AggregateRoot
BaseCommand
BaseQuery
CommandBaseHandler
CommandRepository
ConcurrencyConflictError
DomainEvent
DomainException
EntityNotFoundException
InvalidValueException
MemoryCache
MissingTenantContextError
QueryRepository
RootDomainEvent
RootEntity
TransientOperationError
UnknownMutableFieldError
Interfaces
ApplyEventOptions
ApplyMutationOptions
CacheFillOptions
CacheKeyRequestContext
CacheMutationBarrier
CacheOptions
CacheSetOptions
CacheStateEntry
DomainErrorHttpStatus
FromCacheOptions
IAggregateRoot
ICache
ICacheLogger
ICommandRepository
IDomainEventPublisher
IEvent
IPersistenceDialect
IQueryOptions
IQueryRepository
IVersionedCache
IWriteSideAggregateRepository
MutableFieldDefinition
MutableOptions
NumberRuleOptions
PersistedAggregate
PersistedWriteOptions
QueryRepositoryHydration
RootEntitySnapshot
TextRuleOptions
Type Aliases
AggregateBearingResult
CacheBarrierReason
CacheKeyTenantSource
CacheResourceSpecifier
CacheStateStatus
CacheStoredValue
InferPayload
MemoryCacheSetOptions
Method
MutationPatch
NonEmptyEventArray
NumberRule
NumberRuleValue
SingleEvent
TenantResolver
TenantSource
TextRule
TextRuleValue
UniqueErrors
ValueViolation
ValueViolationError
Variables
DEFAULT_BARRIER_TTL_MS
DEFAULT_MAX_ENTRIES
Functions
AcknowledgePersisted
ApplyMutation
Cache
cacheKey
cacheKeyTemplate
consoleCacheLogger
createCacheMutationBarrier
deepCloneAndFreeze
domainErrorHttpStatus
FromCache
getMutableFields
isCacheMutationBarrier
isCacheNewer
isTransientOperationError
isVersionedCache
MapPersistenceErrors
Mutable
numberRule
PersistedWrite
persistenceDialect
requireTenant
requireTenantId
safeWarn
setPersistenceDialect
setTenantResolver
textRule
toCacheSnapshot
@cqrs-ddd/cqrs
Classes
CommandBus
CommandHandlerNotFoundException
EventBus
InvalidCommandHandlerException
InvalidEventsHandlerException
InvalidQueryHandlerException
QueryBus
QueryHandlerNotFoundException
UnhandledExceptionBus
Interfaces
Cqrs
CqrsOptions
EventBusOptions
EventSubscriber
ICommand
ICommandHandler
IEvent
IEventHandler
IQuery
IQueryHandler
Subscription
UnhandledExceptionInfo
Type Aliases
Dispatch
RequestType
Functions
CommandHandler
createCqrs
EventsHandler
QueryHandler
@cqrs-ddd/mikro-orm
Classes
AggregateRepository
CacheEntry
MikroOrmCache
MikroOrmDialect
TenantStore
UnixTimestampType
Interfaces
IEntityManagerSource
ITransactionalEntityManagerSource
MikroOrmCacheOptions
RootEntityColumns
SqlIdentifierOptions
TenantStoreOptions
VersionedAggregate
Type Aliases
TenantIsolation
Timestamp
Variables
CacheEntrySchema
Functions
assertAutocommit
createCacheEntrySchema
createCacheTableSql
isSqlIdentifier
isTransientPersistenceError
mapPersistenceError
optimisticDelete
optimisticUpdate
rootEntityProperties
versionProperty
@cqrs-ddd/nestjs
correlation
job-context
main
@cqrs-ddd/pipeline
Classes
BasePipelineContext
LoggingBehavior
MissingPartitionError
MissingPipelineItemError
PipelineConfigurationError
PipelineContext
Interfaces
BehaviorEntryAccumulators
ContextSource
ContextSources
CorrelationSource
GlobalBehaviorsOptions
HandlerPipeline
IPipelineBehavior
IPipelineBehaviorContract
IPipelineBehaviorOptionsResolver
IPipelineContext
LoggingBehaviorOptions
PinoLike
Pipeline
PipelineBehaviorDiagnostic
PipelineBehaviorOrderRule
PipelineBehaviorValidationContext
PipelineDeclaration
PipelineHandlerMeta
PipelineItemToken
PipelineLogger
PipelineOptions
TenantPartitionOptions
Wrap
WrapOptions
Type Aliases
AnyClass
BehaviorId
Constructor
DeclaredKind
DualClassDecorator
ErrorClass
GlobalBehaviorScope
LoggingIntentOptions
LogLevel
NextDelegate
PipelineBehaviorEntry
PipelineBehaviorOrder
PipelineBehaviorTuple
PipelineRunner
RequestKind
Variables
PIPELINE_BEHAVIOR_CONTRACT
PIPELINE_BEHAVIOR_ID
pipelineStore
REQUEST_KIND
SET_REQUEST
SET_TENANT_ID
Functions
behaviorEntryType
compilePipelinePlan
createPipeline
createPipelineItem
createPipelineRunner
getBehaviorId
getPipelineItem
hasPipelineItem
logging
normalizeBehaviorEntries
pinoLogger
pipelineOf
replaceRequest
requirePipelineItem
setPipelineItem
SkipPipeline
tenantSegments
toGlobalConfigs
toPostgresJson
UsePipeline
validateBehaviorContracts
@cqrs-ddd/pipeline-audit
Classes
AuditBehavior
LogAuditSink
PostgresAuditSink
Interfaces
AuditActor
AuditBehaviorOptions
AuditError
AuditLoggerLike
AuditRecord
AuditSink
BuildAuditRecordInput
BuildAuditStartRecordInput
LogAuditSinkOptions
PostgresAuditSinkOptions
PostgresQueryableLike
Type Aliases
AuditActorFactory
AuditIntentOptions
AuditMetadataFactory
AuditOutcome
AuditRedactor
AuditRequestKind
AuditSeverity
AuditStartRecord
Variables
AUDIT_OUTCOMES
AUDIT_RECORD_ITEM
AUDIT_RECORD_ITEM_TOKEN
AUDIT_REQUEST_KINDS
AUDIT_SEVERITY
AUDIT_START_RECORD_ITEM_TOKEN
DEFAULT_REDACT_KEYS
REDACTED
Functions
audit
buildAuditRecord
buildAuditStartRecord
createAuditTableSql
redactValue
@cqrs-ddd/pipeline-cache
Classes
CacheBehavior
CacheManagerAdapter
MissingCachePartitionError
Interfaces
BuildCacheOptions
CacheBehaviorOptions
CacheStoreConfig
IPipelineCache
PartitionedCacheKeyOptions
Type Aliases
CacheCondition
CacheIntentOptions
CacheKeyFactory
CachePartitionDimension
CacheStoreType
Variables
CACHE_HIT_ITEM
CACHE_HIT_ITEM_TOKEN
CACHE_KEY_ITEM
CACHE_KEY_ITEM_TOKEN
Functions
buildCache
buildCacheAttributes
buildKeyv
cache
createPartitionedCacheKeyFactory
@cqrs-ddd/pipeline-casl
http
main
@cqrs-ddd/pipeline-correlation
Interfaces
CorrelationDecoratorOptions
CorrelationLogger
CorrelationOptions
Type Aliases
CorrelationExtractor
HttpMiddleware
LogLevel
WithCorrelationId
Variables
CorrelationFrom
correlationSource
DEFAULT_CORRELATION_HEADER
DEFAULT_CORRELATION_ID_MAX_LENGTH
DEFAULT_CORRELATION_ID_PATTERN
Functions
addCorrelationId
correlationHeaders
getCorrelationId
httpCorrelation
runWithCorrelationId
WithCorrelation
@cqrs-ddd/pipeline-deadletter
Classes
BullMqDeadLetterTransport
DeadLetterBehavior
DeadLetterRedriveError
DeadLetterRedriver
PostgresDeadLetterTransport
RabbitMqDeadLetterTransport
Interfaces
BullMqDeadLetterTransportOptions
BullMqQueueLike
DeadLetterBehaviorOptions
DeadLetterError
DeadLetterListFilter
DeadLetterRecord
DeadLetterRedriveResult
DeadLetterRedriverOptions
DeadLetterStore
DeadLetterTransport
PostgresDeadLetterTransportOptions
PostgresQueryableLike
RabbitMqConfirmChannelLike
RabbitMqDeadLetterTransportOptions
Type Aliases
DeadLetterDispatch
DeadLetterIntentOptions
DeadLetterMetadataFactory
DeadLetterRequestKind
DeadLetterStatus
Variables
DEAD_LETTER_ITEM
DEAD_LETTER_ITEM_TOKEN
DEFAULT_REDACT_KEYS
REDACTED
Functions
buildDeadLetterAttributes
buildDeadLetterRecord
createDeadLetterTableSql
deadLetter
redactValue
@cqrs-ddd/pipeline-feature-flags
http
main
@cqrs-ddd/pipeline-idempotency
http
main
@cqrs-ddd/pipeline-job-context
Classes
InvalidJobContextError
MissingJobContextError
Interfaces
AsSystemOptions
ContextSource
CorrelationSource
IJobPrincipal
InJobContextOptions
JobContext
JobContextOptions
JobContextSources
PrincipalReference
Type Aliases
WithJobContext
Functions
AsSystem
InJobContext
registerJobContext
withJobContext
@cqrs-ddd/pipeline-opentelemetry
Classes
AttributesBehavior
MetricsBehavior
TraceBehavior
Interfaces
AttributesBehaviorOptions
MetricsBehaviorOptions
TraceBehaviorOptions
Type Aliases
MetricsIntentOptions
PipelineTelemetryAttributeFactory
TraceIntentOptions
Variables
PIPELINE_OTEL_ATTRIBUTES
PIPELINE_TELEMETRY_ATTRIBUTES
Functions
addPipelineTelemetryAttributes
buildMetricAttributes
buildTraceAttributes
getPipelineTelemetryAttributes
metrics
trace
@cqrs-ddd/pipeline-rate-limit
http
main
@cqrs-ddd/pipeline-resilience
Enumerations
CircuitState
Classes
BrokenCircuitError
BulkheadRejectedError
IsolatedCircuitError
ResilienceBehavior
ResilienceConfigurationError
ResiliencePolicies
ResiliencePolicyConfigurationError
TaskCancelledError
Interfaces
BulkheadOptions
CircuitBreakerOptions
PolicyBuildContext
ResilienceBehaviorOptions
ResiliencePolicyOptions
ResilienceTelemetry
ResilienceTelemetryEvent
RetryOptions
RetryPolicyOptions
TimeoutOptions
TimeoutPolicyOptions
Type Aliases
AnyPolicy
BreakerStrategy
FallbackOptions
HandlerResilienceLayer
JitterStrategy
ResilienceIntentOptions
ResilienceLayer
RetryBackoff
Variables
isBrokenCircuitError
isBulkheadRejectedError
isIsolatedCircuitError
isTaskCancelledError
Functions
buildResiliencePolicy
getResilienceAbortSignal
resilience
@cqrs-ddd/pipeline-tenant
Variables
tenantSource
Functions
currentTenantId
runWithTenant
@cqrs-ddd/pipeline-zod
http
main
@cqrs-ddd/safe-stringify
Interfaces
SanitizeOptions
Type Aliases
StrictJsonValue
Variables
ABSENT_SEGMENT
DEFAULT_REDACT_KEYS
REDACTED
Functions
escapeKeySegment
joinKeySegments
redactValue
safeSanitize
safeStringify
stableStringify
toStrictJsonValue
@cqrs-ddd/untyped
Functions
untyped
@cqrs-ddd/uuidv7
Functions
isUuidV7
uuidv7
GitHub
Select theme
Dark
Light
Auto
Select language
English
Ελληνικά
@cqrs-ddd/pipeline-rate-limit
Modules
Section titled “Modules”
http
main