1.0.2 • Published 6 months ago
fukerjs v1.0.2
FukerJS
FukerJS is a fun and sarcastic open-source package that allows you to generate a middle finger emoji with different skin tones and detect whether a given string contains a middle finger emoji.
🚀 Features
- Generate Middle Finger: Get a random or specific skin tone middle finger emoji.
- Detect Middle Finger: Check if a string contains a middle finger emoji.
📦 Installation
You can install FukerJS using npm or yarn:
npm install fukerjs
or
yarn add fukerjs
🛠️ Usage
Import and use the package in your JavaScript or TypeScript project:
import faker from "fukerjs";
// Generate a middle finger emoji (default: dark skin tone)
console.log(faker.generateMiddleFinger()); // 🖕🏿
// Generate a middle finger emoji with a specific skin tone
console.log(faker.generateMiddleFinger({ skinTone: 1 })); // 🖕
console.log(faker.generateMiddleFinger({ skinTone: 3 })); // 🖕🏼
// Check if a string contains a middle finger emoji
console.log(faker.isMiddleFinger("🖕")); // true
console.log(faker.isMiddleFinger("👍")); // false
🎨 Skin Tone Guide
Skin Tone Option | Emoji |
---|---|
1 | 🖕 |
2 | 🖕🏻 |
3 | 🖕🏼 |
4 | 🖕🏽 |
5 | 🖕🏾 |
Default (6) | 🖕🏿 |
📜 License
This project is licensed under the MIT License.
⚠️ Disclaimer
This package is made for fun and should not be used for offensive purposes. Use responsibly and with humor! 🎭
🛠️ Contributing
We welcome contributions! Here's how you can help:
- Fork the repository.
- Clone your forked repository to your local machine.
- Create a new branch for your feature or bug fix.
- Write tests for your changes if applicable.
- Open a pull request with a clear description of your changes.