meowverse
v1.0.4
Published
A lightweight JavaScript library to fetch random cat images from a remote API.
Maintainers
osmankaanReadme
🐾 Meowverse
Meowverse is a lightweight and modern JavaScript library that delivers random and delightful cat images from a remote API. Whether you're building a fun app, a mood tracker, or just want a furry friend to lighten your UI, Meowverse is here to purr-fectionize your project.
✨ Features
- 🐱 Fetches random cat images
- 🎨 Get cats by color
- 😺 Pick cats by mood
- 🌈 Combine color + mood for curated results
- 🚀 Super fast thanks to in-memory caching
📦 Installation
To install Meowverse, use npm:
npm install meowverse🛠️ Usage
To use Meowverse, import the required functions and start showing cats with different moods, colors, or even random ones:
import {
purrfectlyRandomCat,
rainbowCatFinder,
moodyCatPicker,
colorfulMoodCats
} from "meowverse";
const showCats = async () => {
console.log("Random cat:", await purrfectlyRandomCat());
console.log("Black cat:", await rainbowCatFinder("black"));
console.log("Happy cat:", await moodyCatPicker("happy"));
console.log("White + sleepy cat:", await colorfulMoodCats("white", "sleepy"));
};
showCats();This example demonstrates how you can call the functions to retrieve different cat images, either randomly, by color, mood, or a combination of both. Simply run the code to get cat images in your console.
📖 API Reference
Here are the functions available in Meowverse:
purrfectlyRandomCat()
Returns a random cat image URL.
- Returns: A URL of a random cat image.
Example:
const randomCat = await purrfectlyRandomCat();
console.log(randomCat); // Prints a random cat image URLrainbowCatFinder(color)
Returns a cat image URL based on the color provided.
- Parameter:
color(string) - The color of the cat (e.g.,"black","white"). - Returns: A URL of the cat image or a message if no match is found.
Example:
const blackCat = await rainbowCatFinder("black");
console.log(blackCat); // Prints a black cat image URLmoodyCatPicker(mood)
Returns a cat image URL based on the mood provided.
- Parameter:
mood(string) - The mood of the cat (e.g.,"happy","sleepy"). - Returns: A URL of the cat image or a message if no match is found.
Example:
const happyCat = await moodyCatPicker("happy");
console.log(happyCat); // Prints a happy cat image URLcolorfulMoodCats(color, mood)
Returns a cat image URL based on both the color and mood provided.
- Parameters:
color(string) - The color of the cat.mood(string) - The mood of the cat.
- Returns: A URL of the cat image or a message if no match is found.
Example:
const whiteSleepyCat = await colorfulMoodCats("white", "sleepy");
console.log(whiteSleepyCat); // Prints a white, sleepy cat image URL💻 Development
To contribute to Meowverse, follow these steps:
- Fork the repository.
- Clone your fork locally.
- Create a new branch (
git checkout -b feature-branch). - Commit your changes (
git commit -am 'Add new feature'). - Push to your branch (
git push origin feature-branch). - Create a pull request.
📝 License
Meowverse is licensed under the MIT License - see the LICENSE file for details.
🤖 API Example
Here’s how you can use the functions provided in Meowverse:
import {
purrfectlyRandomCat,
rainbowCatFinder,
moodyCatPicker,
colorfulMoodCats
} from "meowverse";
// HTML'de img elementlerini almak
const randomCatImg = document.getElementById("random-cat");
const blackCatImg = document.getElementById("black-cat");
const happyCatImg = document.getElementById("happy-cat");
const whiteSleepyCatImg = document.getElementById("white-sleepy-cat");
const showCats = async () => {
// Kedi resimlerini API'den alıp img elementlerine yerleştirme
randomCatImg.src = await purrfectlyRandomCat();
blackCatImg.src = await rainbowCatFinder("black");
happyCatImg.src = await moodyCatPicker("happy");
whiteSleepyCatImg.src = await colorfulMoodCats("white", "sleepy");
};
// Kedi resimlerini göstermek için fonksiyonu çalıştır
showCats();HTML part:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Meowverse Cats</title>
</head>
<body>
<h1>Random Cat</h1>
<img id="random-cat" alt="Random Cat" width="300" />
<h1>Black Cat</h1>
<img id="black-cat" alt="Black Cat" width="300" />
<h1>Happy Cat</h1>
<img id="happy-cat" alt="Happy Cat" width="300" />
<h1>White Sleepy Cat</h1>
<img id="white-sleepy-cat" alt="White Sleepy Cat" width="300" />
<script src="path/to/your/script.js"></script>
</body>
</html>This example shows how to use Meowverse to fetch random, colored, and mood-based cat images and display them on a webpage.
Happy coding and enjoy the cute cat images! 🐱