find
The following is a list of properties for the function find
:
Property | Value |
---|---|
brief | Returns the first value in a list that passes a test |
category | higher_order_list |
description | The predicate is called for each value in the first list in values until true is returned, then that value is returned. |
functionId | find |
functionLabel | find |
pure | true |
parameters | [ { "dataType": "function", "dataTypeParameter": "(... values: any): boolean", "description": "This is a boolean function that is called to determine if a list entry passes the test.", "name": "predicate" }, { "minArgs": 1, "description": "These are the values passed to the predicate with the exception that the first list is passed as the single current value from the list. At least one list is required.", "name": "values" } ] |
returns | { "description": "The first value that passes the test is returned." } |