From b73a2fe644f91758ebfaf6af52496e70c7c19573 Mon Sep 17 00:00:00 2001 From: Mads Rasmussen Date: Wed, 2 Oct 2024 20:32:37 +0200 Subject: [PATCH] add docs --- .../string-or-string-array-contains.function.ts | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/Umbraco.Web.UI.Client/src/packages/core/utils/string/string-or-string-array-contains/string-or-string-array-contains.function.ts b/src/Umbraco.Web.UI.Client/src/packages/core/utils/string/string-or-string-array-contains/string-or-string-array-contains.function.ts index 23c9981df1..cc61e13bf9 100644 --- a/src/Umbraco.Web.UI.Client/src/packages/core/utils/string/string-or-string-array-contains/string-or-string-array-contains.function.ts +++ b/src/Umbraco.Web.UI.Client/src/packages/core/utils/string/string-or-string-array-contains/string-or-string-array-contains.function.ts @@ -1,8 +1,9 @@ /** - * - * @param value - * @param search + * @description Check if a string or array of strings contains a specific string + * @param value The string or array of strings to search in + * @param search The string to search for + * @returns {boolean} Whether the string or array of strings contains the search string */ -export function stringOrStringArrayContains(value: string | Array, search: string) { +export function stringOrStringArrayContains(value: string | Array, search: string): boolean { return Array.isArray(value) ? value.indexOf(search) !== -1 : value === search; }