github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/builtins/events/onSecondsElapsed/onsecondselapsed_doc.yaml (about)

     1  - DocumentID: onsecondselapsed
     2    Title: >+
     3      `onSecondsElapsed`
     4    CategoryID: events
     5    Summary: >-
     6      Events triggered by time intervals
     7    Description: |-
     8      `onSecondsElapsed` events are triggered every _n_ seconds.
     9    Usage: |-
    10      ```
    11      event onSecondsElapsed name=seconds { code block }
    12  
    13      !event onSecondsElapsed name
    14      ```
    15    Payload: |-
    16      The following payload is passed to the function via STDIN:
    17  
    18      ```
    19      {
    20          "Name": "",
    21          "Interrupt": 0
    22      }
    23      ```
    24  
    25      ### Name
    26  
    27      This is the name you specified when defining the event.
    28  
    29      ### Interrupt
    30  
    31      This is the duration you defined the event to wait for.
    32    Flags:
    33      <seconds>: >-
    34        Duration in seconds. eg `60` would be 60 seconds / 1 minute
    35    Examples: |-
    36      ```
    37      event onSecondsElapsed example=60 {
    38          out "60 seconds has passed"
    39      }
    40      ```
    41    Detail:
    42    Synonyms:
    43    - onsecondselapsed
    44    - onSecondsElapsed
    45    Related:
    46    - event
    47    - config