index.d.ts

/**
 * `Emoji Mix URL Generator` TypeScript Definitions
 * Version 1.2.2
 *
 * Created by MattFor (Discord: MattFor#9884 (currently: mattfor)) on May 30, 2023.
 * Contact: mattfor@relaxy.xyz
 *
 * Licensed under the MIT Licence.
 *
 * This TypeScript module declaration for the 'emoji-mixer' JavaScript module provides
 * strong type checking for its functions and exported variables.
 *
 * Types:
 *
 * `emojiCompatibilityData` - Represents a combination of emojis. It has properties for leftEmoji,
 * rightEmoji, and the date when the combination was added.
 *
 * `emojiCompatibilityDataMap` - A map where each key is a string of emoji Unicode points and each value
 * is an array of `emojiCompatibilityData`.
 *
 * Exported variables:
 *
 * `emojiCompatibilityData` - A map of Unicode code points to arrays of emoji combinations.
 *
 * `supportedEmojis` - An array of strings, each representing an emoji supported by the application.
 *
 * `baseUrl` - The base URL for fetching emoji images from Google's Android Emoji Kitchen.
 *
 * Exported functions:
 *
 * `googleRequestUrlEmojiPart(emoji: string): string` - Transforms an emoji Unicode representation for inclusion in a URL.
 *
 * `toUnicode(input: string, oldToNew?: boolean | false): string | undefined | Error` - Validates and transforms an input into a Unicode representation.
 *
 * `checkSupported(emoji: string, oldToNew?: boolean | false): emojiCompatibilityData[] | null` - Checks if an emoji is supported by looking it up in the `emojiCompatibilityData` object.
 *
 * `googleRequestUrl(emojiMixData: emojiCompatibilityData): string` - Generates a URL for fetching an emoji combination image from Google's Android Emoji Kitchen.
 *
 * `getEmojiCombo(leftEmoji: string, rightEmoji: string): emojiCompatibilityData | undefined` - Finds a matching emoji combination from the `emojiCompatibilityData` object.
 *
 * `getEmojiMixUrl(leftEmoji: string, rightEmoji: string, detailedErrors?: boolean, oldToNew?: boolean | false): string | null | undefined` - Generates a URL for an emoji mix image.
 */
declare module "emoji-mixer" {
    type emojiCompatibilityData = {
        leftEmoji: string;
        rightEmoji: string;
        date: string;
    };

    type emojiCompatibilityDataMap = {
        [key: string]: emojiCompatibilityData;
    };

    export const baseUrl: string;
    export const supportedEmojis: string[];
    export const emojiCompatibilityData: emojiCompatibilityDataMap;

    export function googleRequestUrlEmojiPart(emoji: string): string;
    export function googleRequestUrl(emojiMixData: emojiCompatibilityData): string;
    export function toUnicode(input: string, oldToNew?: boolean | false): string | undefined | Error;
    export function getEmojiCombo(leftEmoji: string, rightEmoji: string): emojiCompatibilityData | undefined;
    export function checkSupported(emoji: string, oldToNew?: boolean | false): emojiCompatibilityData[] | null;

    export default function getEmojiMixUrl(leftEmoji: string, rightEmoji: string, detailedErrors?: boolean, oldToNew?: boolean | false): string | undefined | null;
}