Class: AuctionManager


AuctionManager(managerOptions)

new AuctionManager(managerOptions)

Parameters:
Name Type Description
managerOptions Object

The options of the manager

Source:

Methods

(async) exists(guildId, channelId) → {Promise.<boolean>}

Parameters:
Name Type Description
guildId string

The guild ID of the auction

channelId string

The channel ID of the auction

Source:
Returns:
  • Type: Promise.<boolean>

(async) fetch(guildId, channelId) → {Promise.<Auction>}

Parameters:
Name Type Description
guildId string

The guild ID of the auction.

channelId string

The channel ID of the auction.

Source:
Returns:

(async) fetchAll() → {Promise.<Array.<Auction>>}

Fetches all auctions

.

Fetches all auctions

Source:
Returns:

(async) start(auctionStartOptions) → {Promise.<Auction>}

Parameters:
Name Type Description
auctionStartOptions Object
Properties
Name Type Attributes Description
item string

The item to auction.

price string

The starting price of the auction.

channelId string

The channel id to start the auction in.

guildId string

The guild id to start the auction in.

hostedBy string <optional>

The user who started the auction

Source:
Returns:
  • The Auction that was started