From 9069bc50d3a5c545673b392ec5a00e50ae83b010 Mon Sep 17 00:00:00 2001
From: Mirone <Saul.Mirone@gmail.com>
Date: Tue, 29 Mar 2022 16:54:35 +0800
Subject: [PATCH] feat(typescript): improve declarations

---
 index.d.ts | 52 ++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 48 insertions(+), 4 deletions(-)

diff --git a/index.d.ts b/index.d.ts
index 0a170978..ffed054a 100644
--- a/index.d.ts
+++ b/index.d.ts
@@ -1,3 +1,14 @@
+/**
+ * If given to parse, this callback will be invoked per each found emoji.
+ *
+ * If this callback returns a falsy value instead of a valid `src` to use for the image, nothing will actually change for that specific emoji.
+ *
+ * @param icon the lower case HEX code point i.e. "1f4a9"
+ * @param options all info for this parsing operation
+ * @param variant the optional \uFE0F ("as image") variant, in case this info is anyhow meaningful. By default this is ignored.
+ */
+declare type ParseCallback = (icon: string, options: object, variant: string) => string | false;
+
 declare interface TwemojiOptions {
   /**
    * Default: MaxCDN
@@ -22,19 +33,52 @@ declare interface TwemojiOptions {
   /**
    * The function to invoke in order to generate image src(s).
    */
-  callback?(icon: string, options: TwemojiOptions): void;
+  callback?: ParseCallback
   /**
+   * The function to invoke in order to generate additional, custom attributes for the image tag.
    * Default () => ({})
+   * @param icon the lower case HEX code point i.e. "1f4a9"
+   * @param variant variant the optional \uFE0F ("as image") variant, in case this info is anyhow meaningful. By default this is ignored.
+   * 
    */
-  attributes?(): void;
+  attributes?(icon: string, variant: string): object;
 }
 
 declare type Twemoji = {
   convert: {
+    /**
+     * Given an HEX codepoint, returns UTF16 surrogate pairs.
+     *
+     * @param   codepoint string  generic codepoint, i.e. '1F4A9'
+     * @return  string  codepoint transformed into utf16 surrogates pair,
+     *          i.e. \uD83D\uDCA9
+     *
+     * @example
+     *  twemoji.convert.fromCodePoint('1f1e8');
+     *  // "\ud83c\udde8"
+     *
+     *  '1f1e8-1f1f3'.split('-').map(twemoji.convert.fromCodePoint).join('')
+     *  // "\ud83c\udde8\ud83c\uddf3"
+     */
     fromCodePoint(hexCodePoint: string): string;
-    toCodePoint(utf16surrogatePairs: string): string;
+
+    /**
+     * Given UTF16 surrogate pairs, returns the equivalent HEX codepoint.
+     *
+     * @param   utf16surrogatePairs   string  generic utf16 surrogates pair, i.e. \uD83D\uDCA9
+     * @param   sep                 string  optional separator for double code points, default='-'
+     * @return  string  utf16 transformed into codepoint, i.e. '1F4A9'
+     *
+     * @example
+     *  twemoji.convert.toCodePoint('\ud83c\udde8\ud83c\uddf3');
+     *  // "1f1e8-1f1f3"
+     *
+     *  twemoji.convert.toCodePoint('\ud83c\udde8\ud83c\uddf3', '~');
+     *  // "1f1e8~1f1f3"
+     */
+    toCodePoint(utf16surrogatePairs: string, sep?: string): string;
   };
-  parse(node: HTMLElement | string, options?: TwemojiOptions): void;
+  parse<T extends string | HTMLElement>(node: T, options?: TwemojiOptions | ParseCallback): T;
 };
 
 declare module 'twemoji' {