Class UserManager

Hierarchy (view full)

BaseManager
- UserManager

Index

Constructors

Properties

APIClient client

Methods

get getAbout getClubs getExternal getFavorites getFriends getFull getHistory getRecommendations getReviews getStatistics getUpdates list search parseDate parseURL

Constructors

constructor

new UserManager(client): UserManager
Parameters
- client: Client
Returns UserManager
Inherited from BaseManager.constructor
- Defined in src/v4/manager/base.ts:69

Properties

`Protected`APIClient

APIClient: APIClient

`Readonly`client

client: Client

Methods

get

get(username): Promise<undefined | User>
Parameters
- username: string
Returns Promise<undefined | User>
- Defined in src/v4/manager/user.ts:42

getAbout

getAbout(username): Promise<undefined | null | string>
Parameters
- username: string
Returns Promise<undefined | null | string>
- Defined in src/v4/manager/user.ts:72

getClubs

getClubs(username, offset?, maxCount?): Promise<undefined | ClubMeta[]>
Parameters
- username: string
- Optionaloffset: number
- OptionalmaxCount: number
Returns Promise<undefined | ClubMeta[]>
- Defined in src/v4/manager/user.ts:117

getExternal

getExternal(username): Promise<undefined | Link[]>
Parameters
- username: string
Returns Promise<undefined | Link[]>
- Defined in src/v4/manager/user.ts:123

getFavorites

getFavorites(username): Promise<undefined | UserFavorites>
Parameters
- username: string
Returns Promise<undefined | UserFavorites>
- Defined in src/v4/manager/user.ts:60

getFriends

getFriends(username, offset?, maxCount?): Promise<undefined | UserFriend[]>
Parameters
- username: string
- Optionaloffset: number
- OptionalmaxCount: number
Returns Promise<undefined | UserFriend[]>
- Defined in src/v4/manager/user.ts:91

getFull

getFull(username): Promise<undefined | UserFull>
Parameters
- username: string
Returns Promise<undefined | UserFull>
- Defined in src/v4/manager/user.ts:48

getHistory

getHistory(username, type?): Promise<(UserMangaHistory | UserAnimeHistory)[]>
Parameters
- username: string
- type: "anime" | "manga" | "all" = 'all'
Returns Promise<(UserMangaHistory | UserAnimeHistory)[]>
- Defined in src/v4/manager/user.ts:78

getRecommendations

getRecommendations(username, offset?, maxCount?): Promise<undefined | UserRecommendation[]>
Parameters
- username: string
- Optionaloffset: number
- OptionalmaxCount: number
Returns Promise<undefined | UserRecommendation[]>
- Defined in src/v4/manager/user.ts:111

getReviews

getReviews(username, offset?, maxCount?): Promise<undefined | (MangaReview | AnimeReview)[]>
Parameters
- username: string
- Optionaloffset: number
- OptionalmaxCount: number
Returns Promise<undefined | (MangaReview | AnimeReview)[]>
- Defined in src/v4/manager/user.ts:97

getStatistics

getStatistics(username): Promise<undefined | UserStats>
Parameters
- username: string
Returns Promise<undefined | UserStats>
- Defined in src/v4/manager/user.ts:54

getUpdates

getUpdates(username): Promise<undefined | UserContentUpdates>
Parameters
- username: string
Returns Promise<undefined | UserContentUpdates>
- Defined in src/v4/manager/user.ts:66

list

list(offset?, maxCount?): Promise<UserMeta[]>
Parameters
- Optionaloffset: number
- OptionalmaxCount: number
Returns Promise<UserMeta[]>
- Defined in src/v4/manager/user.ts:36

search

search(searchString, filter?, offset?, maxCount?): Promise<User[]>
Parameters
- searchString: string
- Optionalfilter: Partial<UserSearchFilter>
- Optionaloffset: number
- OptionalmaxCount: number
Returns Promise<User[]>
- Defined in src/v4/manager/user.ts:27

`Static`parseDate

parseDate<IsNullable>(input, nullable?): IsNullable extends false
? Date
: null | Date
Type Parameters
- IsNullable extends boolean = false
Parameters
- input: any
- nullable: IsNullable = ...
Returns IsNullable extends false
? Date
: null | Date
Inherited from BaseManager.parseDate
- Defined in src/v4/resource/base.ts:4

`Static`parseURL

parseURL<IsNullable>(input, nullable?): IsNullable extends false
? URL
: null | URL
Type Parameters
- IsNullable extends boolean = false
Parameters
- input: any
- nullable: IsNullable = ...
Returns IsNullable extends false
? URL
: null | URL
Inherited from BaseManager.parseURL
- Defined in src/v4/resource/base.ts:18