CASE

Description

Returns the corresponding return_value for the first compare_value equal to the provided value. If no values match, returns default_return_value_optional. If default_return_value_optional is omitted and no matches occur, the function returns $SKIP_ASSIGNMENT.

Syntax

CASE(value, ...[compare_value, return_value], default_return_value_optional) -> Object

Parameters

ParameterData TypeRequiredDescription
valueObjectYesThe value to compare against.
… compare_valueObjectYesThe value to match exactly against the provided value.
… return_valueObjectYesThe value returned if the compare value matches exactly.
default_return_value_optionalObjectNoThe value returned if no compare values match. If omitted and no match occurs, returns $SKIP_ASSIGNMENT.

Examples

CASE("NY", "NY", "New York", "CA", "California") 
-- Returns "New York".
CASE(Score, 100, "Perfect", 50, "Average", 0, "Fail")
-- Returns "Perfect" if Score equals 100.
-- Returns "Average" if Score equals 50.
-- Returns "Fail" if Score equals 0.
-- Returns $SKIP_ASSIGNMENT otherwise.
-- Evaluation stops at the first match.

Tips

  • Ensure that return_value and default_return_value_optional are of the same data type.