User

User

User.

Constructor

new User(request, username, cookiesopt)

Create user.

Source:
Parameters:
Name Type Attributes Default Description
request object

Axios client.

username string

Username.

cookies string <optional>
null

Cookie string.

Members

badgePoints :number

Badge points.

Source:
Type:
  • number

badges :Array.<UserBadge>

Badge list.

Source:
Type:

entryCountLastmonth :number

Last month entry count.

Source:
Type:
  • number

entryCountLastweek :number

Last week entry count.

Source:
Type:
  • number

entryCountToday :number

Today entry count.

Source:
Type:
  • number

entryCountTotal :number

Total entry count.

Source:
Type:
  • number

id :number|null

User ID.

Source:
Type:
  • number | null

isBlocked :boolean|null

Is user blocked?

Source:
Type:
  • boolean | null

isFollowed :boolean|null

Is user followed?

Source:
Type:
  • boolean | null

isTitlesBlocked :boolean|null

Is user titles blocked?

Source:
Type:
  • boolean | null

lastEntryTime :string|null

Last entry time.

Source:
Type:
  • string | null

note :string|null

User note.

Source:
Type:
  • string | null

url :string

User URL.

Source:
Type:
  • string

username :string

Tag URL.

Source:
Type:
  • string

Methods

(async) entries(options) → {Promise.<UserEntryCollection>}

Fetch user entries by latest.

Source:
Parameters:
Name Type Description
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
1

Page number.

Returns:
Type:
Promise.<UserEntryCollection>

User entries by last posted.

(async) favoriteAuthors() → {UserFavoriteAuthorCollection}

Fetch user favorite authors until last one month.

Source:
Returns:
Type:
UserFavoriteAuthorCollection

User favorite authors.

(async) favoritedEntries(options) → {Promise.<UserEntryCollection>}

Fetch user favorited entries by most favorited.

Source:
Parameters:
Name Type Description
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
1

Page number.

Returns:
Type:
Promise.<UserEntryCollection>

User entries by most favorited.

(async) favorites(options) → {Promise.<UserEntryCollection>}

Fetch user favorite entries by latest.

Source:
Parameters:
Name Type Description
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
1

Page number.

Returns:
Type:
Promise.<UserEntryCollection>

User entries by last favorited.

(async) images() → {ImageCollection}

User images.

Source:
Returns:
Type:
ImageCollection

User images.

(async) lastVotedEntries(options) → {Promise.<UserEntryCollection>}

Fetch user last voted entries.

Source:
Parameters:
Name Type Description
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
1

Page number.

Returns:
Type:
Promise.<UserEntryCollection>

User entries by last voted.

(async) mostLikedEntries(options) → {Promise.<UserEntryCollection>}

Fetch user most liked entries.

Source:
Parameters:
Name Type Description
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
1

Page number.

Returns:
Type:
Promise.<UserEntryCollection>

User entries by most liked.

retrieve() → {Promise}

Retrieve user.

Source:
Returns:
Type:
Promise

Promise.

(async) selfFavoritedEntries(options) → {Promise.<UserEntryCollection>}

Fetch user self favorited entries.

Source:
Parameters:
Name Type Description
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
1

Page number.

Returns:
Type:
Promise.<UserEntryCollection>

User entries by self favorited.

(async) ukteler() → {UkteCollection}

Fetch ukteler.

Source:
Returns:
Type:
UkteCollection

User ukteler.