Skip to content

A minimal and complete JavaScript driver for the Reddit API.

License

Notifications You must be signed in to change notification settings

sargentdog/snoocore

Repository files navigation

Snoocore

Build Status npm version

A minimal and complete JavaScript driver for the Reddit API.

Features

All endpoints are supported

Calls are generated from the Reddit API documentation. Undocumented endpoints are supported as well.

No special syntax or fluff

All calls follow the reddit API directly. To use the endpoint GET /api/v1/me, call:

var promise = reddit('/api/v1/me').get();

See the basic usage section of the documentation for more information on how to call endpoints with parameters and url parameters.

Snoocore uses promises!

Node.js and Browser support

npm install snoocore || bower install snoocore

The same syntax can be used in node and in browser based JavaScript. There are a few limitations & restrictions for browser based environments covered in the documentation.

Login Helpers

Both OAuth and Cookie based logins are supported.

Throttling

Rate limiting is built into snoocore but can be adjusted or removed all together in the configuration settings.

Have questions?

Contributing

Documentation fixes and additions are always helpful should there be a mistake or something is unclear. Switch to the gh-pages branch and make any changes needed there.

Found out a nifty way to do something that everyone should know? Feel free to add it to the examples repository.

Changes or new features? That's great too! If it's a major change or a new feature open an issue that we can discuss else feel free to just make a pull request for minor changes. Keep in mind that the goal is to keep the interface as close to the Reddit API as possible.

About

A minimal and complete JavaScript driver for the Reddit API.

Resources

License

Stars

Watchers

Forks

Packages

No packages published