andresteenveld / rereddit Goto Github PK

Rereddit is a NodeJS wrapper for interfacing with reddit.com's API. It is built around superagent with a few extentions to its Request object for convenience. This extension allows for requests to be made like so:

rereddit.read('funny').limit(25).after('t3_a515a')
    .end(function(err, posts) {
        // Do something with posts.
    });

Rereddit also allows for accessing protected content, returning a user object from a successful call to login that can be stored within a session and passed back to the module when needed.

rereddit.login('username', 'password').end(function(err, user) {
    rereddit.me().as(user)
        .end(function(err, details) {
            // Now we have the user's details. 
        });
});

Install via NPM.

$ npm install rereddit

Then simply require within your application.

var rereddit = require('rereddit');

The read function takes an optional string as an argument, matching either a reddit thing id36, or subreddit name. If no argument is present, rereddit assumes you wish to grab the front page posts of reddit.com.

Login generates the initial post request and attaches the users credentials. Calling end on a login request will return a user object containing the cookie to be set, as well as a data object holding the generated modhash and cookie details like so:

{
    cookie: String,
    data: {
        modhash: String,
        cookie: String
    }
}

A call to me generates an initialized request to grab the user's details. A call to me must be followed by a call to as (documented below) to pass along the required credentials with the request.

Initializes a request to retrieve a list of subreddits from reddit.com.

Initializes a request to fetch the comments for a thread (thread may be the fullname of a reddit thing, or just a things id only).

Initializes a request to post a comment to the specified parent thread with the given text. An alias is provided as reply to allow for flavor. The parent id is expected to be in proper id36 format.

Initializes a request to cast a vote on the specified id in the given direction dir, which is a string (equal to up or down), or integer (1 or -1). The id is expected to be in proper id36 format.

Returns the messages stored in a user's inbox. The user is provided with a chained call to me.

Returns only the unread messages from a user's inbox. The user is provided with a chained call to me.

Returns messages that the user has previously sent. The user is provided with a chained call to me.

Initializes a request to retrieve hidden comments. children may be supplied as an array of strings or comma-delimited strings. The chidlren are expected to be in proper id36 format.

The additional as method attached to the Request prototype simply fits the object with credentials to pass along to the reddit.com API.

Limit, as may be expected, is used for limiting the amount of results returned via a request geneerated by a call to read.

As with limit, after simply tells the request that all results returned from a read request should follow after the specified id. The id is expected to be in proper id36 format.