{"_id":"0reddit","_rev":"1-b4a0570d10e79b9d82961a8fdbe5168c","name":"0reddit","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"0reddit","version":"0.0.1","description":"A few simplified reddit API functions on top of snoowrap","main":"test.js","scripts":{"start":"nodemon test.js","test":"node test.js"},"repository":{"type":"git","url":"git+https://github.com/simple-works/0reddit.git"},"keywords":["reddit","snoowrap","extension","api"],"author":{"name":"Ambratolm","email":"ambratolm@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/simple-works/0reddit/issues"},"homepage":"https://github.com/simple-works/0reddit#readme","devDependencies":{"snoowrap":"^1.23.0"},"gitHead":"d7363143a91d91c261e739461512e7924198d629","_id":"0reddit@0.0.1","_nodeVersion":"13.14.0","_npmVersion":"6.14.4","dist":{"integrity":"sha512-Fdrmyyejw3bg0XuoB5S4qsSDReHUL6y1WJsjPNftQMOD2COTk8rUgqem/kPFIgLkbEgOpUrGc7BcbjktyUXcyA==","shasum":"c6e90005b02758ff8c0e1537eca98a878b33fb25","tarball":"https://registry.npmjs.org/0reddit/-/0reddit-0.0.1.tgz","fileCount":11,"unpackedSize":2055410,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiJtA2ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmp36g/6A+rzUqLkcODarmdVQfAlcOelVM4gvjqhDRBaNQjxw4POY7GA\r\nzu5FSf0W/3tQHipbngOcJpJUJ+4yN0KBgKERq6Ulj3Ei1w7tvJ/z2li8A07N\r\nNB7+OySd10FsFn7h+F4tP+moQisz2mexFiVA65DIVqhF604CnmOysMV/YE1D\r\nIODruTU6qOPfWRRKIIfRYzm0cFjsFHHLlpBxegZb1Ojio/D8zlHL0i80uvfU\r\nCsnG0Zev0E+7F/hUM2SWN0k6KV7h5tv2yGIDEEooszS4ZTGEvF4OEM8R7VB/\r\nE/NXgOyXcp+UVTeOrvIPmPeZJp0oefamPXIts5r65YTuDX1U4UKHbnXUaK4N\r\nExyPzkwbX1ZL61FWQ2Bb6YfSkruIGAIz/LBx30i6domf70DAZ1Tfmn5b9j5V\r\naNM7ZBMEuXOODcLu6P+d9vAlPVjsv+1WY2C7ixUFfHP7NWXYJZdKt9x+GAje\r\n7/oYJF1WkOfKwL1o19nbw2LfYYhaJrbseQ+PLvq7QOzl3r/xJs1fiohZFFX4\r\nfw42MM7t6lYrMos//E8RJGPKx9CKKJ8ZoTZIn9PfkAuqfQ+yPL4f7ul+IkEl\r\n6nG7PgHKtXc6qTelwQnP3mcW3vzds0DdAEWPESZsCHPVtKLuy2jotmsf5ipL\r\nnBfOVzPRfT39S3h3VrCF2Ut6EF4nUqjmvU8=\r\n=nsWS\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICKyxUbCTD7dGqzSDUY/yaCOduqcLGLD47Abc+CFSt0MAiBmJQqqKxbo7BPf58Lbvve0AC3Qtdv98IIvdhMJaY+3/g=="}]},"_npmUser":{"name":"ambratolm","email":"ambratolm@gmail.com"},"directories":{},"maintainers":[{"name":"ambratolm","email":"ambratolm@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/0reddit_0.0.1_1646710838626_0.7301904069503125"},"_hasShrinkwrap":false}},"time":{"created":"2022-03-08T03:40:38.625Z","0.0.1":"2022-03-08T03:40:38.959Z","modified":"2022-04-04T10:08:46.975Z"},"maintainers":[{"name":"ambratolm","email":"ambratolm@gmail.com"}],"description":"A few simplified reddit API functions on top of snoowrap","homepage":"https://github.com/simple-works/0reddit#readme","keywords":["reddit","snoowrap","extension","api"],"repository":{"type":"git","url":"git+https://github.com/simple-works/0reddit.git"},"author":{"name":"Ambratolm","email":"ambratolm@gmail.com"},"bugs":{"url":"https://github.com/simple-works/0reddit/issues"},"license":"MIT","readme":"# 🌐 0reddit\r\n\r\n[![NPM version](https://badge.fury.io/js/0reddit.svg)](https://npmjs.org/package/0reddit)\r\n\r\nA small extension of [snoowrap](https://github.com/not-an-aardvark/snoowrap) with some simplified reddit API functions.\r\n\r\n![Screenshot](./screenshot.gif?raw=true)\r\n\r\n# 📥 Install\r\n\r\n```\r\nnpm i 0reddit\r\n```\r\n\r\n# 🏁 Use\r\n\r\n```js\r\nconst snoowrap = require(\"snoowrap\");\r\nconst $reddit = require(\"0reddit\");\r\n\r\nconst requester = new snoowrap({\r\n  /* OAuth credentials here */\r\n});\r\nconst $subreddit = $reddit(requester, \"SomeSubreddit\");\r\n\r\n// Submit a link\r\nconst submission = await $subreddit.submitLink({\r\n  title: \"Wracurd\",\r\n  url: \"https://example.com/wracurd.jpg\",\r\n  oc: true,\r\n  flairs: [\"artwork\", \"comic\", \"color\"],\r\n});\r\n\r\n// Get own newest submission\r\nconst myLatestSubmission = await $subreddit.getNewByMe({ one: true });\r\n```\r\n\r\n# 📕 API\r\n\r\n- `reddit(requester, subredditName)` : Create an object containing the functions.\r\n\r\n  - `requester: snoowrap` : Snoowrap [requester](https://not-an-aardvark.github.io/snoowrap/snoowrap.html) object.\r\n  - `subredditName: String` : Subreddit name (without r/ prefix).\r\n\r\n- `await submitLink(post)` : Submit a link post.\r\n\r\n  - `post: Object` : Object describing a link post.\r\n    - `title: String` : post title.\r\n    - `url: String` : post link.\r\n    - `oc?: Boolean` : If true, mark post as OC.\r\n    - `flairs?: String[]` : Texts of flairs to assign to post.\r\n\r\n- `await getNewByMe(options)` : Get own new submissions.\r\n\r\n  - `options?: Object`: Options object.\r\n    - `one?: Boolean` : If true, return the first submission object (Instead of Array).\r\n    - `limit?: Number` : Maximum number of submissions to retrieve.\r\n\r\n- `await markAsOC(submission)` : Mark a submission as OC.\r\n\r\n  - `submission: Submission` : Snowrap [submission](https://not-an-aardvark.github.io/snoowrap/Submission.html).\r\n\r\n- `await applyFlairs(submission, flairsTexts)` : assign flairs to a submissions.\r\n\r\n  - `submission: Submission` : Snowrap [submission](https://not-an-aardvark.github.io/snoowrap/Submission.html).\r\n  - `flairsTexts: String[]` : Array of flairs texts.\r\n\r\n# 📃 License\r\n\r\n[MIT](./LICENSE) © [Ambratolm](https://github.com/Ambratolm)\r\n","readmeFilename":"README.md"}