🌐 0reddit

A small extension of snoowrap with some simplified reddit API functions.

📥 Install

npm i 0reddit

🏁 Use

const snoowrap = require("snoowrap");
const $reddit = require("0reddit");

const requester = new snoowrap({
  /* OAuth credentials here */
});
const $subreddit = $reddit(requester, "SomeSubreddit");

// Submit a link
const submission = await $subreddit.submitLink({
  title: "Wracurd",
  url: "https://example.com/wracurd.jpg",
  oc: true,
  flairs: ["artwork", "comic", "color"],
});

// Get own newest submission
const myLatestSubmission = await $subreddit.getNewByMe({ one: true });

📕 API

reddit(requester, subredditName) : Create an object containing the functions.
- requester: snoowrap : Snoowrap requester object.
- subredditName: String : Subreddit name (without r/ prefix).
await submitLink(post) : Submit a link post.
- post: Object : Object describing a link post.
  - title: String : post title.
  - url: String : post link.
  - oc?: Boolean : If true, mark post as OC.
  - flairs?: String[] : Texts of flairs to assign to post.
await getNewByMe(options) : Get own new submissions.
- options?: Object: Options object.
  - one?: Boolean : If true, return the first submission object (Instead of Array).
  - limit?: Number : Maximum number of submissions to retrieve.
await markAsOC(submission) : Mark a submission as OC.
- submission: Submission : Snowrap submission.
await applyFlairs(submission, flairsTexts) : assign flairs to a submissions.
- submission: Submission : Snowrap submission.
- flairsTexts: String[] : Array of flairs texts.