Skip to content
Rungs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Getting started
Concepts
Flows and steps
Approvers and resolvers
Conditions
Delegation and out of office
Deadlines, reminders and escalation
Return and resubmit
Audit trail and events
What lives where
Guides
Next.js
Express
PostgreSQL and migrations
Multi-tenant
Notifications
Running tick
Data retention
Concurrency and idempotency
Testing your flows
Edge cases
Reference
Errors
Store contract
API
@rungsjs/core
Classes
ConditionError
ConfigurationError
ConflictError
FlowDefinitionError
FlowNotApplicableError
FlowNotFoundError
InvalidCommandError
InvalidTransitionError
NoApproversError
NotAssignedError
RequestNotFoundError
ResolutionError
RungsError
Interfaces
BlockedInput
BlockedPage
BlockedReminder
BlockedStepView
Calendar
CommandOptions
DelegationInput
DelegationRule
Delegations
DispatchOptions
DispatchSummary
FlowDefinition
FlowInput
FlowIssue
FlowRegistration
FlowRegistry
InboxEntry
InboxInput
InboxPage
PreviewResult
PreviewStep
Queries
RegisteredFlow
RemovedApprover
RequestsInput
RequestsPage
RequestState
RequestSummary
ResolutionHooks
ResolveContext
ResolverArgs
ResolveRequest
Rungs
RungsOptions
RungsStore
StepDeadline
StepDefinition
StepInput
StepInstance
Subject
Task
TaskView
TickOptions
TickSummary
Type Aliases
AllSkippedPolicy
ApproveInput
ApproverShortfall
ApproverSpec
AuditEvent
AuditEventBody
AuditEventType
ComparisonOperator
Condition
ConditionOperator
DedupePolicy
DelegateInput
DelegationSkipReason
DomainEvent
DomainEventBody
DomainEventType
Duration
EmptyStepPolicy
EqualityOperator
JsonValue
MembershipOperator
OverrideInput
PreviewRequestInput
Primitive
ReassignInput
ReceivedType
RejectInput
ReminderInterval
RemovalReason
RequestStatus
ResubmitInput
ResubmitTimeoutAction
RetryInput
ReturnInput
ReturnPolicy
SkipReason
StepMode
StepStatus
SubmitInput
TaskStatus
TimeoutAction
WithdrawInput
Functions
createRungs
defineFlow
@rungsjs/core/engine
Interfaces
ApproveCommand
DecidedResult
DelegateCommand
EngineContext
NeedsResolution
OverrideCommand
PreviewInput
ReassignStepCommand
ReassignTaskCommand
RejectCommand
ResolutionNeed
ResubmitCommand
RetryStepCommand
ReturnCommand
StepResolution
SubmitCommand
TickCommand
Unchanged
WithdrawCommand
Type Aliases
Command
Decision
Functions
decide
References
Calendar
@rungsjs/core/store
Interfaces
BlockedQuery
ClaimOptions
EventKey
FlowRef
IdempotencyRef
IdempotentRecord
InboxQuery
OutboxEntry
RequestQuery
StoreTx
Functions
blockedStepView
requestSummary
taskViews
References
RungsStore
@rungsjs/store-memory
Interfaces
MemorySnapshot
MemoryStore
MemoryStoreOptions
Functions
memoryStore
@rungsjs/store-postgres
Interfaces
NamingOptions
PgClient
PgliteLike
PgPoolLike
PgQueryable
PostgresJsLike
PostgresJsQueryLike
PostgresStoreOptions
PurgeResult
Type Aliases
PurgeRequestsOptions
Variables
SCHEMA_VERSION
Functions
fromPg
fromPglite
fromPostgresJs
migrate
migrationSql
postgresStore
purgeDispatchedEvents
purgeIdempotency
purgeRequest
purgeRequests
FAQ
GitHub
Select theme
Dark
Light
Auto
@rungsjs/store-memory
An in-memory store for tests and prototypes.
Interfaces
Section titled “Interfaces”
MemorySnapshot
MemoryStore
MemoryStoreOptions
Functions
Section titled “Functions”
memoryStore