From fd8114c27850d3885c86ab7ca24de475d1ac647c Mon Sep 17 00:00:00 2001 From: Sefinek Date: Wed, 20 Dec 2023 08:14:10 +0100 Subject: [PATCH] Some fixes for docs --- index.d.ts | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/index.d.ts b/index.d.ts index fc9b2ad..4f92ede 100644 --- a/index.d.ts +++ b/index.d.ts @@ -1,7 +1,7 @@ declare module '@sefinek/random-emoji' { /** - * Represents an emoji with name, content, and type. - * Used for the collection of emojis with more detailed information. + * Interface representing an emoji with a name, content, and type. + * Used in the emoji collection to provide more detailed information about each emoji. */ export interface EmojisCollection { content: string; @@ -10,7 +10,7 @@ declare module '@sefinek/random-emoji' { } /** - * Represents an emoji with name and content. + * Interface representing an emoji with a name and content. * Used for simpler emoji categories like cats, hearts, etc. */ export interface Emojis { @@ -19,7 +19,7 @@ declare module '@sefinek/random-emoji' { } /** - * Returns a random emoji from a big collection. + * Returns a random emoji from a large collection. * Each emoji includes its name and type. * @returns {EmojisCollection} A random emoji from the collection. */ @@ -55,15 +55,16 @@ declare module '@sefinek/random-emoji' { */ export function squares(): Emojis; + /** * Returns a random Unicode emoji character. - * @returns {string} A random Unicode emoji. + * @returns {string} A random Unicode emoji character. */ export function unicode(): string; /** - * Represents the response from an API endpoint. - * Includes information about the success status, API category, and the response message. + * Interface representing the response from an API endpoint. + * Includes information about the success status, API category, and response message. */ export interface ApiResponse { success: boolean; @@ -94,4 +95,4 @@ declare module '@sefinek/random-emoji' { * The current version of the module. */ export const version: string; -} +} \ No newline at end of file