$wait is server-side, $sleep is client-side #484

Author: aeberhart

dashjoin-docs/docs/appendix-jsonata.md

@@ -842,3 +842,12 @@ Sample output:
   "version" : 2
 } ]
 ```
+## wait
+Waits before returning the parameter (server-side equivalent of $sleep)
+```
+$wait('delayed by 1 second', 1000)
+```
+Sample output: 
+```json
+"delayed by 1 second"
+```

dashjoin-docs/docs/faq.md

@@ -168,8 +168,7 @@ $call("openai", {
 )
 ```
 
-* **I need to ETL from an API that has a rate limit. How can I throttle my requests?** You can use the sleep function in your JSONata expression:
-Let's assume $openJson(url) is called on several array elements. Simply change it to ($openJson(x); $sleep(1000)) to introduce a 1 second delay after each call.
+* **I need to ETL from an API that has a rate limit. How can I throttle my requests?** You can use the wait function in your JSONata expression (server-side equivalent of sleep): Let's assume $openJson(url) is called on several array elements. Simply change it to $wait($openJson(x), 1000) to introduce a 1 second delay after each call.
 
 * **How can I realize an audit log that keeps track of all changes to a table?** You can define a triggers for create, update, and delete operations on the table that must be audited. Create an audit log table with the following columns: autoincrementing ID, user, timestamp, operation, and payload. The trigger `$create("db", "audit", {"timestamp": $now(), "user": user, "operation": "update", "payload": $})` will log changes to the table.
 

dashjoin-docs/llms/jsonata.json

@@ -1,33 +1,38 @@
 {
     "confirm": [
         {
+            "client": true,
             "description": "displays a confirmation dialog and returns true if the user clicked yes",
             "code": "$confirm('Are you sure') ? 'you clicked yes'",
             "output": true
         }
     ],
     "setVariable": [
         {
+            "client": true,
             "description": "Sets the browser session variable x to 1. The new value can be read in other places via variable.x",
             "code": "$setVariable('x', 1)"
         }
     ],
     "prompt": [
         {
+            "client": true,
             "description": "Prompts the user for an input. Returns the input or undefined if the prompt is cancelled",
             "code": "(\n  $name := $prompt('What is your name?');\n  $name ? ('Hello ' & $name);\n)",
             "output": "Joe"
         }
     ],
     "alert": [
         {
+            "client": true,
             "description": "Shows a model popup with a message",
             "code": "$alert('FYI')",
             "output": "OK"
         }
     ],
     "dialog": [
         {
+            "client": true,
             "description": "Shows a dialog to enter 'to' and 'text'. If the user submits via 'ok', an object with these fields is returned",
             "code": "$dialog({\n  'title':'Send Message', \n  'message':'Please enter your message', \n  'inputs':['to', 'content'], \n  'buttons':[{'label':'ok', 'type':'submit'},'cancel'], \n  'options':{'alert':'info'}\n})",
             "oputput": {
@@ -38,64 +43,75 @@
     ],
     "notify": [
         {
+            "client": true,
             "description": "Shows a message in the snackbar at the bottom of the screen",
             "code": "$notify('Hi from the snackbar!')"
         }
     ],
     "refresh": [
         {
+            "client": true,
             "description": "refreshes the screen just (just like hitting the refresh icon in the toolbar)",
             "code": "$refresh()"
         }
     ],
     "reload": [
         {
+            "client": true,
             "description": "reloads the browser page",
             "code": "$reload()"
         }
     ],
     "navigate": [
         {
+            "client": true,
             "description": "points the browser to the URL",
             "code": "$navigate('http://dashjoin.com')"
         },
         {
+            "client": true,
             "description": "scrolls the page to the DOM element with the given id. In this case, we scroll to the widget that has the title 'Top'",
             "code": "$navigate({'id': 'dj-Top'})"
         }
     ],
     "clearCache": [
         {
+            "client": true,
             "description": "clears the HTTP cache - can be used in conjunction with expressions that trigger side effects on the backend",
             "code": "$clearCache()"
         }
     ],
     "progress": [
         {
+            "client": true,
             "description": "shows a progress indicator with the message 'working...' for 1 second until the expression execution completes",
             "code": "(\n  $progress({'message':'working...'});\n  $sleep(1000)\n)"
         }
     ],
     "sleep": [
         {
+            "client": true,
             "description": "sleeps for 1000 milliseconds",
             "code": "$sleep(1000)"
         }
     ],
     "speak": [
         {
+            "client": true,
             "description": "performs a text to english speech for 'Test'",
             "code": "$speak('Test', 'en')"
         }
     ],
     "stopSpeech": [
         {
+            "client": true,
             "description": "stops any text to speech that's in progress",
             "code": "$stopSpeech()"
         }
     ],
     "translate": [
         {
+            "client": true,
             "description": "Lookup the text in the translation file and return the match for the current locale",
             "code": "$translate('ra.action.select_all_button')",
             "output": "Select all"
@@ -707,5 +723,12 @@
                 }
             ]
         }
+    ],
+    "wait": [
+        {
+            "description": "Waits before returning the parameter (server-side equivalent of $sleep)",
+            "code": "$wait('delayed by 1 second', 1000)",
+            "output": "delayed by 1 second"
+        }
     ]
 }

llms.txt

@@ -1589,3 +1589,8 @@ DESCRIPTION: Compares two tables with URL / file information to determine which
 LANGUAGE: jsonata
 CODE: $etlSync([{'url':'file:a', 'version': 2}], [{'url':'file:a', 'version': 1}], 'url')
 
+TITLE: wait
+DESCRIPTION: Waits before returning the parameter (server-side equivalent of $sleep)
+LANGUAGE: jsonata
+CODE: $wait('delayed by 1 second', 1000)
+