contains-emoji

contains-emoji

• Simple NPM package that checks if a string contains one or more emojis
• It uses Emoji Regex NPM module
• Works seamlessly with CommonJS, ESM and TypeScript

Install via NPM

$ npm i contains-emoji

Usage

• Returns a Boolean indicating whether string contains one or more emojis.
• See examples below

CommonJS

const containsEmoji = require('contains-emoji');

const textWithEmoji = 'I love pizza 🍕';

// --| Default usage: returns true/false
if (containsEmoji(textWithEmoji)) {
    console.log('Text contains one or more emojis!');
} else {
    console.log('No emojis found.');
}

// --| Using the optional returnCount parameter: returns the number of emojis
const emojiCount = containsEmoji(textWithEmoji, true);
console.log(`Number of emojis found: ${emojiCount}`);

/*
    // --| Expected output
    Text contains one or more emojis!
    Number of emojis found: 1
*/

ESM

import containsEmoji from 'contains-emoji';

const textWithEmoji = 'I love pizza 🍕 and burgers 🍔!';

// --| Default usage: returns true/false
if (containsEmoji(textWithEmoji)) {
    console.log('Text contains one or more emojis!');
} else {
    console.log('No emojis found.');
}

// --| Using the optional returnCount parameter: returns the number of emojis
const emojiCount = containsEmoji(textWithEmoji, true);
console.log(`Number of emojis found: ${emojiCount}`);

/*
    // --| Expected output
    Text contains one or more emojis!
    Number of emojis found: 2
*/

TypeScript

import containsEmoji from 'contains-emoji';

const textWithEmoji: string = 'I love pizza 🍕, burgers 🍔 and cakes 🍰!';

// --| Default usage: returns true/false
if (containsEmoji(textWithEmoji)) {
    console.log('Text contains one or more emojis!');
} else {
    console.log('No emojis found.');
}

// --| Using the optional returnCount parameter: returns the number of emojis
const emojiCount: number = containsEmoji(textWithEmoji, true);
console.log(`Number of emojis found: ${emojiCount}`);

/*
// --| Expected output
    Text contains one or more emojis!
    Number of emojis found: 3
*/