emojis-pegasus
TypeScript icon, indicating that this package has built-in type declarations

0.2.0 • Public • Published

emojis-pegasus

GitHub last commit GitHub Workflow Status GitHub

All emojis based on Emojipedia up to date automatically each weeks.

To note: The package was initially available on Github Package Registry, but due to some issues and not friendly installation, it will not be updated anymore, so please don't try to use it.*

Install

npm: npm i emojis-pegasus

yarn: yarn add emojis-pegasus

Other: simply fetch at https://raw.githubusercontent.com/Olyno/emojis-pegasus/master/emojis.json

Usage

With ESM syntax

import emojisList from 'emojis-pegasus';

const emojis = emojisList.getEmojis();

// Get a specific emoji
const brainEmoji = emojisList.getEmoji('brain');
const brainEmoji = emojisList.getEmoji(':brain:');
const brainEmoji = emojisList.getEmoji('🧠');
const brainEmoji = emojisList.getEmoji('U+1F9E0');

// Get values
console.log('Emoji name:', brain.name);
console.log('Emoji unicode:', brain.unicode);
console.log('Emoji shortNames:', brain.shortNames);

With commonjs syntax

const emojisList = require('emojis-pegasus').default;

const emojis = emojisList.getEmojis();

// Get a specific emoji
const brainEmoji = emojisList.getEmoji('brain');
const brainEmoji = emojisList.getEmoji(':brain:');
const brainEmoji = emojisList.getEmoji('🧠');
const brainEmoji = emojisList.getEmoji('U+1F9E0');

// Get values
console.log('Emoji name:', brain.name);
console.log('Emoji unicode:', brain.unicode);
console.log('Emoji shortNames:', brain.shortNames);

An emoji looks like that:

{
    name: string;
    nameUrl: string;
    emoji: string;
    unicode: string;
    shortNames: string[];
}

Example:

{
    name: "Man",
    nameUrl: "man-raising-hand",
    emoji: "🙋‍♂️",
    unicode: "U+1F64B‍",
    shortNames: [":man_raising_hand:",":man-raising-hand:",":raising_hand_man:"]
}

Buy me a ko-fi

Whether you use this project, have learned something from it, or just like it, please consider supporting it by buying me a coffee, so I can dedicate more time on open-source projects like this 😉 (personally I prefer hot chocolate but whatever)

ko-fi

License

Code released under GNU GPLv3 license.

Copyright ©, Olyno.

Readme

Keywords

Package Sidebar

Install

npm i emojis-pegasus

Weekly Downloads

1

Version

0.2.0

License

GPL-3.0-or-later

Unpacked Size

290 kB

Total Files

19

Last publish

Collaborators

  • olyno