first.json

{
    "id": "first",
    "summary": "First element",
    "description": "Gives the first element of an array.\n\nAn array without non-`null` elements resolves always with `null`.",
    "categories": [
        "arrays",
        "reducer"
    ],
    "parameters": [
        {
            "name": "data",
            "description": "An array with elements of any data type.",
            "schema": {
                "type": "array",
                "items": {
                    "description": "Any data type is allowed."
                }
            }
        },
        {
            "name": "ignore_nodata",
            "description": "Indicates whether no-data values are ignored or not. Ignores them by default. Setting this flag to `false` considers no-data values so that `null` is returned if the first value is such a value.",
            "schema": {
                "type": "boolean"
            },
            "default": true,
            "optional": true
        }
    ],
    "returns": {
        "description": "The first element of the input array.",
        "schema": {
            "description": "Any data type is allowed."
        }
    },
    "examples": [
        {
            "arguments": {
                "data": [
                    1,
                    0,
                    3,
                    2
                ]
            },
            "returns": 1
        },
        {
            "arguments": {
                "data": [
                    null,
                    "A",
                    "B"
                ]
            },
            "returns": "A"
        },
        {
            "arguments": {
                "data": [
                    null,
                    2,
                    3
                ],
                "ignore_nodata": false
            },
            "returns": null
        },
        {
            "description": "The input array is empty: return `null`.",
            "arguments": {
                "data": []
            },
            "returns": null
        }
    ]
}