emoji-data
Version:
Emoji encoding swiss army knife for NodeJS
126 lines • 3.93 kB
HTML
<html>
<head>
<meta charset='UTF-8'>
<title>CoffeeScript API Documentation</title>
<script src='../javascript/application.js'></script>
<script src='../javascript/search.js'></script>
<link rel='stylesheet' href='../stylesheets/application.css' type='text/css'>
</head>
<body>
<div id='base' data-path='../'></div>
<div id='header'>
<div id='menu'>
<a href='../extra/README.md.html' title='Emoji-data'>
Emoji-data
</a>
»
<a href='../alphabetical_index.html' title='Index'>
Index
</a>
»
<span class='title'>README.md</span>
</div>
</div>
<div id='content'>
<nav class='toc'>
<p class='title'>
<a class='hide_toc' href='#'>
<strong>Table of Contents</strong>
</a>
<small>
(<a class='float_toc' href='#'>left</a>)
</small>
</p>
</nav>
<div id='filecontents'>
<h1 id="emoji-data-js">emoji-data-js</h1><p>NodeJS library providing low level operations for dealing with Emoji
glyphs in the Unicode standard. :cool:</p><p>EmojiData.js is like a swiss-army knife for dealing with Emoji encoding issues.
If all you need to do is translate <code>:poop:</code> into :poop:, then there are plenty
of other libs out there that will probably do what you want. But once you are
dealing with Emoji as a fundamental part of your application, and you start to
realize the nightmare of [doublebyte encoding][doublebyte] or
[variants][variant], then this library may be your new best friend.
:raised_hands:</p><p>EmojiData.js is written by the same author as the Ruby <a href="https://github.com/mroth/emoji_data.rb">emoji_data.rb</a> gem,
which is used in production by <a href="http://www.emojitracker.com">Emojitracker.com</a> to parse well
over 100M+ emoji glyphs daily. This version was written to provide all the same
functionality while taking advantage of the crazy speed of the V8 runtime
environment. :dizzy:</p><p><strong>WORK IN PROGRESS - NOT RELEASED JUST YET</strong></p><p><a href="https://travis-ci.org/mroth/emoji-data-js"><img src="https://travis-ci.org/mroth/emoji-data-js.svg?branch=master" alt="Build Status"></a></p><h2 id="installation">Installation</h2><p>(Placeholder: won't work until this is released)</p><pre><code>npm install emoji-data
</code></pre><h2 id="usage-examples">Usage Examples</h2><p>TODO</p><h2 id="testing">Testing</h2>
<pre><code>npm test
</code></pre><h2 id="license">License</h2><p><a href="LICENSE">The MIT License (MIT)</a></p>
</div>
</div>
<div id='footer'>
September 02, 14 22:28:50 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.0.9
✲
Press H to see the keyboard shortcuts
✲
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
✲
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>