class Post

extends PostReference

Represents a post on Bluesky.

Constructor

constructor(data, bot)

Parameters

data: PostData

Post data.

bot: Bot

The active Bot instance.

Properties

uri: ResourceUri

The post's AT URI.

cid: string

The post's CID.

replyRef?: ReplyRef

A reference to the post's parent and root post.

text: string

The post text.

author: Profile

The post's author.

facets?: Facet[]

A facet represents a range within the post's text that has special meaning (e.g. mentions, links, tags).

langs?: string[]

A list of two-letter language codes that the post is written in.

embed?: PostEmbed

The embed attached to the post, if there is any.

labels?: Label[]

The labels attached to the post, if there are any.

tags?: string[]

Additional non-inline tags attached to the post.

threadgate?: Threadgate

The threadgate attached to the post, if there is any.

embeddingDisabled?: boolean

Whether embedding this post is disallowed by a postgate.

root?: Post

The root post of this post's thread.

parent?: Post

The post's parent.

children?: Post[]

The post's children.

createdAt: Date

The time the post was created.

indexedAt?: Date

The time the post was indexed by the AppView.

likeUri?: ResourceUri

The post's like URI, if the bot has liked the post.

repostUri?: ResourceUri

The post's repost URI, if the bot has reposted the post.

likeCount?: number

The post's like count.

repostCount?: number

The post's repost count.

replyCount?: number

The post's reply count.

quoteCount?: number

The post's quote count.

Methods

reply(payload, options?)

Reply to the post.

Parameters

payload: PostPayload

The post payload.

options: BotPostOptions = {}

Optional configuration.

Returns

Promise<PostReference>

A reference to the created post.

quote(payload, options?)

Create a new post with this post quoted.

Parameters

payload: PostPayload

The post payload.

options: BotPostOptions = {}

Optional configuration.

Returns

Promise<PostReference>

A reference to the created post.

like()

Like the post.

Returns

Promise<StrongRef>

unlike()

Unlike the post.

repost()

Repost the post.

Returns

Promise<StrongRef>

deleteRepost()

If this post has been reposted, delete the repost.

delete()

Delete the post.

label(labels, comment?)

Apply labels to the post.

Parameters

labels: string[]

The labels to apply.

comment?: string

An optional comment.

Returns

Promise<ModEventView>

negateLabels(labels, comment?)

Negate labels previously applied to the post.

Parameters

labels: string[]

The labels to negate.

comment?: string

An optional comment.

Returns

Promise<ModEventView>

fetch(options?)

Refetch the post.

Parameters

options: BotGetPostOptions = {}

Optional configuration.

Returns

Promise<Post>

fetchRoot(options?)

Fetch the root post of the thread.

Parameters

options: PostFetchRootOptions = {}

Optional configuration.

Returns

Promise<Post | null>

fetchParent(options?)

Fetch the parent post.

Parameters

options: PostFetchParentOptions = {}

Optional configuration.

Returns

Promise<Post | null>

fetchChildren(options?)

Fetch the children of the post.

Parameters

options: PostFetchChildrenOptions = {}

Optional configuration.

Returns

Promise<Post[]>

getLikeCount()

Fetch the post's current like count.

Returns

Promise<number | null>

getRepostCount()

Fetch the post's current repost count.

Returns

Promise<number | null>

getReplyCount()

Fetch the post's current reply count.

Returns

Promise<number | null>

getQuoteCount()

Fetch the post's current quote count.

Returns

Promise<number | null>

getLikes(cursor?)

Fetch a list of users who liked this post. This method returns 100 likes at a time, alongside a cursor to fetch the next 100.

Parameters

cursor?: string

The cursor to begin fetching from.

Returns

Promise<{ cursor?: string; likes: Profile[]; }>

iterateLikes(cursor?)

Iterate over the users who liked this post.

Parameters

cursor?: string

The cursor to begin fetching from.

Returns

AsyncIterableIterator<Profile, any, any>

getReposts(cursor?)

Fetch a list of users who reposted this post. This method returns 100 users at a time, alongside a cursor to fetch the next 100.

Parameters

cursor?: string

The cursor to begin fetching from.

Returns

Promise<{ cursor?: string; reposts: Profile[]; }>

iterateReposts(cursor?)

Iterate over the users who reposted this post.

Parameters

cursor?: string

The cursor to begin fetching from.

Returns

AsyncIterableIterator<Profile, any, any>

getQuotes(cursor?)

Fetch a list of posts that quote this post. This method returns 100 quotes at a time, alongside a cursor to fetch the next 100.