docs: add jsdoc for search

omnidan · Sep 30, 2024 · 8b29254 · 8b29254
1 parent 7046cbb
commit 8b29254
Showing 1 changed file with 3 additions and 0 deletions.
diff --git 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)