npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

emoxy

v1.0.4

Published

A wrapper for emojihub api

Downloads

6

Readme

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
  1. install dependencies
bun install
  1. To run the server
bun dev
  1. To run tests
bun run test
  1. To build for production
bun run build