ToolJet/docs/versioned_docs/version-2.29.0/how-to/run-action-from-runjs.md
Karan Rathod 7d4cd6da47
[docs]:app builder 1.5 updates (#8672)
* add getter function and table transformation docs

* add dropdown, number-input, password-input and text-input docs

* [docs] custom parameters for queries

* update docs for revamped components, runJS and runPy functions and sidebar

* change order of properties and other misc changes

* update query panel and other minor fixes

* added version 2.29.0

---------

Co-authored-by: Shubhendra <withshubh@gmail.com>
2024-02-15 11:51:55 +05:30

199 lines
5.3 KiB
Markdown

---
id: run-actions-from-runjs
title: Run Actions from RunJS query
---
# Run `Actions` from RunJS query
You can trigger all the `actions` available in ToolJet from within the `RunJS` query. This guide includes the syntax for each action along with an example.
### Run Query
To trigger a query, you can use the below functions:
```js
queries.queryName.run()
```
or
```js
await actions.runQuery('<queryName>')
```
In the screenshot below, we are triggering two different queries using two different syntax available for `Run Query` action.
<div style={{textAlign: 'center'}}>
<img style={{ border:'0'}} className="screenshot-full" src="/img/how-to/run-actions-from-runjs/runquery-v2.png" alt="Run Query" />
</div>
### Get Query Data
In the previous section, we saw how we can trigger queries. Once the queries are triggered, if you want to immediately use the data returned by the query inside the RunJS query, you can use the `getData()`, `getRawData()` and `getLoadingState()` functions:
#### Retrieve the latest data of a query:
```js
let response = await queries.getSalesData.run();
// replace getSalesData with your query name
let value = queries.getSalesData.getData();
// replace getSalesData with your query name
```
#### Retrieve the latest raw data of a query:
```js
let response = await queries.getCustomerData.run();
//replace getCustomerData with your query name
let value = queries.getCustomerData.getRawData();
// replace getCustomerData your with query name
```
#### Retreive the loading state of a query:
```js
let response = await queries.getTodos.run()
//replace getTodos with your query name
let value = queries.getTodos.getLoadingState();
//replace getTodos with your query name
```
### Set Variables
To create a variable, you can use the below function:
```javascript
actions.setVariable('<variableName>', `<variableValue>`)
```
### Unset Variable
To delete a created variable, you can use the below function:
```javascript
actions.unSetVariable('<variableName>')
```
### Get Variables
To access variables through immediately after setting them in a RunJS query, you can use the below `getVariable` and `getPageVariable` functions:
#### Retrieve the current value of a variable:
```js
actions.setVariable('mode','dark');
//replace mode with your desired variable name
return actions.getVariable('mode');
```
#### Retrieve the current value of a page-specific variable:
```js
actions.setPageVariable('number',1);
//replace number with your desired variable name
return actions.getPageVariable('number');
```
### Logout
To log out the current logged-in user from the ToolJet, use the below function:
```javascript
actions.logout()
```
### Show Modal
To open a modal using RunJS query, use the below function:
```javascript
actions.showModal('<modalName>')
```
### Close Modal
To close a modal using RunJS query, use the below function:
```javascript
actions.closeModal('<modalName>')
```
### Set Local Storage
Set a value in local storage using the below code:
```javascript
actions.setLocalStorage('key','value')
```
### Copy to Clipboard
Use the below code to copy content to the clipboard:
```javascript
actions.copyToClipboard('<contentToCopy>')
```
### Generate File
The below action can be used to generate a file.
```js
actions.generateFile('<fileName>', '<fileType>', '<data>')
```
`fileName` is the name that you want to give the file(string), `fileType` can be **csv**, **plaintext**, or **pdf** and `data` is the data that you want to store in the file.
Example for generating CSV file:
```js
actions.generateFile('csvfile1', 'csv', '{{components.table1.currentPageData}}') // generate a csv file named csvfile1 with the data from the current page of table
```
Example for generating Text file:
```js
actions.generateFile('textfile1', 'plaintext', '{{JSON.stringify(components.table1.currentPageData)}}') // generate a text file named textfile1 with the data from the current page of table (stringified)
```
Example for generating PDF file:
```js
actions.generateFile('Pdffile1', 'pdf', '{{components.table1.currentPageData}}') // generate a text file named Pdffile1 with the data from the current page of table
```
### Go to App
You can switch to a different application using the below action:
```javascript
actions.goToApp('slug',queryparams)
```
- `slug` can be found in URL of the released app after `application/` or in the share modal that opens up when you click on the `Share` button on the top-right of the app-builder
- `queryparams` can be provided in this format - `[{"key":"value"}, {"key2":"value2"}]`
### Show Alert
To show an alert using RunJS query, use the below code:
```js
actions.showAlert('<alert type>' , '<message>' )
```
Available alert types are `info`, `success`, `warning`, and `danger`.
Example:
```js
actions.showAlert('error' , 'This is an error' )
```
## Run multiple actions from runjs query
To run multiple actions from a RunJS query, you'll have to use **async-await** in the function.
Here is a example code snippet for running the queries and showing alert after specific intervals. Check the complete guide on running queries at specified intervals **[here](/docs/how-to/run-query-at-specified-intervals)**.
```js
actions.setVariable('interval',setInterval(countdown, 5000));
async function countdown(){
await queries.restapi1.run()
await queries.restapi2.run()
await actions.showAlert('info','This is an information')
}
```