Class UserManager

Hierarchy (View Summary)

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: Client): UserManager
Parameters
- client: Client
Returns UserManager
Inherited from BaseManager.constructor
- Defined in projects/jikan4.js/jikan4.js-old/src/v4/manager/base.ts:69

Properties

`Protected`APIClient

APIClient: APIClient

`Readonly`client

client: Client

Methods

get

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

getAbout

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

getClubs

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

getExternal

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

getFavorites

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

getFriends

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

getFull

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

getHistory

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

getRecommendations

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

getReviews

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

getStatistics

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

getUpdates

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

list

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

search

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

`Static`parseDate

parseDate<IsNullable extends boolean = false>(
input: any,
nullable?: IsNullable,
): 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 projects/jikan4.js/jikan4.js-old/src/v4/resource/base.ts:4

`Static`parseURL

parseURL<IsNullable extends boolean = false>(
input: any,
nullable?: IsNullable,
): 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 projects/jikan4.js/jikan4.js-old/src/v4/resource/base.ts:18