Skip to main content
Version: Cloud and 3.250 Edge

The Variable object

Variables that store temporary state.

Version: Cloud and 3.250 Edge

Each instance has a unique name with which to reference (e.g., myVariable1.value).

Properties​

All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

value​

The value.

Type string | number | boolean | object | array
Configurability Read-only
Defaultnull

Methods​

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

variable.setIn()​

Set the value of a nested key. This method returns a promise and can only be used in JavaScript queries, not in transformers or {{ }} dynamic expressions.

Definition
await variable.setIn(options)
Parameters

options​

The value and key-path in which to set.

Type object
Object Properties

keyPath​

A list of key names that represent the hierarchical structure of a variable object when setting a value. The last item is the key on which the value is set.

Type array
Array values string

value​

The value.

Type string | number | boolean | object | array
Examples

Set the value of userKey in variable to userValue.

variable.setIn({keyPath: 'userKey', value: userValue});

variable.setValue()​

Set the current value.

Definition
variable.setValue(key, value)
Parameters

key​

The key.

Type string

value​

The value.

Type string | number | boolean | object | array
Examples

Set the current value of variable to userValue.

variable.setValue(userValue);