sort.json

{
    "id": "sort",
    "summary": "Sort data",
    "description": "Sorts an array into ascending (default) or descending order.\n\n**Remarks:**\n\n* The ordering of ties is implementation-dependent.\n* Temporal strings can *not* be compared based on their string representation due to the time zone/time-offset representations.",
    "categories": [
        "arrays",
        "sorting"
    ],
    "parameters": [
        {
            "name": "data",
            "description": "An array with data to sort.",
            "schema": {
                "type": "array",
                "items": {
                    "anyOf": [
                        {
                            "type": "number"
                        },
                        {
                            "type": "null"
                        },
                        {
                            "type": "string",
                            "format": "date-time",
                            "subtype": "date-time"
                        },
                        {
                            "type": "string",
                            "format": "date",
                            "subtype": "date"
                        }
                    ]
                }
            }
        },
        {
            "name": "asc",
            "description": "The default sort order is ascending, with smallest values first. To sort in reverse (descending) order, set this parameter to `false`.",
            "schema": {
                "type": "boolean"
            },
            "default": true,
            "optional": true
        },
        {
            "name": "nodata",
            "description": "Controls the handling of no-data values (`null`). By default, they are removed. If set to `true`, missing values in the data are put last; if set to `false`, they are put first.",
            "schema": {
                "type": [
                    "boolean",
                    "null"
                ]
            },
            "default": null,
            "optional": true
        }
    ],
    "returns": {
        "description": "The sorted array.",
        "schema": {
            "type": "array",
            "items": {
                "anyOf": [
                    {
                        "type": "number"
                    },
                    {
                        "type": "null"
                    },
                    {
                        "type": "string",
                        "format": "date-time",
                        "subtype": "date-time"
                    },
                    {
                        "type": "string",
                        "format": "date",
                        "subtype": "date"
                    }
                ]
            }
        }
    },
    "examples": [
        {
            "arguments": {
                "data": [
                    6,
                    -1,
                    2,
                    null,
                    7,
                    4,
                    null,
                    8,
                    3,
                    9,
                    9
                ]
            },
            "returns": [
                -1,
                2,
                3,
                4,
                6,
                7,
                8,
                9,
                9
            ]
        },
        {
            "arguments": {
                "data": [
                    6,
                    -1,
                    2,
                    null,
                    7,
                    4,
                    null,
                    8,
                    3,
                    9,
                    9
                ],
                "asc": false,
                "nodata": true
            },
            "returns": [
                9,
                9,
                8,
                7,
                6,
                4,
                3,
                2,
                -1,
                null,
                null
            ]
        }
    ],
    "process_graph": {
        "order": {
            "process_id": "order",
            "arguments": {
                "data": {
                    "from_parameter": "data"
                },
                "asc": {
                    "from_parameter": "asc"
                },
                "nodata": {
                    "from_parameter": "nodata"
                }
            }
        },
        "rearrange": {
            "process_id": "rearrange",
            "arguments": {
                "data": {
                    "from_parameter": "data"
                },
                "order": {
                    "from_node": "order"
                }
            },
            "result": true
        }
    }
}