1.0.2 • Published 6 months ago

memer-api-js v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

Memer-api-js is a robust module that makes image manipulation incredibly straightforward and efficient.

Installation

  1. Get a free API Key at our
  2. Install the package using npm:
    npm install memer-api-js@latest
  3. Configure your API key
const Meme = require("memer-api-js");
const memer = new Meme('Your Cool API Key');  // Obtained from Memer API Server
memer.<Method>(<Options>); // Returns a Promise with a <Buffer>

Usage

const Meme = require("memer-api-js")
const Discord = require("discord.js")
const memer = new Meme('Your Cool API Token'); // Acquired from the Memer API Server

const avatar = "https://i.imgur.com/v3W9wMM.png"; // Please note that only static images are supported
const text = "Memer API is awesome!"

memer.youtube(avatar, 'Memer Api', text).then(image => {
    // This provides you with a 'Buffer', which you can use to create a Discord attachment
    
    var attachment = new Discord.AttachmentBuilder(image, {name:"youtube.png"});
    <channel>.send(attachment)
})

For more examples and detailed usage, please refer to the Documentation

LINKS

Features

  • Super simple and easy to use.
  • More than 50+ methods
  • Easy to Implement.
  • Great support and flexible.

Ratelimits

The Memer API enforces a rate limit of one request every 5 seconds, allowing for one image request every 5 seconds. To bypass this limit, you can consider upgrading to a premium plan.

Roadmap

For a list of proposed features and known issues, please visit the open issues section.

Contributing

Contributions are highly valued and greatly appreciated in the open-source community. If you'd like to contribute, please follow these steps:

  1. Fork the Project
  2. Create a Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Contact

Project Link: Memer-Api-js GitHub

Credits