# bee-api

> reddit api

Latest version **1.0.9** (published 2021-08-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install bee-api
pnpm add bee-api
yarn add bee-api
bun add bee-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.9 |
| Published | 2021-08-23 |
| First published | 2021-02-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | DaatUserName |
| Maintainers | nemijah |
| Keywords | reddit, api |

## Links

- npm: https://www.npmjs.com/package/bee-api
- Repository: https://github.com/discord-brewery/Hive-API
- Homepage: https://github.com/discord-brewery/Hive-API#readme
- Issues: https://github.com/discord-brewery/Hive-API/issues
- npm.io page: https://npm.io/package/bee-api

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1

## Recent versions

- 1.0.9 (latest) — 2021-08-23
- 1.0.8 — 2021-02-13
- 1.0.7 — 2021-02-13
- 1.0.6 — 2021-02-13
- 1.0.5 — 2021-02-13
- 1.0.4 — 2021-02-13
- 1.0.3 — 2021-02-13
- 1.0.2 — 2021-02-13
- 1.0.1 — 2021-02-12
- 1.0.0 — 2021-02-12

## README

![alt text](https://i.imgur.com/Gm0ldDm.png)
# Bee API
## A minimalistic Api to fetch information from reddit



**Table of Contents**

1. [ ChangeLog. ](#ch)
2. [ Description. ](#dec)
3. [ Usage. ](#ue)
4. [ Options. ](#ops)
5. [ Details. ](#dt)
6. [ Contact information. ](#ci)



<a name="ChangeLog"></a>
## 1. ChangeLog
<ul>
<li>You can new sort for new posts</li>
</ul>

<a name="Description"></a>
## 2. Description
A simple and fast wrapper for fetching data from reddit posts.


<a name="Usage "></a>
## 3. Usage

```javascript
const api = require('bee-api');

api({
    subreddit: 'cat',
    allowNSFW: false,
    allowModPost: true,
    allowCrossPost: true,
    allowVideo: true,
    newPosts: true
}).then(post => {
    console.log(post);
});
```


<a name="Options"></a>
## 4. Options

Field | Type | Description | Default
| :--- | ---: | :---:  | :---: 
subreddit  | String  | .... | N/A
allowNSFW  | boolean | whether or not the returned post can be marked as NSFW | false
allowModPost  | boolean | whether or not the returned post can be distinguished as a mod post | false
allowCrossPost  | boolean | whether or not the returned post can be a crosspost | false
allowVideo  | boolean | whether or not the returned post can be a video | false
newPosts  | boolean | whether or not the returned post is a new post | false

<a name="Details"></a>
## 5. Details
<ul>
<li>By default, the Reddit JSON API should not return any removed or deleted posts.</li>
<li>Unhandled rejections can be caught and handled:</li>
</ul>

```javascript
bla bla bla bla bla
}).then(post => {
    // some code here
}).catch(e => {
    console.error(`Rejection: ${e}`);
});
```

<a name="Contact information"></a>
## 6. Contact information

<ul>
<li>Discord: Nemijah#6392</li>
<li>Email: hopetobylol@gmailcom</li>
<li>Github: DaatUserName</li>
<li>Discord server: https://discord.gg/3MAuPMjh7f</li>
<li>feel free to ping me</li>
</ul>


**Future updates**
<ul>
<li>imgur api</li>
</ul>

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