Class Lists

Lists api namespace

Hierarchy

Lists

Implements

ApiNamespace

Index

Constructors

constructor

new Lists(config: ApiConfig): Lists
Parameters
- config: ApiConfig
Returns Lists
- Defined in src/lists/index.ts:12

Properties

config

config: ApiConfig

Methods

getComments

getComments(__namedParameters: {
    id: string;
    pagination: Pagination;
    sort?: CommentSortByBase;
}): Promise<ApiResponse<Comment[]>>
Returns all top level comments for a list.

Returns
Parameters
- __namedParameters: {
      id: string;
      pagination: Pagination;
      sort?: CommentSortByBase;
  }
  - id: string
  - pagination: Pagination
  - Optional sort?: CommentSortByBase
Returns Promise<ApiResponse<Comment[]>>
- Defined in src/lists/index.ts:111

getItems

getItems(__namedParameters: {
    id: string;
    pagination?: Pagination;
    type?: ListItemType;
}): Promise<ApiResponse<ListItem[]>>
Get all items on a personal list.

Returns
Parameters
- __namedParameters: {
      id: string;
      pagination?: Pagination;
      type?: ListItemType;
  }
  - id: string
  - Optional pagination?: Pagination
  - Optional type?: ListItemType
Returns Promise<ApiResponse<ListItem[]>>
- Defined in src/lists/index.ts:84

getLikes

getLikes(__namedParameters: {
id: string;
pagination: Pagination;
}): Promise<ApiResponse<ListLike[]>>
Returns all users who liked a list.

Returns
Parameters
- __namedParameters: {
  id: string;
  pagination: Pagination;
  }
  - id: string
  - pagination: Pagination
Returns Promise<ApiResponse<ListLike[]>>
- Defined in src/lists/index.ts:67

getList

getList(id: {
id: string;
}): Promise<ApiResponse<List>>
Returns a single list.

Returns
list
Parameters
- id: {
  id: string;
  }
  
  list id
  - id: string
Returns Promise<ApiResponse<List>>
- Defined in src/lists/index.ts:52

popular(pagination: {
pagination: Pagination;
}): Promise<ApiResponse<PopularTrendingList[]>>
Returns the most popular lists.

Returns
lists
Parameters
- pagination: {
  pagination: Pagination;
  }
  - pagination: Pagination
Returns Promise<ApiResponse<PopularTrendingList[]>>
- Defined in src/lists/index.ts:38

trending(pagination: {
pagination: Pagination;
}): Promise<ApiResponse<PopularTrendingList[]>>
Returns all lists with the most likes and comments over the last 7 days.

Returns
lists
Parameters
- pagination: {
  pagination: Pagination;
  }
  - pagination: Pagination
Returns Promise<ApiResponse<PopularTrendingList[]>>
- Defined in src/lists/index.ts:24

Class Lists

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: ApiConfig

Returns Lists

Properties

config

Methods

getComments

Returns

Parameters

__namedParameters: { id: string; pagination: Pagination; sort?: CommentSortByBase; }

id: string

pagination: Pagination

Optional sort?: CommentSortByBase

Returns Promise<ApiResponse<Comment[]>>

getItems

Returns

Parameters

__namedParameters: { id: string; pagination?: Pagination; type?: ListItemType; }

id: string

Optional pagination?: Pagination

Optional type?: ListItemType

Returns Promise<ApiResponse<ListItem[]>>

getLikes

Returns

Parameters

__namedParameters: { id: string; pagination: Pagination; }

id: string

pagination: Pagination

Returns Promise<ApiResponse<ListLike[]>>

getList

Returns

Parameters

id: { id: string; }

id: string

Returns Promise<ApiResponse<List>>

popular

Returns

Parameters

pagination: { pagination: Pagination; }

pagination: Pagination

Returns Promise<ApiResponse<PopularTrendingList[]>>

trending

Returns

Parameters

pagination: { pagination: Pagination; }

pagination: Pagination

Returns Promise<ApiResponse<PopularTrendingList[]>>

Settings

Member Visibility

Theme

__namedParameters: {
id: string;
pagination: Pagination;
sort?: CommentSortByBase;
}

`Optional` sort?: CommentSortByBase

__namedParameters: {
id: string;
pagination?: Pagination;
type?: ListItemType;
}

`Optional` pagination?: Pagination

`Optional` type?: ListItemType

__namedParameters: {
id: string;
pagination: Pagination;
}

id: {
id: string;
}

pagination: {
pagination: Pagination;
}

pagination: {
pagination: Pagination;
}