# memer-api-js

> An Image Manipulation API with over 50 commands for creating and sharing funny memes.

Latest version **1.0.2** (published 2023-11-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install memer-api-js
pnpm add memer-api-js
yarn add memer-api-js
bun add memer-api-js
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2023-11-12 |
| First published | 2023-10-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 10.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | k4itrun#6889 |
| Maintainers | k4itrun |
| Keywords | funny content, meme creator, meme repository, visual humor, funny pictures, memerapi.js, image-meme, meme generator, memes, discord, discord.js-meme, image-memer, meme imgen, custom memes, humor API, viral images, graphic comedy, meme library, humorous content creation, memes and laughter, viral image API, online humor, memer image manipulation, memerapi, memer-api |

## Links

- npm: https://www.npmjs.com/package/memer-api-js
- Repository: https://github.com/k4itrun/memer-api-js
- Homepage: https://github.com/6889decode
- Issues: https://github.com/k4itrun/memer-api-js/issues
- npm.io page: https://npm.io/package/memer-api-js

## Dependencies (2)

- [discord.js](https://npm.io/package/discord.js.md) ^14.5.3
- [node-fetch](https://npm.io/package/node-fetch.md) ^3.3.2

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2023-11-12
- 1.0.1 — 2023-10-27
- 1.0.0 — 2023-10-27

## README

<p align="center">
   <img src="https://img.shields.io/npm/dt/memer-api-js?style=for-the-badge">
   <img src="https://img.shields.io/npm/v/memer-api-js?style=for-the-badge">
   <img src="https://img.shields.io/github/stars/k4itrun/memer-api-js.svg?style=for-the-badge">
   <img src="https://img.shields.io/github/license/k4itrun/memer-api-js.svg?style=for-the-badge">
   <img src="https://img.shields.io/github/issues/k4itrun/memer-api-js.svg?style=for-the-badge">
   <a href="https://discord.gg/invite/kCdYrAJF8y"><br/><img src="https://badgen.net/discord/online-members/kCdYrAJF8y" alt="Discord"></a>
</p>

> **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:
   ```sh
   npm install memer-api-js@latest
   ```
3. Configure your API key
```JS
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 EXAMPLES !! -->
## Usage

```JS
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](https://memer-6889.js.org/)_


## LINKS

- 📃 Guide/Docs: [Documentation](https://memer-6889.js.org/)
- 💬 Discord: [Server](https://discord.com/invite/kCdYrAJF8y)


## Features

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


<!-- !! LIMITS !! -->
## 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 !! -->
## Roadmap

For a list of proposed features and known issues, please visit the [open issues](https://github.com/k4itrun/Memer-API-js/issues) section.


<!-- !! CONTRIBUTING !! -->
## 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 !! -->
## Contact

Project Link: [Memer-Api-js GitHub](https://github.com/k4itrun/Memer-API-js)


<!-- !! CREDITS !! -->
## Credits
* [Base Images](https://github.com/DankMemer/imgen)
* [Wrapper base](https://github.com/Yash094/Memer-API)

---
_Source: https://npm.io/package/memer-api-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._