is_tuple

This function determines whether the provided value is a tuple or not. At least nested arrays are of kind tuple.

This function does not generate an event.

This function has a deprecated alias istuple which will be removed in the next minor release.

Function

is_tuple(value)

Arguments

Argument Type Description
value any (required) The value to be tested.

Return value

Returns true if the given value is a tuple, else it returns false.

Example

This code shows some return values for is_tuple():

[
    is_tuple( [] ),
    is_tuple( tmp = [['nested'], set()] ),
    is_tuple( tmp[0] ),
    is_tuple( tmp[1] ),
];

Return value in JSON format

[
    false,
    false,
    true,
    true
]