# poopoo-api

> the whole poopoo api in one package

Latest version **1.0.3** (published 2022-03-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install poopoo-api
pnpm add poopoo-api
yarn add poopoo-api
bun add poopoo-api
```

## 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.3 |
| Published | 2022-03-18 |
| First published | 2022-03-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 43.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | frostzzone |
| Maintainers | frostzzone |
| Keywords | poopoo, api |

## Links

- npm: https://www.npmjs.com/package/poopoo-api
- Repository: https://github.com/frostzzone/poopoo-api
- Homepage: https://github.com/frostzzone/poopoo-api#readme
- Issues: https://github.com/frostzzone/poopoo-api/issues
- npm.io page: https://npm.io/package/poopoo-api

## Dependencies (4)

- [npm](https://npm.io/package/npm.md) ^8.5.5
- [jimp](https://npm.io/package/jimp.md) ^0.16.1
- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [node-fetch](https://npm.io/package/node-fetch.md) ^3.2.3

## Recent versions

- 1.0.3 (latest) — 2022-03-18
- 1.0.2 — 2022-03-17
- 1.0.1 — 2022-03-17
- 1.0.0 — 2022-03-17

## README

# 💩 poopoo-api

Welcome to an "ok" api

[![NPM](https://nodei.co/npm/poopoo-api.png)](https://nodei.co/npm/poopoo-api/)
[![downloadsBadge](https://img.shields.io/npm/dt/poopoo-api?style=for-the-badge)](https://npmjs.com/poopoo-api)[![versionBadge](https://img.shields.io/npm/v/poopoo-api?style=for-the-badge)](https://npmjs.com/poopoo-api)

⭐ If you like this package, don't forget to star Github package repo [here](https://github.com/frostzzone/poopoo-api-package) and the website repo [here](https://github.com/frostzzone/poopoo-api)

---

# Example code:

```js
(async () => {
    const poo = require('poopoo-api')

    poo.image('./image.png', 'https://api.frostzzone.repl.co/example.png', false) // saves image for later use :troll:

    //reqired to be used in await
    let qotd = await poo.qotd()
    console.log(qotd)

    let github = await poo.git()
    //Returns an object
    /* Example response
{
    "url": "https://api.github.com/users/frostzzone",
    "avatar": "https://avatars.githubusercontent.com/u/65735427?v=4",
    "account_type": "User",
    "name": "frostzzone",
    "company": "At",
    "blog": "https://frostzzone.github.io",
    "location": "Neptune",
    "email": "None",
    "bio": "Hello i am frostzzone,\r\nI code in: node.js, html, css, a lil bit of vue.js, and scratch\r\nI make discord bots :p",
    "twitter": "Not Set",
    "public_repos": 22,
    "public_gists": 2,
    "followers": 7,
    "following": 12,
    "created_at": "2020-05-21T19:59:34Z",
    "updated_at": "2022-03-08T15:39:29Z"
}
*/
    console.log(github.avatar)

    //encodes input to binary
    let encoded = poo.encode(69)
    console.log(encoded)
    //decodes binary
    console.log(poo.decode(encoded))
    //Makes the input annoying Discord Spoilers :troll:
    console.log(poo.spoil("Hello"))

    let pass = poo.password()
    console.log(pass.password)
    console.log(pass.recoverCode)

    //remove all emojis
    console.log(await poo.remove('emoji', 'Hello 💩'))
    //remove every thing except abc's and numbers 
    console.log(await poo.remove('text', 'H♡°■●e👻l💀🙂lo💩💩§'))
})()
```

# Documantion:


| Methods       | Type           | Required      | Output     | Description |
| ------------- |:-------------:|:-------------:|:-------------:| :--------------:|
| image('Path for image', 'image url', log if success) | String, String, Boolean | true, true, false | *None* | Download an image from a url for later use |
| qotd() | None | None | *String* | Give a random question (Question Of The Day) |
| github('User') | String | true | *Object* | Gives info about a user on github |
| encode('input') | String/Number/Boolean | true | *String* | Converts the input into binary |
| decode('input') | String/Number | true | *String* | Convert binary back into text |
| spoil('input') | String/Number | true | *String* | Makes the input a very annoying discord spoiler spam |
| password() | None | None | *Object* | Creates a random password with a recover code |
| remove('type', 'input') | Option, String | true, true | *String* | **emoji** - removes all emojis, **text** - removes everything except letters and numbers |

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