https://github.com/simple-works/0reddit
Some simple reddit API functions on top of snoowrap.
https://github.com/simple-works/0reddit
javascript nodejs reddit reddit-api reddit-bot snoowrap
Last synced: about 2 months ago
JSON representation
Some simple reddit API functions on top of snoowrap.
- Host: GitHub
- URL: https://github.com/simple-works/0reddit
- Owner: simple-works
- License: mit
- Created: 2022-03-07T04:55:10.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-08T03:33:51.000Z (over 4 years ago)
- Last Synced: 2025-10-20T04:34:05.594Z (8 months ago)
- Topics: javascript, nodejs, reddit, reddit-api, reddit-bot, snoowrap
- Language: JavaScript
- Homepage:
- Size: 1.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🌐 0reddit
[](https://npmjs.org/package/0reddit)
A small extension of [snoowrap](https://github.com/not-an-aardvark/snoowrap) with some simplified reddit API functions.
# 📥 Install
```
npm i 0reddit
```
# 🏁 Use
```js
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](https://not-an-aardvark.github.io/snoowrap/snoowrap.html) 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](https://not-an-aardvark.github.io/snoowrap/Submission.html).
- `await applyFlairs(submission, flairsTexts)` : assign flairs to a submissions.
- `submission: Submission` : Snowrap [submission](https://not-an-aardvark.github.io/snoowrap/Submission.html).
- `flairsTexts: String[]` : Array of flairs texts.
# 📃 License
[MIT](./LICENSE) © [Ambratolm](https://github.com/Ambratolm)