Class FeaturedTagRepository

Hierarchy

FeaturedTagRepository

Implements

Repository<FeaturedTag>

Index

Constructors

Properties

Methods

create list listSuggestions remove

Constructors

constructor

new FeaturedTagRepository(http: Http, config: MastoConfig, logger?: Logger): FeaturedTagRepository
Parameters
- http: Http
- config: MastoConfig
- Optional logger: Logger
Returns FeaturedTagRepository
- Defined in src/mastodon/v1/repositories/featured-tag-repository.ts:15

Properties

`Readonly` config

config: MastoConfig

`Optional` `Readonly` logger

logger?: Logger

Methods

create

create(params: CreateFeaturedTagParams): Promise<FeaturedTag>
Feature a tag

Returns
FeaturedTag

See
https://docs.joinmastodon.org/methods/accounts/featured_tags/
Parameters
- params: CreateFeaturedTagParams
  
  Parameters
Returns Promise<FeaturedTag>
Implementation of Repository.create
- Defined in src/mastodon/v1/repositories/featured-tag-repository.ts:38

list

list(): Paginator<FeaturedTag[], never>
View your featured tags

Returns
Array of FeaturedTag

See
https://docs.joinmastodon.org/methods/accounts/featured_tags/

Done

Returns Paginator<FeaturedTag[], never>
Implementation of Repository.list
- Defined in src/mastodon/v1/repositories/featured-tag-repository.ts:27

listSuggestions

listSuggestions(): Paginator<Tag[], never>
Shows your 10 most-used tags, with usage history for the past week.

Returns
Array of Tag with History

See
https://docs.joinmastodon.org/methods/accounts/featured_tags/

Returns Paginator<Tag[], never>
- Defined in src/mastodon/v1/repositories/featured-tag-repository.ts:48

remove

remove(id: string): Promise<void>
Un-feature a tag

Returns
N/A

See
https://docs.joinmastodon.org/methods/accounts/featured_tags/
Parameters
- id: string
  
  The id of the FeaturedTag to be un-featured
Returns Promise<void>
Implementation of Repository.remove
- Defined in src/mastodon/v1/repositories/featured-tag-repository.ts:59

Generated using TypeDoc