Interface TrendRepository

interface TrendRepository {
    links: {
        list(params?, meta?): Paginator<TrendLink[], DefaultPaginationParams>;
    };
    statuses: {
        list(params?, meta?): Paginator<Status[], DefaultPaginationParams>;
    };
    tags: {
        list(params?, meta?): Paginator<mastodon.v1.Tag[], ListTrendsParams>;
    };
}

Index

Properties

links statuses tags

Properties

links

links: {
list(params?, meta?): Paginator<TrendLink[], DefaultPaginationParams>;
}

Type declaration

list:function
- list(params?, meta?): Paginator<TrendLink[], DefaultPaginationParams>
- Links that have been shared more than others.
  Parameters
  - Optional params: DefaultPaginationParams
  - Optional meta: HttpMetaParams<"none">
  Returns Paginator<TrendLink[], DefaultPaginationParams>
  See
  https://docs.joinmastodon.org/methods/trends/#links
  - Defined in src/mastodon/rest/v1/trend-repository.ts:29

statuses

statuses: {
list(params?, meta?): Paginator<Status[], DefaultPaginationParams>;
}

Type declaration

list:function
- list(params?, meta?): Paginator<Status[], DefaultPaginationParams>
- View trending statuses
  Parameters
  - Optional params: DefaultPaginationParams
  - Optional meta: HttpMetaParams<"none">
  Returns Paginator<Status[], DefaultPaginationParams>
  Array of Status
  
  See
  https://docs.joinmastodon.org/methods/trends/#statuses
  - Defined in src/mastodon/rest/v1/trend-repository.ts:18

tags

tags: {
list(params?, meta?): Paginator<mastodon.v1.Tag[], ListTrendsParams>;
}

Type declaration

list:function
- list(params?, meta?): Paginator<mastodon.v1.Tag[], ListTrendsParams>
- Tags that are being used more frequently within the past week.
  Parameters
  - Optional params: ListTrendsParams
    Parameters
  - Optional meta: HttpMetaParams<"none">
  Returns Paginator<mastodon.v1.Tag[], ListTrendsParams>
  Array of Tag with History
  
  See
  https://docs.joinmastodon.org/methods/trends/#tags
  - Defined in src/mastodon/rest/v1/trend-repository.ts:42