Skip to content

Commit

Permalink
Some fixes for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sefinek committed Dec 20, 2023
1 parent 76e7961 commit fd8114c
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -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;
Expand All @@ -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 {
Expand All @@ -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.
*/
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -94,4 +95,4 @@ declare module '@sefinek/random-emoji' {
* The current version of the module.
*/
export const version: string;
}
}

0 comments on commit fd8114c

Please sign in to comment.