@ea-lab/reactive-json-docs/public/rjbuild/docs/core/element/special/DelayedActions.yaml

Complete documentation for Reactive-JSON - Components, examples and LLM-parsable guides

renderView:
  - type: Markdown
    content: |
      # DelayedActions

      The `DelayedActions` component allows you to execute one or more actions after a delay or at regular intervals. It is useful for implementing polling, periodic updates, or delayed reactions in your Reactive-JSON applications.

      ## Properties

  - type: DefinitionList
    content:
      - term:
          code: delayedActions
          after: "(array, required)"
        details:
          type: Markdown
          content: "Array of action objects to execute after the delay or at each interval."
      - term:
          code: interval
          after: "(number, required)"
        details: "The delay or interval in milliseconds between executions."
      - term:
          code: once
          after: "(boolean, optional)"
        details:
          type: Markdown
          content: "If `true`, actions execute only once after the delay; if `false` (default), actions repeat at each interval."
      - term:
          code: content
          after: "(object|array, optional)"
        details: "Content to render inside the component."

      ## Behavior
      - Executes all actions in `delayedActions` after the specified delay or at each interval.
      - If `once` is true, actions are executed only once; otherwise, they repeat at each interval.
      - Actions are executed without requiring a user event (time is the trigger).
      - The component can render content, but the main purpose is to trigger actions.
      - If `interval` is not provided, no actions are executed.

  - type: RjBuildDescriber
    title: Example
    description: This example adds an item in a data array every 2 seconds, and shows the item count.
    toDescribe:
      renderView:
        - type: Phantom
          actions:
            - # This will prevent infinite add.
              what: hide
              andConditions:
                - whenDataCountOf: $.tick[*]
                  ">": 1000
          content:
            - type: DelayedActions
              interval: 2000
              delayedActions:
                - what: addData
                  path: ~~.tick
                  value: "Ticked!"
              content:
                - type: p
                  content:
                    - "Tick count: "
                    - type: Count
                      jsonPathPattern: "$.tick[*]"

      data: {}

  - type: Markdown
    content: |
      ## Limitations
      - Only supports time-based triggering (no event-based delay).
      - All actions are executed in the order provided.
      - No built-in error handling for action execution.
      - If `interval` is missing or invalid, nothing happens.