Skip to navigation
Calling

unset

View as MarkdownOpen in Claude

Unset specified variables. The variables have been set either using the set command or as a byproduct of some other statements or methods (like record)

unset
string | string[]Required

The name of the variable to unset (as a string) or an array of variable names to unset. Each name is a literal variable name, not a variable reference: an ASCII letter or underscore followed by up to 255 ASCII letters, digits, or underscores, optionally prefixed with vars..

Variable

unset removes top-level variables of the current call. foo and vars.foo remove the same variable, and the variable’s whole value is removed, even when it holds an object or array. Dotted child paths such as systems.hr and other namespaces such as call or params can’t be unset.

Examples

Unset a single variable

version: 1.0.0
sections:
main:
- set:
num_var: 1
- play:
url: 'say: The value of num_var is: ${num_var}.'
- unset: num_var
- play:
url: 'say: The value of num_var is ${num_var}.'

Unset multiple variables

version: 1.0.0
sections:
main:
- set:
systems:
hr:
- tracy
- luke
engineering:
john: absent
name: john
- play:
url: 'say: ${systems.hr}'
- unset:
- systems
- name
# this play statement emits an error because `systems` is undefined
# at this point so there's nothing for `play` to say.
- play:
url: 'say: ${systems}'

See Also