TitleCollection

TitleCollection

Title collection.

Constructor

new TitleCollection(request, path, options)

Create a title collection.

Source:
Parameters:
Name Type Description
request object

Axios client.
path string

Title path.
options object

Parameters that user can specify.

Name Type Attributes Default Description
page number <optional>
 1

Page number.
defaultEntryCount number <optional>
 1

Default entry count, using if entry count not provided.
cookies string <optional>
 null

Cookie string.
type TitleType <optional>
 1

Type of title.

Extends

Members

currPage :number

Current page.

Overrides:
Source:
Type:
  • number

pageCount :number|null

Total page count, if type is followed user title = null.

Overrides:
Source:
Type:
  • number | null

titles :Array.<(Title|FollowedUserTitle|DraftTitle)>

Title collection.

Source:
Type:

totalTitleCount :number|null

Total title count, if type is followed user title = null.

Source:
Type:
  • number | null

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 title collection.

Source:
Returns:
Type:
Promise

Promise.