Interface SuggestionsResource

interface SuggestionsResource {
    $select(id: string): Suggestions$SelectResource;
    list(
        params?: ListSuggestionParams,
        meta?: HttpMetaParams<"none">,
    ): Paginator<mastodon.v1.Account[], ListSuggestionParams>;
}

Index

Methods

Methods

$select

$select(id: string): Suggestions$SelectResource
Parameters
- id: string
Returns Suggestions$SelectResource
- Defined in src/mastodon/rest/v1/suggestions.ts:20

list

list(
params?: ListSuggestionParams,
meta?: HttpMetaParams<"none">,
): Paginator<mastodon.v1.Account[], ListSuggestionParams>
Accounts the user has had past positive interactions with, but is not yet following.
Parameters
- Optionalparams: ListSuggestionParams
  Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Paginator<mastodon.v1.Account[], ListSuggestionParams>
Array of Accounts

See
https://docs.joinmastodon.org/methods/suggestions/#v1
- Defined in src/mastodon/rest/v1/suggestions.ts:28