feat: add a way to get the users banned from a subreddit

src/reddit/subreddit/controls.ts

@@ -251,6 +251,20 @@ export class SubredditControls extends BaseControls {
     await this.unfriend(subreddit, username, "banned");
   }
 
+  /**
+   * Get the list of banned users for a subreddit.
+   *
+   * @note Due to the way Reddit implements Listings, this will only contain the
+   * first 1000 banned users.
+   *
+   * @param subreddit The name of the subreddit to get banned users for.
+   *
+   * @returns A listing of banned users.
+   */
+  getBannedUsers(subreddit: string): Listing<User> {
+    return this.getAboutListingUsers(subreddit, "banned");
+  }
+
   /** @internal */
   protected getSortedPosts(
     subreddit: string | undefined,

src/reddit/subreddit/object.ts

@@ -938,4 +938,16 @@ export class Subreddit extends Content implements SubredditData {
   async unbanUser(username: string): Promise<void> {
     return this.controls.unbanUser(this.displayName, username);
   }
+
+  /**
+   * Get the list of banned users for this subreddit.
+   *
+   * @note Due to the way Reddit implements Listings, this will only contain the
+   * first 1000 banned users.
+   *
+   * @returns A listing of banned users.
+   */
+  getBannedUsers(): Listing<User> {
+    return this.controls.getBannedUsers(this.displayName);
+  }
 }