emoji-emotion

List of emoji rated for valence.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • emojiEmotion
• Data
• Support
• Types
• Compatibility
• Related
• Contribute
• Security
• License

What is this?

This is a list of unicode emoji rated for valence (“goodness” vs “badness”).

When should I use this?

This package can be used for sentiment analysis of emoji. You can use afinn-165 for English words. Use gemoji for more info on emoji.

Install

This package is ESM only. In Node.js (version 14.14+, 16.0+), install with npm:

npm install emoji-emotion

In Deno with esm.sh:

import {emojiEmotion} from 'https://esm.sh/emoji-emotion@3'

In browsers with esm.sh:

<script type="module">
  import {emojiEmotion} from 'https://esm.sh/emoji-emotion@3?bundle'
</script>

Use

import {emojiEmotion} from 'emoji-emotion'

console.log(emojiEmotion.slice(0, 5))

Yields:

[ { name: '100', emoji: '💯', polarity: 3 },
  { name: 'angry', emoji: '😠', polarity: -3 },
  { name: 'anguished', emoji: '😧', polarity: -3 },
  { name: 'astonished', emoji: '😲', polarity: 2 },
  { name: 'black_heart', emoji: '🖤', polarity: 3 } ]

API

This package exports the identifier emojiEmotion. There is no default export.

emojiEmotion

List of emoji rated for valence (Array<Info>).

Info

Emoji rated for valence.

info.name

Name of emoji, according to gemoji (string).

info.emoji

Unicode emoji (string).

info.polarity

Integer between minus five (negative) and plus five (positive) (number).

Data

The included emoji are the faces and cats defined by Unicode. The polarity was hand classified (by one person) based on the names of these emoji (sometimes synonyms) and their AFINN-165 values. Special care was given to not classify based on the images (as different vendors use different pictograms), but only on words and how they are used.

Some emoji receive arguably confusing polarities, such as stuck_out_tongue_closed_eyes (0), due to being used for both positive and negative emotions.

Support

Types

This package is fully typed with TypeScript. It exports the additional type Info.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. It also works in Deno and modern browsers.

Related

• afinn-165 — list of English words rated for valence
• gemoji — info on gemoji (GitHub Emoji)

Contribute

Yes please! See How to Contribute to Open Source.

Security

This package is safe.

License

MIT © Titus Wormer