Merge pull request #203 from ikelax/docs/add-JSDoc-comments-from-DT-p…

…r-issue-136

docs: add JSDoc comments from DefinitelyTyped pull request

src/emojify.ts

@@ -10,10 +10,20 @@ export type EmojifyFormat = (
 ) => string
 
 export interface EmojifyOptions {
+  /**
+   * The string to fallback to if an emoji was not found.
+   */
   fallback?: ((part: string) => string) | string
+
+  /**
+   * Adds a middleware layer to modify each matched emoji after parsing.
+   */
   format?: EmojifyFormat
 }
 
+/**
+ * Parse all markdown-encoded emojis in a string.
+ */
 export const emojify = (
   input: string,
   { fallback, format = name => name }: EmojifyOptions = {},

src/find.ts

@@ -1,6 +1,9 @@
 import { findByCode } from './findByCode.js'
 import { findByName } from './findByName.js'
 
+/**
+ * Get the name and character of an emoji.
+ */
 export const find = (codeOrName: string) => {
   return findByCode(codeOrName) ?? findByName(codeOrName)
 }

src/get.ts

@@ -3,6 +3,9 @@ import { assert } from '@sindresorhus/is'
 import { emojiCodesByName } from './data.js'
 import { normalizeName } from './utils.js'
 
+/**
+ * Get an emoji from an emoji name.
+ */
 export const get = (codeOrName: string) => {
   assert.string(codeOrName)
 

src/has.ts

@@ -3,6 +3,9 @@ import { assert } from '@sindresorhus/is'
 import { emojiCodesByName, emojiNamesByCode } from './data.js'
 import { normalizeCode, normalizeName } from './utils.js'
 
+/**
+ * Check if this library supports a specific emoji.
+ */
 export const has = (codeOrName: string) => {
   assert.string(codeOrName)
 

src/random.ts

@@ -1,6 +1,9 @@
 import { emojiData } from './data.js'
 import { randomItem } from './utils.js'
 
+/**
+ * Get a random emoji.
+ */
 export const random = () => {
   const [name, emoji] = randomItem(emojiData)
   return { emoji, name }

src/replace.ts

@@ -10,6 +10,9 @@ export type ReplaceReplacement = (
   string: string,
 ) => string
 
+/**
+ * Replace the emojis in a string.
+ */
 export const replace = (
   input: string,
   replacement: ReplaceReplacement | string,

src/search.ts

@@ -3,6 +3,9 @@ import { assert } from '@sindresorhus/is'
 import { emojiData } from './data.js'
 import { normalizeName } from './utils.js'
 
+/**
+ * Search for emojis containing the provided name in their name.
+ */
 export const search = (keyword: string) => {
   assert.string(keyword)
 

src/strip.ts

@@ -1,8 +1,14 @@
 import { replace } from './replace.js'
 
 export interface StripOptions {
+  /**
+   * Whether to keep the extra space after a stripped emoji.
+   */
   preserveSpaces?: boolean
 }
 
+/**
+ * Remove all the emojis from a string.
+ */
 export const strip = (input: string, { preserveSpaces }: StripOptions = {}) =>
   replace(input, '', { preserveSpaces })

src/unemojify.ts

@@ -3,6 +3,9 @@ import { assert } from '@sindresorhus/is'
 import { charRegexMatcher } from './utils.js'
 import { which } from './which.js'
 
+/**
+ * Convert all emojis in a string to their markdown-encoded counterparts.
+ */
 export const unemojify = (input: string) => {
   assert.string(input)
 

src/which.ts

@@ -7,6 +7,9 @@ export interface WhichOptions {
   markdown?: boolean
 }
 
+/**
+ * Get an emoji name from an emoji.
+ */
 export const which = (
   emoji: string,
   { markdown = false }: WhichOptions = {},