Optional
approvedWhether or not this item was approved.
The unix timestamp of when this was approved.
This can be undefined if the item either hasn't been approved or you don't have permission to know (i.e. you're not a mod on that subreddit).
The username of the mod who approved this post.
This can be undefined if the item either hasn't been approved or you don't have permission to know (i.e. you're not a mod on that subreddit).
Whether or not this post is archived.
The username of the user who created this item.
Whether or not the author has a Patreon flair.
Whether or not the author has Reddit Premium.
Optional
banThe note of why this item was banned (removed).
The unix timestamp of when this item was banned (removed).
This can be undefined if the item either hasn't been banned or you don't have permission to know (i.e. you're not a mod on that subreddit).
The username of the mod who banned (removed) this item.
This can be undefined if the item either hasn't been banned or you don't have permission to know (i.e. you're not a mod on that subreddit).
The text body of the post.
The Reddit API calls this parameter selftext
.
The HTML body of the post, or undefined
if the body is empty.
The Reddit API calls this parameter selftextHtml
.
Whether or not this you can guild this item.
Whether or not you can moderate this item.
A Listing of comments on this post.
Whether or not this post is in contest mode.
The unix timestamp when this object was created.
Optional
dismissedThe old reports on this item.
Whether or not this item was distinguished, and by whom.
The domain of the link for this post.
The unix timestamp when this item was edited, or false
if it wasn't.
How many times this item has been gilded.
The gildings that this item has received.
Whether or not this post is hidden.
Whether or not the score of this post is hidden.
The ID of this object.
Whether or not future reports of this item will be ignored.
Whether or not you are allowed to crosspost this post.
Whether or not this is a meta post.
Whether or not this post is marked as OC.
Whether the domain is reddit-controlled (true) or 3rd party (false).
Whether or not robots are allowed to index this post.
Whether or not this is a self (text) post.
Whether or not this is a video post.
Whether and how you voted on this item.
Value | Meaning |
---|---|
true |
You upvoted this item. |
false |
You downvoted this item. |
undefined |
You have not voted on this item. |
The ID of the link flair template, or undefined
if there is no flair.
Whether or not this item is locked.
A note about why this item was removed that only the moderators can see, or undefined if no note was added or this item hasn't been removed.
The username of the mod who added a removal reason to this item, or undefined if no reason was given or this item hasn't been removed.
The reason this item was removed, or undefined if no reason was given or this item hasn't been removed.
The current reports on this item that were made by mods.
Each entry is of the form [report, username]
.
Optional
modThe old reports on this item that were made by mods.
Each entry is of the form [report, username]
.
The number of comments on this post.
The number of times this has been crossposted.
The number of reports this item has.
This seems to be calculated as follows:
max(
modReports.length - modReportsDismissed.length,
userReports.length - userReportsDismissed.length
)
This means that it will be negative if there were reports that have been dismissed.
Whether or not this post is marked as 18+/nsfw.
The permalink to this item, relative to reddit.com.
Whether or not this post has been pinned.
Whether or not this item has been removed.
Whether or not you have saved this item.
The score that this item has received.
Whether or not replies to this item will notify the author.
Optional
spamWhether or not this item has been marked as spam.
Whether or not this post was marked as being a spoiler.
Whether or not this item has been sticked.
The name of the subreddit this item was posted in.
The number of subscribers the subreddit this was posted to has.
The type of the subreddit this item was posted in.
The suggested way to sort the comments of this post, or undefined if no such suggestion has been given.
The title of this post.
The ratio of upvotes to downvotes on this post.
This will be in the range [0, 1], where 1 is 100% upvoted.
The URL of this post.
If this is a link post url
will be that link. Otherwise it will be the
fully-qualified URL of this post.
The current reports on this item that were made by users.
Each entry is of the form [report, count]
.
Optional
userThe old reports on this item that were made by users.
Each entry is of the form [report, count]
.
Crosspost this post.
The name of the subreddit to crosspost to.
The title of the crosspost.
Any extra options.
A promise that resolves to the ID of the newly created post.
Remove this item, optionally marking it as spam.
Whether or not to mark this item as spam. Defaults to false.
A promise that resolves when this item has been removed.
This requires the authenticated user to be a moderator of the
subreddit with the posts
permission.
Report this item to the mods.
The report will be anonymous if you are not a mod of the subreddit. If you are a mod the report will be tied to your username.
Optional
reason: stringThe reason you are reporting this item.
A promise that resolves when this item has been reported.
Set the suggested sort for this post.
The new suggested sort. If this is undefined
the sort will be
cleared.
A promise that resolves when this post's suggested sort has been updated.
Generated using TypeDoc
A single post.