feat: add SubredditControls::getPopular()

ekrzeptowski · May 2, 2022 · cc91c08 · cc91c08
1 parent 49be5ca
commit cc91c08
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/src/reddit/subreddit/controls.ts b/src/reddit/subreddit/controls.ts
@@ -507,6 +507,18 @@ export class SubredditControls extends BaseControls {
     return this.getSubreddits("new");
   }
 
+  /**
+   * Get the most popular subreddits.
+   *
+   * @note Due to the way Reddit implements Listings, this will only contain the
+   * first 1000 subreddits.
+   *
+   * @returns A Listing of Subreddits.
+   */
+  getPopular(): Listing<Subreddit> {
+    return this.getSubreddits("popular");
+  }
+
   /** @internal */
   protected getAboutListing(
     subreddit: string,