Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update higher-order-functions.md: add warning about $map()'s retu… #723

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/higher-order-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ __Signature:__ `$map(array, function)`

Returns an array containing the results of applying the `function` parameter to each value in the `array` parameter.

> :warning: **If your array has exactly one item the returned value won't be an array.** Only that single item will be returned.
>
> In this case, to have the return of `$map()` be a array, please append `[]` to the closing parenthesis of the `$map()` function:
```
$map([1], $string)[]
```

The function that is supplied as the second parameter must have the following signature:

`function(value [, index [, array]])`
Expand Down