chore(typescript): adds definitions

twitter · Mar 5, 2021 · a10463b · a10463b
1 parent 8e5c8c7
commit a10463b
Showing 1 changed file with 41 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,41 @@
+interface TwemojiOptions {
+  /**
+   * Default: MaxCDN
+   */
+  base?: string;
+  /**
+   * Default: .png
+   */
+  ext?: string;
+  /**
+   * Default: emoji
+   */
+  className?: string;
+  /**
+   * Default: 72x72
+   */
+  size?: string | number;
+  /**
+   * To render with SVG use `folder: svg, ext: .svg`
+   */
+  folder?: string;
+  /**
+   * The function to invoke in order to generate image src(s).
+   */
+  callback?(icon: string, options: TwemojiOptions): void;
+  /**
+   * Default () => ({})
+   */
+  attributes?(): void;
+}
+
+const twemoji: {
+  convert: {
+    fromCodePoint(hexCodePoint: string): string;
+    toCodePoint(utf16surrogatePairs: string): string;
+  };
+  parse(node: HTMLElement | string, options?: TwemojiOptions): void;
+};
+
+export default twemoji;
+