feat: add a function to distinguish a comment

src/controls/comment.ts

@@ -6,6 +6,15 @@ import Comment from "../objects/comment";
 import CommentListing from "../listings/comment";
 import VoteableControls from "./voteable";
 
+/**
+ * The ways to distinguish a comment.
+ *
+ * Note that due to the way Reddit works, a comment cannot be sticky without
+ * also being mod-distinguished. For that reason setting `sticky` will also set
+ * `mod`.
+ */
+export type DistinguishStates = "none" | "mod" | "sticky";
+
 /**
  * Various methods to allow you to interact with comments.
  *
@@ -46,6 +55,22 @@ export default class CommentControls extends VoteableControls {
     return this.fromRaw(raw);
   }
 
+  /**
+   * Distinguish a comment.
+   *
+   * @param id The ID of the comment to distinguish.
+   * @param state How the comment should be distinguished.
+   *
+   * @returns A promise that resolves when the comment has been distinguished.
+   */
+  async distinguish(id: string, state: DistinguishStates): Promise<void> {
+    const how = state === "none" ? "no" : "yes";
+    const sticky = state === "sticky";
+
+    const body = { how, sticky, id: this.name(id) };
+    return this.client.post("api/distinguish", body);
+  }
+
   /** @internal */
   fromRaw(raw: RedditObject): Comment {
     if (raw.kind != this.type) {

src/objects/comment.ts

@@ -1,3 +1,4 @@
+import type { DistinguishStates } from "../controls/comment";
 import type { VoteableData } from "./voteable";
 import CommentControls from "../controls/comment";
 import Listing from "../listings/listing";
@@ -71,4 +72,15 @@ export default class Comment extends Voteable implements CommentData {
   async refetch(): Promise<Comment> {
     return this.controls.fetch(this.id);
   }
+
+  /**
+   * Distinguish this comment.
+   *
+   * @param state How this comment should be distinguished.
+   *
+   * @returns A promise that resolves when this comment has been distinguished.
+   */
+  async distinguish(state: DistinguishStates): Promise<void> {
+    return this.controls.distinguish(this.id, state);
+  }
 }