Class Illust

Hierarchy

Illust

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Illust(api: api): Illust

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

Properties

Protected api

api: api

nextURL

nextURL: string | null = null

Private search

search: Search = new Search(this.api)

Methods

bookmarkDetail

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

- Defined in entities/Illust.ts:137
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:156
Gets the bookmark ranges.

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

bookmarkTags

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

- Defined in entities/Illust.ts:145
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:86
Comments from V3 API

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

detail

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

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

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

doBookmarkIllust

doBookmarkIllust(params: PixivParams & object): Promise<void>

- Defined in entities/Illust.ts:165
Bookmark the illust.

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

follow

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

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

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

get

get(illustResolvable: string | number, params?: PixivParams): Promise<any>

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

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

getPages

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

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

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

new

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

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

Parameters
- Optional params: PixivParams
Returns Promise<any>

popularPreview

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

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

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

ranking

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

- Defined in entities/Illust.ts:105
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:94
Gets recommended illusts.

Parameters
- Optional params: PixivParams
Returns Promise<any>

trendingTags

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

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

Parameters
- Optional params: PixivParams
Returns Promise<any>

undoBookmarkIllust

undoBookmarkIllust(params: PixivParams & object): Promise<void>

- Defined in entities/Illust.ts:173
Undo bookmark the illust.

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

Generated using TypeDoc