Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Collection

Hierarchy

  • Transformable
    • Collection

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns Collection

Properties

collection

collection: Avatar[]

total

total: number

Accessors

options

Methods

getNextPage

  • getNextPage(append?: boolean): Promise<null | Avatar[]>
  • remarks

    Uses the same AvatarsOptions that have been used getting this avatar collection.

    throws

    APIError

    Parameters

    • append: boolean = true

      If set to true, the avatars will be appended to the collection property

    Returns Promise<null | Avatar[]>

    The next set of avatars, null when there are no more entries

toPlain

  • toPlain(): unknown

  • Converts this class back into a plain javascript object.

    remarks

    Property keys which have been renamed during the initial transformation to a class object will be reverted to the original keys. For example, the cachedSince property in the Ladder class will be reverted to the original API property, cached_since.

    Returns unknown

Generated using TypeDoc