About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Emoji

An emoji database.

Installation

npm install @stdlib/datasets-emoji

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).
• To use as a general utility for the command line, install the corresponding CLI package globally.

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

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

emoji()

Returns an emoji database.

var data = emoji();
// returns [ {...}, ... ]

Each element in the returned database has the following fields:

• group: emoji group (illustrative); e.g., 'Smileys & Emotion'.
• subgroup: emoji subgroup (illustrative); e.g., 'face-smiling'.
• codepoints: list of one or more hex code points, separated by spaces; e.g., '1F600'.
• hash: hash value used to match related emoji.
• status: indicates whether an emoji element is missing one or more emoji presentation selectors. Possible values: 'fully-qualified', 'minimally-qualified', 'unqualified'.
• emoji: rendered emoji; e.g., '😀'.
• short_name: CLDR short name; e.g., 'grinning face'.
• description: short description (often matching the CLDR short name, but omitting skin tones, hair styles, et cetera).
• aliases: an array of emoji aliases (i.e., common names used to refer to an emoji).
• keywords: an array of keywords related to an emoji.
• codes: an array of emoji codes (i.e., convenient character sequences used within text to refer to an emoji); e.g., ':grinning:' and ':call_me_hand::skin-tone-5:'.

In addition, for those emoji supporting skin tones, an element may have the following field:

• skin_tones: an array of skin tone modifiers based on the Fitzpatrick scale; e.g., 'skin-tone-2'.

Examples

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

var data;
var len;
var idx;
var d;
var i;

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

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

---

CLI

Installation

To use as a general utility, install the CLI package globally

npm install -g @stdlib/datasets-emoji-cli

Usage

Usage: emoji [options]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Notes

• Data is written to stdout as newline-delimited JSON (NDJSON).

Examples

$ emoji

License

The data files (databases) are licensed under an Open Data Commons Public Domain Dedication & License 1.0 and their contents are licensed under Creative Commons Zero v1.0 Universal. The software is licensed under Apache License, Version 2.0.

---

See Also

• @stdlib/datasets-emoji-code-picto: emoji codes and pictographs.
• @stdlib/datasets-emoji-picto-code: emoji pictographs and codes.

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

Copyright

Copyright © 2016-2024. The Stdlib Authors.