npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@gramsay7/reddit-wrapper

v1.0.1

Published

A simple and lightweight Reddit API client for Node.js.

Downloads

3

Readme

Snoowrap

A simple and lightweight Reddit API client for Node.js.

Installation

npm @gramsay7/reddit-wrapper

Usage

First, import the Snoowrap class, UserConfig, and TopTimes enum from the package:

import Snoowrap, { UserConfig, TopTimes } from '@gramsay7/reddit-wrapper';

Then, create a new instance of Snoowrap with your Reddit app's client ID, client secret, and your Reddit account's username and password:

In this package there is a .env.sample file with credentials you can use to test the library.

const snooConfig: UserConfig = {
  clientId: 'your_client_id',
  clientSecret: 'your_client_secret',
  username: 'your_username',
  password: 'your_password',
};

const snoo = new Snoowrap(snooConfig);

Before you can use the other methods, you need to authorize the user:

await snoo.authorize();

Now, you can use the other methods. For example, to get the hot posts from the 'javascript' subreddit:

const hotPosts = await snoo.getHot('javascript');
console.log(hotPosts);

API

authorize(): Promise<void>

Authorizes the user.

getUserInfo()

Gets the authenticated user's information.

getSubredditInfo(name: string): Promise<void>

Gets information about a subreddit.

getHot(subreddit: string)

Gets the hot posts from a subreddit.

getBest(subreddit: string)

Gets the best posts from a subreddit.

getNew(subreddit: string)

Gets the newest posts from a subreddit.

getTop(subreddit: string, t: TopTimes)

Gets the top posts from a subreddit within a specified time frame (t).

search(subreddit: string, query: string)

Searches for a specific query within a specified subreddit.