emoxy

EMOXY👀 - A Javascript API wrapper for Emojihub

Emoxy is a Javascript library for interacting with the Emojihub API.

Installation

npm install emoxy

Usage

Import the library:

//using require() syntax 
const emoxy = require("emoxy");

//using imports
import {} from 'emoxy'

getAllEmojis()

import {getAllEmojis} from 'emoxy'
const allEmojis = await getAllEmojis();

/* returns an object
{
    code:200,
    emojis:[...],
    message:success
}
*/

getAllCategories

import {getAllCategories} from 'emoxy';
const categories = getAllCategories()
/*returns an array
  
   [
     {
       name:'',
       group:[...]
     },
     ...
  ]
  
  
*/

getSpecificGroups

Returns the group names that are found that said category. can be used to get arguments to be used with getAllEmojisInGroup() or getRandomEmojiInGroup

import {getSpecificGroups} from 'emoxy';
const group = getSpecificGroups('category')

getAllEmojisInCategory

import {getAllEmojisInCategories} from 'emoxy';
const emojis = getAllEmojisInCategories('category')

/* returns an object
{
    code:200,
    emojis:[...],
    message:success
}
*/
  

getRandomEmojiInCategory

import {getRandomEmojiInCategory} from 'emoxy';
const emoji = getRandomEmojiInCategory('category')

/* returns an object
{
    code:200,
    emoji:{...},
    message:success
}
*/
  

getAllEmojisInGroup

import {getAllEmojisInGroup} from 'emoxy';
const emojis = getAllEmojisInGroup('group')

/* returns an object
{
    code:200,
    emojis:[...],
    message:success
}
*/
  

getRandomEmojiInGroup

import {getRandomEmojiInGroup} from 'emoxy';
const emoji = getRandomEmojiInGroup('group')

/* returns an object
{
    code:200,
    emoji:{...},
    message:success
}
*/
  

Types definitions (for typescript users)

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

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



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

This project was built using:

• Typescript
• Bun

Appreciation

Thanks to the original API from Emojihub

Contributing

1. CLone the repo

git clone https://github.com/michaelnji/emoxy.git

2. install dependencies

bun install

3. To run the server

bun dev

4. To run tests

bun run test

5. To build for production

bun run build