Class User

Hierarchy

User

Index

Constructors

constructor

Properties

api

Methods

Constructors

constructor

new User(api: api): User

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

Properties

Private api

api: api

Methods

bookmarkDetail

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

- Defined in entities/User.ts:64
Gets details on a bookmark.

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

bookmarkIllustTags

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

- Defined in entities/User.ts:54
Gets bookmark illust tags.

Parameters
- Optional params: PixivParams
Returns Promise<any>

bookmarkNovelTags

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

- Defined in entities/User.ts:81
Fetches bookmark novel tags.

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

bookmarksIllust

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

- Defined in entities/User.ts:45
Gets all the public bookmarked illusts by the user.

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

bookmarksNovel

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

- Defined in entities/User.ts:72
Gets a user's public bookmarked novels.

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

detail

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

- Defined in entities/User.ts:21
Gets a detailed user profile.

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

followDetail

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

- Defined in entities/User.ts:123
Gets details on a user follow.

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

followers

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

- Defined in entities/User.ts:99
Fetches the followers of a user.

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

following

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

- Defined in entities/User.ts:90
Fetches the users a user is following.

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

get

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

- Defined in entities/User.ts:11
Gets a user by URL or ID.

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

illusts

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

- Defined in entities/User.ts:29
Gets all illusts by the user.

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

myPixiv

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

- Defined in entities/User.ts:107
Gets the MyPixiv of a user.

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

novels

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

- Defined in entities/User.ts:37
Gets all novels by the user.

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

recommended

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

- Defined in entities/User.ts:115
Gets recommended users.

Parameters
- Optional params: PixivParams
Returns Promise<any>

Generated using TypeDoc