Emoji Dataset

Overview

This dataset is an emoji database providing rich information for each emoji, including its group, subgroup, code points, hash, status, rendered emoji, short name, description, and aliases.

Installation

You can install the dataset via:

npm install @stdlib/datasets-emoji

Alternatively, you can use it in a web page via a <script> tag with the ES Module build, in Deno, in Observable, or as a CLI tool.

Usage

Import and use the dataset:

var emoji = require('@stdlib/datasets-emoji');

Return Value

The emoji() function returns an array where each element contains the following fields:

• group: Emoji group.
• subgroup: Emoji subgroup.
• codepoints: List of code points.
• hash: Hash for matching related emojis.
• status: Emoji status (e.g., fully-qualified, minimally-qualified, unqualified).
• emoji: Rendered emoji character.
• short_name: CLDR short name.
• description: Short description.
• aliases: Array of aliases.
• keywords: Array of related keywords.
• codes: Array of codes.

For emojis supporting skin tones, an additional field may be present:

• skin_tones: Array of skin‑tone modifiers based on the Fitzpatrick scale.

Example

A simple usage example:

var discreteUniform = require('@stdlib/random-base-discrete-uniform');
var emoji = require('@stdlib/datasets-emoji');

var data = emoji();
var len = data.length;

for (var i = 0; i < 100; i++) {
    var idx = discreteUniform(0, len-1);
    var d = data[idx];
    console.log(d.emoji + ' => ' + d.codes[0]);
}

License

The data files are licensed under the Open Data Commons Public Domain Dedication & License 1.0 and Creative Commons Zero v1.0 Universal. The software is licensed under the Apache License 2.0.

Related Links

• @stdlib/datasets-emoji-code-picto
• @stdlib/datasets-emoji-picto-code