Doc - Avoid error null $contains #551

fredppm · 2021-11-12T21:15:56Z

Add to document a suggestion to avoid unexpected error when using $contains

Add to document a suggestion to avoid unexpected error when using `$contains`

coveralls · 2021-11-12T21:20:52Z

Coverage remained the same at 100.0% when pulling 70c94c1 on fredppm:patch-1 into e6e436d on jsonata-js:master.

andrew-coleman · 2021-11-15T10:51:18Z

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.


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

Doc - Avoid erro null $contains

70c94c1

Add to document a suggestion to avoid unexpected error when using `$contains`

fredppm changed the title ~~Doc - Avoid erro null $contains~~ Doc - Avoid error null $contains Nov 12, 2021

andrew-coleman reviewed Nov 15, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc - Avoid error null $contains #551

Doc - Avoid error null $contains #551

fredppm commented Nov 12, 2021

coveralls commented Nov 12, 2021

andrew-coleman Nov 15, 2021

		@@ -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.

Doc - Avoid error null $contains #551

Are you sure you want to change the base?

Doc - Avoid error null $contains #551

Conversation

fredppm commented Nov 12, 2021

coveralls commented Nov 12, 2021

andrew-coleman Nov 15, 2021

Choose a reason for hiding this comment