npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

twitch-emoji

v0.2.209

Published

Parse Twitch emojis

Downloads

408

Readme

twitch-emoji :zap:

Parse Twitch emojis.

Powered by twitchemotes.com.

npm install --save twitch-emoji
<script src="https://unpkg.com/twitch-emoji@^0.2.0/dist/twitchemoji.min.js"></script>

Usage

Browser

For use client side, I recommend using the above CDN. 'Requiring' the module and then using a build task like browserify will add ~4mb to your final file size. This is because the node module has all channel specific emojis preloaded.

Using the cdn will allow you to dynamically load channel specific emojis, meaining you won't add 4mb of (mostly) redundant JSON to your Javascript.

The browser module has global emojis preloaded.

API

.parse( text [, options ])
options.emojiSize

Small, medium or large. Default is medium.

options.channel

Used to parse channel specific emojis. Note that the channel emojis must be added first.

console.log( twitchEmoji.parse( 'spicey memes Kappa' ), { emojiSize : 'medium' } );

// Will produce:
/*
spicey memes <img class="twitch-emoji twitch-emoji-medium" src="https://static-cdn.jtvnw.net/emoticons/v1/25/2.0"/>
*/
.add( channelName [, callback] )

Load a channel specific emoji set.

channelName

The name of the channel to load the emoji set for.

callback

Optional. Has a single error argument.

Returns a promise.

An error will be passed to the callback, and the promise rejected if the channel doesn't have specific emoji sets.

  // Using the callback
  twitchEmoji.add('twoeasy', function( err )
  {
      if( !err )
        // Emoji Set Usable
  });
  
  // Using a promise
  twitchEmoji.add('twoeasy').then(
    function( response )
    {
       // Emoji Set Usable
    },
    function( response )
    {
      // Emoji set not accessable/doesn't exist
    }
  );

Node

API

.parse( text [, options ])
options.emojiSize

Small, medium or large. Default is medium.

options.channel

Used to parse channel specific emojis.

console.log( twitchEmoji.parse( 'spicey memes Kappa' ), { emojiSize : 'medium' } );

// Will produce:
/*
spicey memes <img class="twitch-emoji twitch-emoji-medium" src="https://static-cdn.jtvnw.net/emoticons/v1/25/2.0"/>
*/

License

MIT