food/readme.md

unicode characters are tasty food for programs! feed your apps some emojis

# Food [![Build Status](https://travis-ci.org/stanzhengdev/npm-food.svg?branch=master)](https://travis-ci.org/stanzhengdev/npm-food)

>
Unicode characters are tasty food for programs! feed your apps some emojis. Asciinema [here to see in action](https://asciinema.org/a/4z508ketoj69ct2k30bywimvh).
Inspired to make working with unicode and emojis easier by this [article](http://blog.jonnew.com/posts/poo-dot-length-equals-two).

## 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

```js
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](https://github.com/krisk/fuse#options) for full options.
##### key

Type: `array<string>`<br>
Default: `false`

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


## License

MIT © [Stanley Zheng](https://github.com/stanzheng)