Skip to main content

Module background

Module background 

Source
Expand description

Background Module - Background execution and triggers

This module provides the infrastructure for background callable execution:

  • Triggers: Event-based callable invocation
  • Executor: Background execution with different modes
  • Target Binding: Binds execution results to targets

§Background Execution Modes

  • FireAndForget: Don’t wait for result, no streaming
  • Silent: Wait for result, but suppress streaming events
  • Deferred: Queue for later execution

§Triggers

Triggers watch for specific events and spawn background executions:

  • Event: Fired by execution/step events
  • Schedule: Fired by cron/interval schedules
  • Webhook: Fired by external webhooks
  • Threshold: Fired when metrics cross thresholds
  • Lifecycle: Fired by thread/user lifecycle events

@see packages/enact-schemas/src/execution.schemas.ts @see docs/TECHNICAL/32-SPAWN-MODE.md

Re-exports§

pub use trigger::RetryConfig;
pub use trigger::TargetBindingConfig as TriggerTargetBindingConfig;
pub use trigger::TargetBindingType as TriggerTargetBindingType;
pub use trigger::ThresholdOperator;
pub use trigger::Trigger;
pub use trigger::TriggerAction;
pub use trigger::TriggerCondition;
pub use trigger::TriggerFiredEvent;
pub use trigger::TriggerId;
pub use trigger::TriggerStatus;
pub use trigger::TriggerType;
pub use executor::BackgroundExecution;
pub use executor::BackgroundExecutionConfig;
pub use executor::BackgroundExecutionMode;
pub use executor::BackgroundExecutionQueue;
pub use executor::BackgroundExecutionStatus;
pub use target_binding::apply_transform;
pub use target_binding::TargetBindingConfig;
pub use target_binding::TargetBindingResult;
pub use target_binding::TargetBindingTransform;
pub use target_binding::TargetBindingType;

Modules§

executor
Background Executor - Runs callables in background mode
target_binding
Target Binding - Binds execution results to targets
trigger
Trigger System for Background Callables