Skip to content

ff2400t/redditdeno

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Simple Reddit API client for Deno

This is a based on this reddit client for nodejs. This is mostly just porting the library to using Fetch api. In addition this provides a few Utilities for making posts with an images.

This should also work seemlessly in other JS runtimes with Fetch support though i haven't tested this myself.

  • Lightweight – no unecessary dependencies, easy-to-audit source code
  • Modern API – uses async/await and promises
  • Powered by the official Reddit API

Usage

First, create a Reddit App.

  • Click "Create app"
  • For simple scripts, you can select a type of "script".
  • You can enter anything in the "about URL" and "redirect URL" fields.
  • Note your app ID (appears below the app name) and your app secret.

Now, let's take an action on Reddit:

const Reddit = require('reddit')

const reddit = new Reddit({
  username: 'TODO',
  password: 'TODO',
  appId: 'TODO',
  appSecret: 'TODO',
  userAgent: 'MyApp/1.0.0 (http://example.com)'
})

// Submit a link to the /r/BitMidi subreddit
const res = await reddit.post('/api/submit', {
  sr: 'WeAreTheMusicMakers',
  kind: 'link',
  resubmit: true,
  title: 'BitMidi – 100K+ Free MIDI files',
  url: 'https://bitmidi.com'
})

console.log(res)

API

reddit = new Reddit(opts)

Create a new Reddit API client.

You must provide opts, an object with the following required properties:

  • username - Username of the reddit user
  • password - Password of the reddit user
  • appId - Reddit App ID
  • appSecret - Reddit App Secret

The following opts properties are optional:

  • opts.userAgent - String to use as the User-Agent header in http requests

reddit.get(url, [data])

Invoke the Reddit API using the GET HTTP method.

The url parameter is used to specify which API to invoke. For example, /api/submit or /api/vote. A complete listing of possible APIs is available in the Reddit API documentation.

The optional data parameter is used to specify relevant data for the selected API. The necessary data varies depending on which API is being used. Again, see the Reddit API documentation.

reddit.post(url, [data])

Invoke the Reddit API using the POST HTTP method.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published