Skip to content

Commit

Permalink
fix: documentation of subreddit flair
Browse files Browse the repository at this point in the history
  • Loading branch information
ekrzeptowski committed Mar 9, 2024
1 parent d307909 commit 5255fec
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/reddit/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export type {
export { SubredditControls } from "./subreddit/controls";
export type { SubredditData } from "./subreddit/object";
export { Subreddit } from "./subreddit/object";
export type { SubredditType } from "./subreddit/types";
export type { SubredditFlair, SubredditType } from "./subreddit/types";
export type { SearchSort, SearchSyntax, Size, TimeRange } from "./types";
export { BaseUserControls } from "./user/base/controls";
export type { UserData } from "./user/base/object";
Expand Down
12 changes: 12 additions & 0 deletions src/reddit/subreddit/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,29 @@ export type FileDetails = {

/** The type of subreddit flair. */
export interface SubredditFlair {
/** The flair text. */
text: string;
/** CSS class for the flair. */
cssClass: string;
/** The flair ID. */
id: string;
/** If the flair is editable. */
textEditable: boolean;
/** The flair type. */
type: "text" | "richtext";
/** Specifies allowed content for the flair. */
allowableContent: string;
/** The flair text color. */
textColor: "dark" | "light";
/** If the flair is mod only. */
modOnly: boolean;
/** Richtext flair. */
richtext?: {
/** The flair type. */
e: "text";
/** The flair text. */
t: string;
}[];
/** The flair background color. */
backgroundColor: string;
}
2 changes: 0 additions & 2 deletions typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,11 @@
"Method",
"Module",
"Namespace",
"ObjectLiteral",
"Parameter",
"Property",
"Reference",
"SetSignature",
"TypeAlias",
"TypeLiteral",
"TypeParameter",
"Variable"
],
Expand Down

0 comments on commit 5255fec

Please sign in to comment.