unset

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)

Name	Type	Default	Description
unsetRequired	object	-	An object that contains the unset parameters.

unset Parameters

Name	Type	Default	Description
varsRequired	string | string[]	-	Names of the variables to unset.

Variable

Any variable can be unset by this method.

Examples

Unset a single variable

YAML

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

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "set": {
          "num_var": 1
        }
      },
      {
        "play": {
          "url": "say: The value of num_var is: %{num_var}."
        }
      },
      {
        "unset": {
          "vars": "num_var"
        }
      },
      {
        "play": {
          "url": "say: The value of num_var is %{num_var}."
        }
      }
    ]
  }
}

Unset multiple variables

YAML

version: 1.0.0
sections:
  main:
    - set:
        systems:
          hr:
            - tracy
            - luke
          engineering:
            john: absent
        name: john
    - play:
        url: 'say: %{systems.hr}'
    - unset:
        vars:
          - 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}'

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "set": {
          "systems": {
            "hr": [
              "tracy",
              "luke"
            ],
            "engineering": {
              "john": "absent"
            }
          },
          "name": "john"
        }
      },
      {
        "play": {
          "url": "say: %{systems.hr}"
        }
      },
      {
        "unset": {
          "vars": [
            "systems",
            "name"
          ]
        }
      },
      {
        "play": {
          "url": "say: %{systems}"
        }
      }
    ]
  }
}