class StarterPack

A Bluesky starter pack.

Constructor

constructor(data, bot)

Parameters

data: StarterPackData

Starter pack data.

bot: Bot

The active Bot instance.

Properties

name: string

The starter pack's name.

uri: string

The starter pack's AT URI.

cid: string

The starter pack's CID.

description?: string

The starter pack's description.

descriptionFacets?: "@atcute/client/lexicons".AppBskyRichtextFacet.Main[]

Any facets associated with the starter pack's description.

creator: Profile

The starter pack's creator.

userList?: List

The user list associated with the starter pack.

feeds?: FeedGenerator[]

Feeds associated with the starter pack.

joinedWeekCount?: number

The number of users who joined using the starter pack in the past week.

joinedAllTimeCount?: number

The number of users who joined using the starter pack in all time.

indexedAt: Date

When the starter pack was indexed by the AppView.

labels?: ComAtprotoLabelDefs.Label[]

Any labels on the starter pack record.

Methods

fetchList(options?)

Fetches the user list associated with the starter pack.

Parameters

options: StarterPackFetchListOptions = {}

The fetch options.

Returns

Promise<List>

The user list.

fetchFeeds(options?)

Fetches the feeds associated with the starter pack.

Parameters

options: StarterPackFetchFeedsOptions = {}

The fetch options.

Returns

Promise<FeedGenerator[]>

The feeds.

fromView(view, bot)

Constructs an instance from a StarterPackView.

Parameters

view: "@atcute/client/lexicons".AppBskyGraphDefs.StarterPackView | "@atcute/client/lexicons".AppBskyGraphDefs.StarterPackViewBasic

The StarterPackView to construct from.

bot: Bot

The active Bot instance.

Returns

StarterPack