subbey v1.3.2

subbey

subbey is an lightweight and asynchronous Reddit API wrapper to retrieve post easily

Usage

CommonJS

const {subbey} = require('subbey');
subbey({sub: 'dank', max: 1, nfsw: false, top: true});

ECMAScript

import {subbey} from 'subbey';
subbey({sub: 'dank', max: 1, nfsw: false, top: true});

Options

/**
     * @description The subreddit you want to recieve posts from
     * @optional
     * @default memes
     * @type {string}
*/
    sub?: string,

/**
     * @description Wether you want to recieve NFSW results
     * @optional
     * @default false
     * @type {boolean}
*/
    nfsw?: boolean;

/**
     * @description The number of results you want to recieve
     * @optional
     * @default 3
     * @type {number}
*/
    max?: number


/**
     * @description Wether you want the top posts or not
     * @optional
     * @default false
     * @type {boolean}
*/
    top?: boolean