ummoji-client

ummoji-client

queryable, structured emoji metadata

This is a dependency-free module for Node.js and browsers that exports a bunch of emoji metadata from various sources:

{
  name: 'KISSING CAT FACE WITH CLOSED EYES',
  shortName: 'kissing_cat',
  unified: '1F63D',
  char: '😽',
  rank: 7806498, // how frequently it's used on Twitter
  keywords: ['animal', 'cats'], // synonyms
  emotion: 3 // 10 is good, -10 is bad
}

Installation

npm install ummoji-client --save

Usage

const emoji = require('ummoji-client')

The exported object has two properties: entries and matching.

entries is an array of all the raw emoji objects:

emoji.entries.length
// 845

matching is a convenience function for finding emoji. The given string is searched for (case insensitively) within the name, shortName, Unicode id, and keywords:

> emoji.matching('kiss').slice(0,3)

This returns matches, sorted by their frequency of usage on Twitter:

[
  { name: 'FACE THROWING A KISS',
    shortName: 'kissing_heart',
    unified: '1F618',
    char: '😘',
    rank: 325477258,
    keywords: [ 'face', 'love', 'like', 'affection', 'valentines', 'infatuation' ],
    emotion: 4 },
  { name: 'KISS MARK',
    shortName: 'kiss',
    unified: '1F48B',
    char: '💋',
    rank: 75733344,
    keywords: [ 'face', 'lips', 'love', 'like', 'affection', 'valentines' ] },
  { name: 'KISSING FACE WITH CLOSED EYES',
    shortName: 'kissing_closed_eyes',
    unified: '1F61A',
    char: '😚',
    rank: 41142755,
    keywords: [ 'face', 'love', 'like', 'affection', 'valentines', 'infatuation' ],
    emotion: 3
  }
]

Tests

npm install
npm test

Dependencies

None

Dev Dependencies

• emoji-data: Emoji encoding swiss army knife for NodeJS
• emoji-emotion: List of emoji rated for valence in JSON
• emoji-rankings: List of emoji ranked by frequency of use on Twitter
• emoji-synonyms: Synonyms for emoji, to make them easier to find
• tap-spec: Formatted TAP output like Mocha's spec reporter
• tape: tap-producing test harness for node and browsers

License

MIT

Generated by package-json-to-readme