@mkody/twitch-emoticons 2.9.3 → 2.9.5

package/test/other.test.js

@@ -1,5 +1,5 @@
 const { describe, expect, test } = require('@jest/globals');
-const { Emote } = require('../src/index.js');
+const { Emote, EmoteFetcher, EmoteParser } = require('../src/index.js');
 
 describe('Emote class', () => {
     test('Base Emote class should not be used by itself', () => {
@@ -11,3 +11,62 @@ describe('Emote class', () => {
         );
     });
 });
+
+describe('EmoteParser\'s _validateOptions', () => {
+    const fetcher = new EmoteFetcher();
+
+    test('Should not throw on valid options', () => {
+        expect(() => {
+            // eslint-disable-next-line no-unused-vars
+            const parser = new EmoteParser(fetcher, {
+                template: '![{name}]({link} "{name}")',
+                type: 'markdown',
+                match: /:(.+?):/g
+            });
+        }).not.toThrow();
+    });
+
+    test('Should throw on invalid template', () => {
+        expect(() => {
+            // eslint-disable-next-line no-unused-vars
+            const parser = new EmoteParser(fetcher, {
+                template: () => { return 'test'; }
+            });
+        }).toThrow(
+            new TypeError('Template must be a string')
+        );
+    });
+
+    test('Should throw on invalid type', () => {
+        expect(() => {
+            // eslint-disable-next-line no-unused-vars
+            const parser = new EmoteParser(fetcher, {
+                type: 'invalid-type'
+            });
+        }).toThrow(
+            new TypeError('Parse type must be one of `markdown`, `html`, `bbcode`, or `plain`')
+        );
+    });
+
+    test('Should throw when not using a global regex', () => {
+        expect(() => {
+            // eslint-disable-next-line no-unused-vars
+            const parser = new EmoteParser(fetcher, {
+                match: /:(.+?):/
+            });
+        }).toThrow(
+            new TypeError('Match must be a global RegExp.')
+        );
+    });
+
+    test('Should throw when not using a regex object', () => {
+        expect(() => {
+            // eslint-disable-next-line no-unused-vars
+            const parser = new EmoteParser(fetcher, {
+                match: 'not-a-regex'
+            });
+        }).toThrow(
+            new TypeError('Match must be a global RegExp.')
+        );
+    });
+});

package/typings/index.d.ts

@@ -45,7 +45,7 @@ declare module '@mkody/twitch-emoticons' {
             fetcher: EmoteFetcher, 
             options: {
                 template?: string,
-                type?: string,
+                type?: 'html' | 'markdown' | 'bbcode' | 'plain',
                 match?: RegExp
             }
         );
@@ -117,8 +117,8 @@ declare module '@mkody/twitch-emoticons' {
     }
 
     export class Collection<K, V> extends Map<K, V> {
-        public find(propOrFunc: string | ((item: K, index: number, coll: this) => boolean), value?: any): K;
-        public filter(func: (item: K, index: number, coll: this) => boolean): Collection<K, V>;
-        public map(func: (item: K, index: number, coll: this) => any): Array<any>;
+        public find(propOrFunc: string | ((item: V, index: number, coll: this) => boolean), value?: any): V;
+        public filter(func: (item: V, index: number, coll: this) => boolean): Collection<K, V>;
+        public map(func: (item: V, index: number, coll: this) => any): Array<any>;
     }
 }