# gfurjs

> Retrieve gfur easily from a subreddit

Latest version **1.3.0** (published 2020-06-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install gfurjs
pnpm add gfurjs
yarn add gfurjs
bun add gfurjs
```

## 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.3.0 |
| Published | 2020-06-22 |
| First published | 2020-05-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | rawpsy |
| Maintainers | rawpsy |
| Keywords | gfur |

## Links

- npm: https://www.npmjs.com/package/gfurjs
- npm.io page: https://npm.io/package/gfurjs

## Recent versions

- 1.3.0 (latest) — 2020-06-22
- 1.2.0 — 2020-06-21
- 1.1.0 — 2020-05-30
- 1.0.0 — 2020-05-30

## README

# gfurjs
Retrieve gfur easily from a subreddit

# Version 1.3.0 Release (06/22/2020)
- Fixed http request errors for smoother & quicker output
- Added request package notice
- General bugfix

## Installation
```bash
npm i gfurjs
```

## Request package required
```bash
npm i request
```

## Usage
To get the full JSON output:
```js
const { gfur } = require('gfurjs');

gfur(function(err, data) {
  if (err) return console.error(err);
  console.log(data);
});
```

To filter subreddits:
```js
const { gfur } = require('gfurjs');
 
gfur('crappydesign', function(err, data) {
  if (err) return console.error(err);
  console.log(data);
});
```

Async requests:
```js
const { gfurAsync } = require('gfurjs');

gfurAsync() // Use gfurAsync('subredditname') to filter subreddits
.then(m => {
  // Do stuff with the JSON
  console.log(m);
})
.catch(e => {
  // Handle the error
  console.log(e);
})
```

TypeScript support:
```ts
import { gfurAsync } from 'gfurjs';

gfurAsync() // Use gfurAsync('subredditname') to filter subreddits
.then(m => {  
  // Do stuff with the JSON
  console.log(m);
})
.catch(e => {
  // Handle the error
  console.log(e);
});
```

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