Skip to content

v0.15.0 release #234

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
galactic-magpie merged 8 commits into from
Oct 19, 2026
Merged

v0.15.0 release #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8e83331
v0.15.0 release
galactic-magpie Oct 16, 2026
657dc9f
custom title for expanded mode (#238)
FairlyCaffeinated Oct 19, 2026
9f8a8c9
Update changelog for release 0.15.0
stacy-qqq Oct 19, 2026
bc0618c
Update changelog with deprecations and API changes
stacy-qqq Oct 19, 2026
ae19f04
Update changelog with other improvements
stacy-qqq Oct 19, 2026
54a424f
Release 0.15.0: API Updates and Breaking Changes
stacy-qqq Oct 19, 2026
651b231
Re-gen docs after updating the comments in the monorepo
ben-harris-5 Oct 19, 2026
dc3804f
Merge branch 'main' into docs-release-0.15.0
galactic-magpie Oct 19, 2026
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
  •  
  •  
  •  
5 changes: 4 additions & 1 deletion docs/api/public-api/classes/Comment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -646,7 +646,10 @@ The `runAs` option is ignored when editing a comment.

**`Experimental`**

Filters the comment. When a comment is filtered, it is added to the ModQueue for review. By default, filtered comments are hidden while in the queue. Set `keep` to `true` to keep the comment visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason is also shown on the comment.
Filters the comment. When a comment is filtered, it is added to the ModQueue for review. By
default, filtered comments are hidden while in the queue. Set `keep` to `true` to keep the
comment visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason
is also shown on the comment.

#### Parameters

Expand Down
5 changes: 4 additions & 1 deletion docs/api/public-api/classes/Post.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -890,7 +890,10 @@ edited state from the response.

**`Experimental`**

Filters a post. When a post is filtered, it is added to the ModQueue for review. By default, filtered posts are hidden while in the queue. Set `keep` to `true` to keep the post visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason is also shown on the post.
Filters a post. When a post is filtered, it is added to the ModQueue for
review. By default, filtered posts are hidden while in the queue. Set
`keep` to `true` to keep the post visible. Set `reason` to show moderators
a reason; when `keep` is `true`, the reason is also shown on the post.

#### Parameters

Expand Down
59 changes: 10 additions & 49 deletions docs/api/public-api/classes/RedditAPIClient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -775,7 +775,10 @@ The edited FlairTemplate object.

**`Experimental`**

Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for review. By default, filtered content is hidden while in the queue. Set `keep` to `true` to keep the content visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason is also shown on the content.
Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for
review. By default, filtered content is hidden while in the queue. Set `keep` to `true` to keep
the content visible. Set `reason` to show moderators a reason; when `keep` is `true`, the
reason is also shown on the content.

#### Parameters

Expand Down Expand Up @@ -2760,79 +2763,37 @@ A Listing of SubredditWikiContributorUser objects.

### getWikiPage()

#### Call Signature

> **getWikiPage**(`subredditName`, `page`, `revisionId`): `Promise`\<[`WikiPage`](WikiPage.md)\>

Get a specific revision of a wiki page from a subreddit.

##### Parameters

###### subredditName

`string`

The name of the subreddit to get the wiki page from.

###### page

`string`

The name of the wiki page to get.

###### revisionId

The revision ID of the wiki page version to get. Leaving it empty returns the latest version.

`undefined` | `` `${string}-${string}-${string}-${string}-${string}` ``

##### Returns

`Promise`\<[`WikiPage`](WikiPage.md)\>

The requested WikiPage object.

##### Deprecated

Pass a [GetWikiPageOptions](../type-aliases/GetWikiPageOptions.md) object as the third argument instead.

##### Inherited from

[`RedditClient`](RedditClient.md).[`getWikiPage`](RedditClient.md#getwikipage)

#### Call Signature

> **getWikiPage**(`subredditName`, `page`, `options`?): `Promise`\<[`WikiPage`](WikiPage.md)\>

Get a wiki page from a subreddit.

##### Parameters
#### Parameters

###### subredditName
##### subredditName

`string`

The name of the subreddit to get the wiki page from.

###### page
##### page

`string`

The name of the wiki page to get.

###### options?
##### options?

[`GetWikiPageOptions`](../type-aliases/GetWikiPageOptions.md)

Options for the request.

##### Returns
#### Returns

`Promise`\<[`WikiPage`](WikiPage.md)\>

The requested WikiPage object.

##### Inherited from
#### Inherited from

[`RedditClient`](RedditClient.md).[`getWikiPage`](RedditClient.md#getwikipage)

Expand Down
53 changes: 9 additions & 44 deletions docs/api/public-api/classes/RedditClient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -685,7 +685,10 @@ The edited FlairTemplate object.

**`Experimental`**

Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for review. By default, filtered content is hidden while in the queue. Set `keep` to `true` to keep the content visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason is also shown on the content.
Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for
review. By default, filtered content is hidden while in the queue. Set `keep` to `true` to keep
the content visible. Set `reason` to show moderators a reason; when `keep` is `true`, the
reason is also shown on the content.

#### Parameters

Expand Down Expand Up @@ -2400,69 +2403,31 @@ A Listing of SubredditWikiContributorUser objects.

### getWikiPage()

#### Call Signature

> **getWikiPage**(`subredditName`, `page`, `revisionId`): `Promise`\<[`WikiPage`](WikiPage.md)\>

Get a specific revision of a wiki page from a subreddit.

##### Parameters

###### subredditName

`string`

The name of the subreddit to get the wiki page from.

###### page

`string`

The name of the wiki page to get.

###### revisionId

The revision ID of the wiki page version to get. Leaving it empty returns the latest version.

`undefined` | `` `${string}-${string}-${string}-${string}-${string}` ``

##### Returns

`Promise`\<[`WikiPage`](WikiPage.md)\>

The requested WikiPage object.

##### Deprecated

Pass a [GetWikiPageOptions](../type-aliases/GetWikiPageOptions.md) object as the third argument instead.

#### Call Signature

> **getWikiPage**(`subredditName`, `page`, `options`?): `Promise`\<[`WikiPage`](WikiPage.md)\>

Get a wiki page from a subreddit.

##### Parameters
#### Parameters

###### subredditName
##### subredditName

`string`

The name of the subreddit to get the wiki page from.

###### page
##### page

`string`

The name of the wiki page to get.

###### options?
##### options?

[`GetWikiPageOptions`](../type-aliases/GetWikiPageOptions.md)

Options for the request.

##### Returns
#### Returns

`Promise`\<[`WikiPage`](WikiPage.md)\>

Expand Down
53 changes: 9 additions & 44 deletions docs/api/redditapi/RedditClient/classes/RedditClient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -681,7 +681,10 @@ The edited FlairTemplate object.

**`Experimental`**

Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for review. By default, filtered content is hidden while in the queue. Set `keep` to `true` to keep the content visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason is also shown on the content.
Filters a post or comment. When a post or comment is filtered, it is added to the ModQueue for
review. By default, filtered content is hidden while in the queue. Set `keep` to `true` to keep
the content visible. Set `reason` to show moderators a reason; when `keep` is `true`, the
reason is also shown on the content.

#### Parameters

Expand Down Expand Up @@ -2396,69 +2399,31 @@ A Listing of SubredditWikiContributorUser objects.

### getWikiPage()

#### Call Signature

> **getWikiPage**(`subredditName`, `page`, `revisionId`): `Promise`\<[`WikiPage`](../../models/classes/WikiPage.md)\>

Get a specific revision of a wiki page from a subreddit.

##### Parameters

###### subredditName

`string`

The name of the subreddit to get the wiki page from.

###### page

`string`

The name of the wiki page to get.

###### revisionId

The revision ID of the wiki page version to get. Leaving it empty returns the latest version.

`undefined` | `` `${string}-${string}-${string}-${string}-${string}` ``

##### Returns

`Promise`\<[`WikiPage`](../../models/classes/WikiPage.md)\>

The requested WikiPage object.

##### Deprecated

Pass a [GetWikiPageOptions](../../models/type-aliases/GetWikiPageOptions.md) object as the third argument instead.

#### Call Signature

> **getWikiPage**(`subredditName`, `page`, `options`?): `Promise`\<[`WikiPage`](../../models/classes/WikiPage.md)\>

Get a wiki page from a subreddit.

##### Parameters
#### Parameters

###### subredditName
##### subredditName

`string`

The name of the subreddit to get the wiki page from.

###### page
##### page

`string`

The name of the wiki page to get.

###### options?
##### options?

[`GetWikiPageOptions`](../../models/type-aliases/GetWikiPageOptions.md)

Options for the request.

##### Returns
#### Returns

`Promise`\<[`WikiPage`](../../models/classes/WikiPage.md)\>

Expand Down
5 changes: 4 additions & 1 deletion docs/api/redditapi/models/classes/Comment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -634,7 +634,10 @@ The `runAs` option is ignored when editing a comment.

**`Experimental`**

Filters the comment. When a comment is filtered, it is added to the ModQueue for review. By default, filtered comments are hidden while in the queue. Set `keep` to `true` to keep the comment visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason is also shown on the comment.
Filters the comment. When a comment is filtered, it is added to the ModQueue for review. By
default, filtered comments are hidden while in the queue. Set `keep` to `true` to keep the
comment visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason
is also shown on the comment.

#### Parameters

Expand Down
5 changes: 4 additions & 1 deletion docs/api/redditapi/models/classes/Post.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -878,7 +878,10 @@ edited state from the response.

**`Experimental`**

Filters a post. When a post is filtered, it is added to the ModQueue for review. By default, filtered posts are hidden while in the queue. Set `keep` to `true` to keep the post visible. Set `reason` to show moderators a reason; when `keep` is `true`, the reason is also shown on the post.
Filters a post. When a post is filtered, it is added to the ModQueue for
review. By default, filtered posts are hidden while in the queue. Set
`keep` to `true` to keep the post visible. Set `reason` to show moderators
a reason; when `keep` is `true`, the reason is also shown on the post.

#### Parameters

Expand Down
Loading
Loading