From 70c94c12ccd31092eedd0f60d8d404181d433bc6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Frederico=20Mour=C3=A3o?= Date: Fri, 12 Nov 2021 18:15:31 -0300 Subject: [PATCH] Doc - Avoid erro null $contains Add to document a suggestion to avoid unexpected error when using `$contains` --- docs/string-functions.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/string-functions.md b/docs/string-functions.md index c4638a9c..0d8e38c7 100644 --- a/docs/string-functions.md +++ b/docs/string-functions.md @@ -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. + __Examples__ - `$contains("abracadabra", "bra")` => `true`