node package manager

food

Food Build Status

Unicode characters are tasty food for programs! feed your apps some emojis. Asciinema here to see in action. Inspired to make working with unicode and emojis easier by this article.

Install

$ npm install --save food

CLI

$ npm install --global food
$ food --help
  unicode characters are tasty food for programs! feed your apps some emojis
 
  Usage
    $ food [input]
 
  Options
    --options  Keywords  [Default: description]
 
  Examples
    $ food search uncirons
    [{
        "unicode": "1F984",
        "display": "🦄",
        "description": "unicorn face",
        "category": "animal-mammal"
    }...

Usage

const food = require('food');
 
food.search('unicorns');
/*=>
    [{
        "unicode": "1F984",
        "display": "🦄",
        "description": "unicorn face",
        "category": "animal-mammal"
    } ...
*/

API

food.emojis

Type: array<object>

Array of emojis with the following properties

unicode

Unicode representation.

display

The visual representation.

description

Description of the emoji.

category

The grouping of the emoji.

food.search(input, [options])

input

Type: string

search term passed in for fuzzy searching.

options

Note** this project uses fuse for searching so see krisk/fuse for full options. ##### key

Type: array<string>
Default: false

A list of nested json parameters for the parser to look for.

License

MIT © Stanley Zheng