pierrolivier / gemoji

Information regarding GitHub emoji: gemoji

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

gemoji Build Status Coverage Status

Gemoji (GitHub Emoji) maps Gemoji short-codes and unicode emoji to objects containing info on their respective category, description, names, and tags.

Installation

npm:

npm install gemoji

Usage

var gemoji = require('gemoji');

gemoji.name.cat;

Yields:

{ category: 'nature',
  description: 'cat face',
  names: [ 'cat' ],
  tags: [ 'pet' ],
  name: 'cat',
  emoji: '🐱' }

By unicode emoji

gemoji.unicode['🐶'];

Yields:

{ category: 'nature',
  description: 'dog face',
  names: [ 'dog' ],
  tags: [ 'pet' ],
  name: 'dog',
  emoji: '🐶' }

...and...

gemoji.unicode['\uD83D\uDCA9'];

Yields:

{ category: 'people',
  description: 'pile of poo',
  names: [ 'hankey', 'poop', 'shit' ],
  tags: [ 'crap' ],
  name: 'hankey',
  emoji: '💩' }

Supported Gemoji

See support.md.

Data

The emoji list is crawled from github/gemoji and later processed for relevant information. See its license for more information.

No images are included in this repository—the copyrighted material may or may not be available on the users computer.

Related

Disclaimer

wooorm/gemoji is not affiliated with GitHub.

License

MIT © Titus Wormer

About

Information regarding GitHub emoji: gemoji

License:MIT License


Languages

Language:JavaScript 100.0%