From 8b29254a039feeb5f944af0a9e48b0a010e7de30 Mon Sep 17 00:00:00 2001 From: Alexander Ikonomou Date: Tue, 1 Oct 2024 00:13:39 +0200 Subject: [PATCH] docs: add jsdoc for search --- src/search.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/search.ts b/src/search.ts index 7bd811c..6e6fb6a 100644 --- a/src/search.ts +++ b/src/search.ts @@ -3,6 +3,9 @@ import is, { assert } from '@sindresorhus/is' import { emojiData } from './data.js' import { normalizeName } from './utils.js' +/** + * Search for emojis containing the provided name or pattern in their name. + */ export const search = (keyword: RegExp | string) => { assert.any([is.default.string, is.default.regExp], keyword)