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.

Sign up for GitHub

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

Doc - Avoid error null $contains #551

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Doc - Avoid error null $contains #551

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions docs/string-functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,8 @@ Returns `true` if `str` is matched by `pattern`, otherwise it returns `false`. I

The `pattern` parameter can either be a string or a regular expression (regex). If it is a string, the function returns `true` if the characters within `pattern` are contained contiguously within `str`. If it is a regex, the function will return `true` if the regex matches the contents of `str`.

The parameter `str` is required and cannot be undefined. When the parameter is a variable it is a good practice to wrap it with `$string` to avoid unexpected error.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can be undefined. If it is, then the function will return undefined.


__Examples__

- `$contains("abracadabra", "bra")` => `true`
Expand Down