if.json

{
    "id": "if",
    "summary": "If-Then-Else conditional",
    "description": "Returns the value of the `accept` parameter if the expression is `true` or the value of the `reject` parameter if the expression is `false`. This works similar to an if-then-else construct.\n\nThe no-data value `null` is passed through and therefore gets propagated.",
    "categories": [
        "logic",
        "comparison",
        "masks"
    ],
    "parameter_order": ["expression", "accept", "reject"],
    "parameters": {
        "expression": {
            "description": "A boolean value.",
            "schema": {
                "type": [
                    "boolean",
                    "null"
                ]
            },
            "required": true
        },
        "accept": {
            "description": "A value that is returned if the boolean expression is `true`. Defaults to `true`.",
            "schema": {
                "description": "Any data type is allowed.",
                "default": true
            }
        },
        "reject": {
            "description": "A value that is returned if the boolean expression is `false`. Defaults to `false`.",
            "schema": {
                "description": "Any data type is allowed.",
                "default": false
            }
        }
    },
    "returns": {
        "description": "Either the `accept` or `reject` argument depending on the given boolean expression.",
        "schema": {
            "description": "Any data type is allowed."
        }
    },
    "examples": [
        {
            "arguments": {
                "expression": true
            },
            "returns": true
        },
        {
            "arguments": {
                "expression": null
            },
            "returns": null
        },
        {
            "arguments": {
                "expression": false
            },
            "returns": false
        },
        {
            "arguments": {
                "expression": true,
                "accept": "A"
            },
            "returns": "A"
        },
        {
            "arguments": {
                "expression": false,
                "accept": [1,2,3],
                "reject": [4,5,6]
            },
            "returns": [4,5,6]
        }
    ]
}