Class Illust

Hierarchy

Illust

Index

Constructors

constructor

Properties

api

Methods

Constructors

constructor

new Illust(api: api): Illust

- Defined in entities/Illust.ts:5
Parameters
- api: api
Returns Illust

Properties

Protected api

api: api

Methods

bookmarkDetail

bookmarkDetail(params: PixivParams & object): Promise<any>

- Defined in entities/Illust.ts:124
Gets the details for a bookmark.

Parameters
- params: PixivParams & object
Returns Promise<any>

bookmarkRanges

bookmarkRanges(params: PixivParams & object): Promise<any>

- Defined in entities/Illust.ts:142
Gets the bookmark ranges.

Parameters
- params: PixivParams & object
Returns Promise<any>

bookmarkTags

bookmarkTags(params?: PixivParams): Promise<any>

- Defined in entities/Illust.ts:132
Gets the tags for a bookmark.

Parameters
- Optional params: PixivParams
Returns Promise<any>

comments

comments(params: PixivParams & object): Promise<any>

- Defined in entities/Illust.ts:65
Fetches the comments on an illust.

Parameters
- params: PixivParams & object
Returns Promise<any>

commentsV2

commentsV2(params: PixivParams & object): Promise<any>

- Defined in entities/Illust.ts:74
The difference from the V1 API is that parent_comment was replaced with has_replies.

Parameters
- params: PixivParams & object
Returns Promise<any>

detail

detail(params: PixivParams & object): Promise<any>

- Defined in entities/Illust.ts:21
Gets the details for an illust.

Parameters
- params: PixivParams & object
Returns Promise<any>

follow

follow(params: PixivParams & object): Promise<any>

- Defined in entities/Illust.ts:56
Gets illusts from users you follow.

Parameters
- params: PixivParams & object
Returns Promise<any>

get

get(illustResolvable: string | number): Promise<any>

- Defined in entities/Illust.ts:11
Gets an illust by either URL or ID.

Parameters
- illustResolvable: string | number
Returns Promise<any>

getPages

getPages(illust: PixivIllust, size?: string): Promise<string[]>

- Defined in entities/Illust.ts:30
Gets the URLS of all the pages for an illust.

Parameters
- illust: PixivIllust
- Optional size: string
Returns Promise<string[]>

new

new(params?: PixivParams): Promise<any>

- Defined in entities/Illust.ts:46
Gets new illusts.

Parameters
- Optional params: PixivParams
Returns Promise<any>

popularPreview

popularPreview(params: PixivParams & object): Promise<any>

- Defined in entities/Illust.ts:108
Searches illusts in the popular previews.

Parameters
- params: PixivParams & object
Returns Promise<any>

ranking

ranking(params?: PixivParams): Promise<any>

- Defined in entities/Illust.ts:98
Gets illusts from the ranking. Defaults to daily ranking

Parameters
- Optional params: PixivParams
Returns Promise<any>

recommended

recommended(params?: PixivParams): Promise<any>

- Defined in entities/Illust.ts:82
Gets recommended illusts.

Parameters
- Optional params: PixivParams
Returns Promise<any>

trendingTags

trendingTags(params?: PixivParams): Promise<any>

- Defined in entities/Illust.ts:116
Gets trending tags.

Parameters
- Optional params: PixivParams
Returns Promise<any>

walkthrough

walkthrough(params?: PixivParams): Promise<any>

- Defined in entities/Illust.ts:90
Gets walkthrough illusts.

Parameters
- Optional params: PixivParams
Returns Promise<any>

Generated using TypeDoc