Interface ListsResource

interface ListsResource {
    $select(id: string): Lists$SelectResource;
    create(
        params: CreateListParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<List>;
    list(meta?: HttpMetaParams<"none">): Paginator<List[]>;
}

Index

Methods

$select create list

Methods

$select

$select(id: string): Lists$SelectResource
Parameters
- id: string
Returns Lists$SelectResource
- Defined in src/mastodon/rest/v1/lists.ts:91

create

create(params: CreateListParams, meta?: HttpMetaParams<"json">): Promise<List>
Create a new list.
Parameters
- params: CreateListParams
  Parameters
- Optionalmeta: HttpMetaParams<"json">
Returns Promise<List>
List

See
https://docs.joinmastodon.org/methods/timelines/lists/
- Defined in src/mastodon/rest/v1/lists.ts:106

list

list(meta?: HttpMetaParams<"none">): Paginator<List[]>
Fetch all lists that the user owns.
Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Paginator<List[]>
Array of List

See
https://docs.joinmastodon.org/methods/timelines/lists/
- Defined in src/mastodon/rest/v1/lists.ts:98