Class User

Hierarchy (view full)

BaseClass
- User
  - UserFull

Index

Constructors

Properties

birthday client gender image joined lastOnline location url username

Methods

getAbout getClubs getExternal getFavorites getFriends getFull getHistory getRecommendations getStatistics getUpdates parseDate parseGender parseURL

Constructors

constructor

new User(client, data): User
Parameters
- client: Client
- data: any
Returns User
Overrides BaseClass.constructor
- Defined in src/v4/resource/user.ts:88

Properties

`Readonly`birthday

birthday: null | Date

`Readonly`client

client: Client

`Readonly`gender

gender: UserGender

`Readonly`image

image: null | ImageFormatCollection

`Readonly`joined

joined: null | Date

`Readonly`lastOnline

lastOnline: null | Date

`Readonly`location

location: null | string

`Readonly`url

url: URL

`Readonly`username

username: string

Methods

getAbout

getAbout(): Promise<null | string>
Returns Promise<null | string>
- Defined in src/v4/resource/user.ts:60

getClubs

getClubs(offset?, maxCount?): Promise<ClubMeta[]>
Parameters
- Optionaloffset: number
- OptionalmaxCount: number
Returns Promise<ClubMeta[]>
- Defined in src/v4/resource/user.ts:76

getExternal

getExternal(): Promise<Link[]>
Returns Promise<Link[]>
- Defined in src/v4/resource/user.ts:80

getFavorites

getFavorites(): Promise<UserFavorites>
Returns Promise<UserFavorites>
- Defined in src/v4/resource/user.ts:52

getFriends

getFriends(offset?, maxCount?): Promise<UserFriend[]>
Parameters
- Optionaloffset: number
- OptionalmaxCount: number
Returns Promise<UserFriend[]>
- Defined in src/v4/resource/user.ts:68

getFull

getFull(): Promise<UserFull>
Returns Promise<UserFull>
- Defined in src/v4/resource/user.ts:84

getHistory

getHistory(type?): Promise<(UserMangaHistory | UserAnimeHistory)[]>
Parameters
- Optionaltype: "anime" | "manga" | "all"
Returns Promise<(UserMangaHistory | UserAnimeHistory)[]>
- Defined in src/v4/resource/user.ts:64

getRecommendations

getRecommendations(offset?, maxCount?): Promise<UserRecommendation[]>
Parameters
- Optionaloffset: number
- OptionalmaxCount: number
Returns Promise<UserRecommendation[]>
- Defined in src/v4/resource/user.ts:72

getStatistics

getStatistics(): Promise<UserStats>
Returns Promise<UserStats>
- Defined in src/v4/resource/user.ts:48

getUpdates

getUpdates(): Promise<UserContentUpdates>
Returns Promise<UserContentUpdates>
- Defined in src/v4/resource/user.ts:56

`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 BaseClass.parseDate
- Defined in src/v4/resource/base.ts:4

`Static`parseGender

parseGender(input): UserGender
Parameters
- input: any
Returns UserGender
- Defined in src/v4/resource/user.ts:29

`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 BaseClass.parseURL
- Defined in src/v4/resource/base.ts:18