array_create.json

{
    "id": "array_create",
    "summary": "Create an array",
    "description": "Creates a new array, which by default is empty.\n\nThe second parameter `repeat` allows to add the given array multiple times to the new array.\n\nIn most cases you can simply pass a (native) array to processes directly, but this process is especially useful to create a new array that is getting returned by a child process, for example in ``apply_dimension()``.",
    "categories": [
        "arrays"
    ],
    "parameters": [
        {
            "name": "data",
            "description": "A (native) array to fill the newly created array with. Defaults to an empty array.",
            "optional": true,
            "default": [],
            "schema": {
                "type": "array",
                "items": {
                    "description": "Any data type is allowed."
                }
            }
        },
        {
            "name": "repeat",
            "description": "The number of times the (native) array specified in `data` is repeatedly added after each other to the new array being created. Defaults to `1`.",
            "optional": true,
            "default": 1,
            "schema": {
                "type": "integer",
                "minimum": 1
            }
        }
    ],
    "returns": {
        "description": "The newly created array.",
        "schema": {
            "type": "array",
            "items": {
                "description": "Any data type is allowed."
            }
        }
    },
    "examples": [
        {
            "arguments": {},
            "returns": []
        },
        {
            "arguments": {
                "data": [
                    "this",
                    "is",
                    "a",
                    "test"
                ]
            },
            "returns": [
                "this",
                "is",
                "a",
                "test"
            ]
        },
        {
            "arguments": {
                "data": [
                    null
                ],
                "repeat": 3
            },
            "returns": [
                null,
                null,
                null
            ]
        },
        {
            "arguments": {
                "data": [
                    1,
                    2,
                    3
                ],
                "repeat": 2
            },
            "returns": [
                1,
                2,
                3,
                1,
                2,
                3
            ]
        }
    ]
}