{
"anchor": "match_array",
"name": "match_array",
"category": "Enumerate",
"description": "Determines whether the elements in the `value` array matches the `pattern`. By default, it checks that at least one element matches, but can be set to determine if all the elements match.",
"arguments": [
{
"name": "value",
"description": "The array.",
"required": true,
"type": [
"array"
]
},
{
"name": "pattern",
"description": "The regular expression pattern to match against.",
"required": true,
"type": [
"regex"
]
},
{
"name": "all",
"description": "Whether to match on all elements of `value`.",
"required": false,
"type": [
"boolean"
],
"default": "false"
}
],
"return": {
"types": [
"boolean"
]
},
"examples": [
{
"title": "Match at least one element",
"source": "match_array([\"foobar\", \"bazqux\"], r'foo')",
"return": true
},
{
"title": "Match all elements",
"source": "match_array([\"foo\", \"foobar\", \"barfoo\"], r'foo', all: true)",
"return": true
},
{
"title": "No matches",
"source": "match_array([\"bazqux\", \"xyz\"], r'foo')",
"return": false
},
{
"title": "Not all elements match",
"source": "match_array([\"foo\", \"foobar\", \"baz\"], r'foo', all: true)",
"return": false
}
],
"pure": true
}