UserEntryCollection

UserEntryCollection

User entry collection.

Constructor

new UserEntryCollection(request, path, username, cookies, options)

Create an user entry collection.

Source:
Parameters:
Name Type Description
request object

Axios client.
path string

Path or plain title.
username string

Username.
cookies string

Cookie string.
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
 1

Page number.

Extends

Members

currPage :number

Current page.

Overrides:
Source:
Type:
  • number

entries :Array.<(Entry|EntryForMember)>

Entry collection.

Source:
Type:

entryCount :number

Total entry count.

Source:
Type:
  • number

pageCount :number

Total page count.

Overrides:
Source:
Type:
  • number

username :string

Username.

Source:
Type:
  • string

Methods

(async) first()

Retrieve first page.

Overrides:
Source:

(async) last()

Retrieve last page.

Overrides:
Source:

(async) next()

Retrieve next page.

Overrides:
Source:

(async) prev()

Retrieve previous page.

Overrides:
Source:

retrieve() → {Promise}

Retrieve the user entry collection.

Source:
Returns:
Type:
Promise

Promise.