2.0.1 • Published 8 years ago
twitchemotes v2.0.1
twitchemotes
Because everybody needs a little bit of Kappa in their lives. This module introduces the twitch emotes set to any passed in string.
Installation
npm install --save twitchemotes
Usage
'use strict';
var twitchemotes = require('twitchemotes');
var emotes = twitchemotes({ /* options */});
As seen in the example above, the twitchemotes
returns a function, this
function replaces the actual text. The twitchemotes
function accepts an object
that allows you to configure what kind of twitch emotes we should introduce. The
following options are supported:
- size: The size of the emotes, can be
small
,medium
orlarge
. Defaults tosmall
. - channels: An array of channel names who's emotes you want to use. Defaults
to
[ twitch ]
so you get the default set of icons. If you introduce your own set of channels make sure you add backtwitch
if you want spam people withKappa
's'
emotes('This module is amazing Kappa') // This module is amazing <img src...
License
MIT
The twitch emote data is fetched from the https://twitchemotes.com site and cached inside this module.