Skip to content

v15 docs audit #240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vdikransamarjian merged 1 commit into from
Oct 20, 2026
Merged

v15 docs audit #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions docs/api/redditapi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
**@devvit/reddit v0.15.0-dev**
**@devvit/reddit v0.15.0**

***

# @devvit/reddit v0.15.0-dev
# @devvit/reddit v0.15.0

## Modules

Expand Down
2 changes: 1 addition & 1 deletion docs/api/redditapi/RedditClient/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[**@devvit/reddit v0.15.0-dev**](../README.md)
[**@devvit/reddit v0.15.0**](../README.md)

***

Expand Down
40 changes: 20 additions & 20 deletions docs/api/redditapi/RedditClient/classes/RedditClient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[**@devvit/reddit v0.15.0-dev**](../../README.md)
[**@devvit/reddit v0.15.0**](../../README.md)

***

Expand Down Expand Up @@ -288,7 +288,7 @@ Approve a post or comment.

The id of the post (t3_) or comment (t1_) to approve.

`` `t1_${string}` `` | `` `t3_${string}` ``
`` `t3_${string}` `` | `` `t1_${string}` ``

#### Returns

Expand Down Expand Up @@ -692,7 +692,7 @@ reason is also shown on the content.

The id of the post (t3_) or comment (t1_) to filter.

`` `t1_${string}` `` | `` `t3_${string}` ``
`` `t3_${string}` `` | `` `t1_${string}` ``

##### options?

Expand Down Expand Up @@ -905,7 +905,7 @@ const comments = await reddit.getComments({

### getCommentsAndPostsByUser()

> **getCommentsAndPostsByUser**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
> **getCommentsAndPostsByUser**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>

Get a list of posts and comments from a specific user.

Expand All @@ -919,7 +919,7 @@ Options for the request

#### Returns

[`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
[`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>

A Listing of `Post` and `Comment` objects.

Expand Down Expand Up @@ -1144,7 +1144,7 @@ console.log("Posts: ", await listing.all())

#### Call Signature

> **getEdited**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
> **getEdited**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>

Return a listing of things that have been edited recently.

Expand All @@ -1156,7 +1156,7 @@ Return a listing of things that have been edited recently.

##### Returns

[`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
[`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>

##### Example

Expand Down Expand Up @@ -1377,7 +1377,7 @@ console.log("Posts: ", await listing.all())

#### Call Signature

> **getModQueue**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
> **getModQueue**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>

Return a listing of things requiring moderator review, such as reported things and items.

Expand All @@ -1389,7 +1389,7 @@ Return a listing of things requiring moderator review, such as reported things a

##### Returns

[`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
[`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>

##### Example

Expand Down Expand Up @@ -1633,7 +1633,7 @@ console.log("Posts: ", await listing.all())

#### Call Signature

> **getReports**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
> **getReports**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>

Return a listing of things that have been reported.

Expand All @@ -1645,7 +1645,7 @@ Return a listing of things that have been reported.

##### Returns

[`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
[`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>

##### Example

Expand Down Expand Up @@ -1800,7 +1800,7 @@ console.log("Posts: ", await listing.all())

#### Call Signature

> **getSpam**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
> **getSpam**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>

Return a listing of things that have been marked as spam or otherwise removed.

Expand All @@ -1812,7 +1812,7 @@ Return a listing of things that have been marked as spam or otherwise removed.

##### Returns

[`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
[`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>

##### Example

Expand Down Expand Up @@ -1850,7 +1850,7 @@ A Promise that resolves a Subreddit object.

#### Deprecated

Use [getSubredditInfoById](../../models/functions/getSubredditInfoById.md) instead.
Use [getSubredditInfoById](#getsubredditinfobyid) instead.

#### Example

Expand Down Expand Up @@ -1884,7 +1884,7 @@ A Promise that resolves a Subreddit object.

#### Deprecated

Use [getSubredditInfoByName](../../models/functions/getSubredditInfoByName.md) instead.
Use [getSubredditInfoByName](#getsubredditinfobyname) instead.

#### Example

Expand Down Expand Up @@ -2151,7 +2151,7 @@ console.log("Posts: ", await listing.all())

#### Call Signature

> **getUnmoderated**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
> **getUnmoderated**(`options`): [`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>

Return a listing of things that have yet to be approved/removed by a mod.

Expand All @@ -2163,7 +2163,7 @@ Return a listing of things that have yet to be approved/removed by a mod.

##### Returns

[`Listing`](../../models/classes/Listing.md)\<[`Comment`](../../models/classes/Comment.md) \| [`Post`](../../models/classes/Post.md)\>
[`Listing`](../../models/classes/Listing.md)\<[`Post`](../../models/classes/Post.md) \| [`Comment`](../../models/classes/Comment.md)\>

##### Example

Expand Down Expand Up @@ -2658,7 +2658,7 @@ Remove a post or comment.

The id of the post (t3_) or comment (t1_) to remove.

`` `t1_${string}` `` | `` `t3_${string}` ``
`` `t3_${string}` `` | `` `t1_${string}` ``

##### isSpam

Expand Down Expand Up @@ -2931,7 +2931,7 @@ The report is sent to the moderators of the subreddit for review.

Post or Comment

[`Comment`](../../models/classes/Comment.md) | [`Post`](../../models/classes/Post.md)
[`Post`](../../models/classes/Post.md) | [`Comment`](../../models/classes/Comment.md)

##### options

Expand Down Expand Up @@ -3368,7 +3368,7 @@ const post = await reddit.submitCustomPost({
title: 'My Devvit Post',
runAs: 'USER',
userGeneratedContent: {
text: "hello there",
text: "hello there",
imageUrls: ["https://styles.redditmedia.com/t5_5wa5ww/styles/communityIcon_wyopomb2xb0a1.png", "https://styles.redditmedia.com/t5_49fkib/styles/bannerBackgroundImage_5a4axis7cku61.png"]
},
subredditName: context.subredditName,
Expand Down
2 changes: 1 addition & 1 deletion docs/api/redditapi/RedditClient/type-aliases/CustomPostStyles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[**@devvit/reddit v0.15.0-dev**](../../README.md)
[**@devvit/reddit v0.15.0**](../../README.md)

***

Expand Down
2 changes: 1 addition & 1 deletion docs/api/redditapi/RedditClient/type-aliases/InviteModeratorOptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[**@devvit/reddit v0.15.0-dev**](../../README.md)
[**@devvit/reddit v0.15.0**](../../README.md)

***

Expand Down
2 changes: 1 addition & 1 deletion docs/api/redditapi/RedditClient/type-aliases/MuteUserOptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[**@devvit/reddit v0.15.0-dev**](../../README.md)
[**@devvit/reddit v0.15.0**](../../README.md)

***

Expand Down
2 changes: 1 addition & 1 deletion docs/api/redditapi/models/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[**@devvit/reddit v0.15.0-dev**](../README.md)
[**@devvit/reddit v0.15.0**](../README.md)

***

Expand Down
2 changes: 1 addition & 1 deletion docs/api/redditapi/models/classes/AuthorFlairSettings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[**@devvit/reddit v0.15.0-dev**](../../README.md)
[**@devvit/reddit v0.15.0**](../../README.md)

@ben-harris-5 ben-harris-5 Oct 20, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔕 I think this will immediately be overwritten the next time there's a release. There's no harm in doing this, and I hope I'm wrong, but just calling it out in case this happens again in a week.

@vdikransamarjian vdikransamarjian Oct 20, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:( @ben-harris-5 can we not let it get overwritten?


***

Expand Down
6 changes: 3 additions & 3 deletions docs/api/redditapi/models/classes/ButtonWidget.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[**@devvit/reddit v0.15.0-dev**](../../README.md)
[**@devvit/reddit v0.15.0**](../../README.md)

***

Expand Down Expand Up @@ -152,11 +152,11 @@

### toJSON()

> **toJSON**(): `Pick`\<[`Widget`](Widget.md), `"name"` \| `"id"` \| `"subredditName"`\> & `Pick`\<`ButtonWidget`, `"description"` \| `"styles"` \| `"buttons"`\>
> **toJSON**(): `Pick`\<[`Widget`](Widget.md), `"subredditName"` \| `"id"` \| `"name"`\> & `Pick`\<`ButtonWidget`, `"description"` \| `"styles"` \| `"buttons"`\>

#### Returns

`Pick`\<[`Widget`](Widget.md), `"name"` \| `"id"` \| `"subredditName"`\> & `Pick`\<`ButtonWidget`, `"description"` \| `"styles"` \| `"buttons"`\>
`Pick`\<[`Widget`](Widget.md), `"subredditName"` \| `"id"` \| `"name"`\> & `Pick`\<`ButtonWidget`, `"description"` \| `"styles"` \| `"buttons"`\>

#### Overrides

Expand Down
6 changes: 3 additions & 3 deletions docs/api/redditapi/models/classes/CalendarWidget.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[**@devvit/reddit v0.15.0-dev**](../../README.md)
[**@devvit/reddit v0.15.0**](../../README.md)

***

Expand Down Expand Up @@ -152,11 +152,11 @@

### toJSON()

> **toJSON**(): `Pick`\<[`Widget`](Widget.md), `"name"` \| `"id"` \| `"subredditName"`\> & `Pick`\<`CalendarWidget`, `"styles"` \| `"googleCalendarId"` \| `"configuration"`\>
> **toJSON**(): `Pick`\<[`Widget`](Widget.md), `"subredditName"` \| `"id"` \| `"name"`\> & `Pick`\<`CalendarWidget`, `"googleCalendarId"` \| `"configuration"` \| `"styles"`\>

#### Returns

`Pick`\<[`Widget`](Widget.md), `"name"` \| `"id"` \| `"subredditName"`\> & `Pick`\<`CalendarWidget`, `"styles"` \| `"googleCalendarId"` \| `"configuration"`\>
`Pick`\<[`Widget`](Widget.md), `"subredditName"` \| `"id"` \| `"name"`\> & `Pick`\<`CalendarWidget`, `"googleCalendarId"` \| `"configuration"` \| `"styles"`\>

#### Overrides

Expand Down
40 changes: 26 additions & 14 deletions docs/api/redditapi/models/classes/Comment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
[**@devvit/reddit v0.15.0-dev**](../../README.md)
[**@devvit/reddit v0.15.0**](../../README.md)

***

# Class: Comment

## Constructors

<a id="constructor"></a>

### new Comment()

> **new Comment**(): `Comment`

#### Returns

`Comment`

## Accessors

<a id="approved"></a>
Expand Down Expand Up @@ -301,7 +313,7 @@ The number of reports, or `0` when none are available.

#### Get Signature

> **get** **parentId**(): `` `t1_${string}` `` \| `` `t3_${string}` ``
> **get** **parentId**(): `` `t3_${string}` `` \| `` `t1_${string}` ``

The identifier of the comment's parent.

Expand All @@ -310,7 +322,7 @@ parent comment's `T1`.

##### Returns

`` `t1_${string}` `` \| `` `t3_${string}` ``
`` `t3_${string}` `` \| `` `t1_${string}` ``

***

Expand Down Expand Up @@ -563,15 +575,15 @@ The `runAs` option is ignored when editing a comment.

### distinguish()

> **distinguish**(`makeSticky`): `Promise`\<`void`\>
> **distinguish**(`makeSticky`?): `Promise`\<`void`\>

Distinguishes the comment as a moderator and updates this instance.

#### Parameters

##### makeSticky
##### makeSticky?

`boolean` = `false`
`boolean`

Whether to pin the comment to the top of its thread.

Expand All @@ -585,15 +597,15 @@ Whether to pin the comment to the top of its thread.

### distinguishAsAdmin()

> **distinguishAsAdmin**(`makeSticky`): `Promise`\<`void`\>
> **distinguishAsAdmin**(`makeSticky`?): `Promise`\<`void`\>

Distinguishes the comment as an employee and updates this instance.

#### Parameters

##### makeSticky
##### makeSticky?

`boolean` = `false`
`boolean`

Whether to pin the comment to the top of its thread.

Expand Down Expand Up @@ -809,15 +821,15 @@ Disables new replies and updates this instance's locked state.

### remove()

> **remove**(`isSpam`): `Promise`\<`void`\>
> **remove**(`isSpam`?): `Promise`\<`void`\>

Removes the comment and updates this instance's moderation state.

#### Parameters

##### isSpam
##### isSpam?

`boolean` = `false`
`boolean`

Whether to classify the removed comment as spam.

Expand Down Expand Up @@ -889,13 +901,13 @@ The report reason to snooze.

### toJSON()

> **toJSON**(): `Pick`\<`Comment`, `"id"` \| `"subredditName"` \| `"postId"` \| `"body"` \| `"permalink"` \| `"createdAt"` \| `"url"` \| `"authorName"` \| `"subredditId"` \| `"score"` \| `"approved"` \| `"spam"` \| `"stickied"` \| `"removed"` \| `"edited"` \| `"locked"` \| `"ignoringReports"` \| `"distinguishedBy"` \| `"authorFlair"` \| `"userReportReasons"` \| `"modReports"` \| `"modReportReasons"` \| `"parentId"` \| `"replies"` \| `"numReports"` \| `"collapsedBecauseCrowdControl"`\>
> **toJSON**(): `Pick`\<`Comment`, `"subredditName"` \| `"id"` \| `"authorName"` \| `"subredditId"` \| `"body"` \| `"createdAt"` \| `"parentId"` \| `"postId"` \| `"replies"` \| `"approved"` \| `"locked"` \| `"removed"` \| `"stickied"` \| `"spam"` \| `"edited"` \| `"distinguishedBy"` \| `"numReports"` \| `"collapsedBecauseCrowdControl"` \| `"score"` \| `"permalink"` \| `"userReportReasons"` \| `"modReports"` \| `"modReportReasons"` \| `"url"` \| `"ignoringReports"` \| `"authorFlair"`\>

Returns the public fields included when the comment is serialized.

#### Returns

`Pick`\<`Comment`, `"id"` \| `"subredditName"` \| `"postId"` \| `"body"` \| `"permalink"` \| `"createdAt"` \| `"url"` \| `"authorName"` \| `"subredditId"` \| `"score"` \| `"approved"` \| `"spam"` \| `"stickied"` \| `"removed"` \| `"edited"` \| `"locked"` \| `"ignoringReports"` \| `"distinguishedBy"` \| `"authorFlair"` \| `"userReportReasons"` \| `"modReports"` \| `"modReportReasons"` \| `"parentId"` \| `"replies"` \| `"numReports"` \| `"collapsedBecauseCrowdControl"`\>
`Pick`\<`Comment`, `"subredditName"` \| `"id"` \| `"authorName"` \| `"subredditId"` \| `"body"` \| `"createdAt"` \| `"parentId"` \| `"postId"` \| `"replies"` \| `"approved"` \| `"locked"` \| `"removed"` \| `"stickied"` \| `"spam"` \| `"edited"` \| `"distinguishedBy"` \| `"numReports"` \| `"collapsedBecauseCrowdControl"` \| `"score"` \| `"permalink"` \| `"userReportReasons"` \| `"modReports"` \| `"modReportReasons"` \| `"url"` \| `"ignoringReports"` \| `"authorFlair"`\>

***

Expand Down
6 changes: 3 additions & 3 deletions docs/api/redditapi/models/classes/CommunityListWidget.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[**@devvit/reddit v0.15.0-dev**](../../README.md)
[**@devvit/reddit v0.15.0**](../../README.md)

***

Expand Down Expand Up @@ -138,11 +138,11 @@

### toJSON()

> **toJSON**(): `Pick`\<[`Widget`](Widget.md), `"name"` \| `"id"` \| `"subredditName"`\> & `Pick`\<`CommunityListWidget`, `"styles"` \| `"communities"`\>
> **toJSON**(): `Pick`\<[`Widget`](Widget.md), `"subredditName"` \| `"id"` \| `"name"`\> & `Pick`\<`CommunityListWidget`, `"styles"` \| `"communities"`\>

#### Returns

`Pick`\<[`Widget`](Widget.md), `"name"` \| `"id"` \| `"subredditName"`\> & `Pick`\<`CommunityListWidget`, `"styles"` \| `"communities"`\>
`Pick`\<[`Widget`](Widget.md), `"subredditName"` \| `"id"` \| `"name"`\> & `Pick`\<`CommunityListWidget`, `"styles"` \| `"communities"`\>

#### Overrides

Expand Down
Loading
Loading