emoxy/dist/index.d.ts

A wrapper for emojihub api

declare type EmoxyEmoji = {
    name: string;
    category: string;
    group: string;
    htmlCode: string[];
    unicode: string[];
};

declare type EmoxyEmojiCategory = "smileys-and-people" | "animals-and-nature" | "food-and-drink" | "travel-and-places" | "activities" | "objects" | "symbols" | "flags";

declare type EmoxyResponse = {
    code: number;
    message: string;
    emoji: EmoxyEmoji | null;
};

declare type EmoxyResponseGroup = {
    code: number;
    message: string;
    emojis: EmoxyEmoji[] | null;
};

export declare function getAllCategories(): EmoxyEmojiCategory[];

export declare function getAllEmojis(): Promise<EmoxyResponseGroup>;

export declare function getAllEmojisInCategory(category?: EmoxyEmojiCategory): Promise<EmoxyResponseGroup | null>;

export declare function getAllEmojisInGroup(group?: string): Promise<EmoxyResponseGroup | null>;

export declare function getRandomEmojiInCategory(category?: EmoxyEmojiCategory): Promise<EmoxyResponse | null>;

export declare function getRandomEmojiInGroup(group?: string): Promise<EmoxyResponse | null>;

export declare function getSpecificGroups(category: EmoxyEmojiCategory): string[];

export { }