# Client extends Eris.Client Abstract

The main Chariot.js abstract base client class extending the Eris client. Every new bot created must extend this class. This class should never be instantiated as-is without being extended as this might introduce unexpected behavior.

An example project along with highly detailed explanations and tips can be found within the Examples section here.

# Constructor

Instantiation: new Client(chariotConfig);

Parameter	Type	Optional	Default	Description
`chariotConfig`	Config		N/A	A valid Chariot.js config class object

# Properties

# prefix Read Only

The prefixes Chariot.js was instantiated with
Type: Array<String>

# guildPrefixes Read Only

All per-guild specific prefixes Chariot.js was instantiated with
Type: Array<Object>

# commands Read Only

The internal collection of all validly registered Chariot.js commands mapped by their instantiation name.
Type: Collection<Chariot.Command>

# bot

Whether the bot user belongs to an OAuth2 application
Type: Boolean

# channelGuildMap

Object mapping channel IDs to guild IDs
Type: Object

# groupChannels

Collection of group channels the bot is in (user accounts only)
Type: Collection<GroupChannel>

# guilds

Collection of guilds the bot is in
Type: Collection<Guild>

# guildShardMap

Object mapping guild IDs to shard IDs
Type: Object

# notes

Object mapping user IDs to user notes (user accounts only)
Type: Object

# options

Eris options
Type: Object

# privateChannelMap

Object mapping user IDs to private channel IDs
Type: Object

# privateChannels

Collection of private channels the bot is in
Type: Collection<PrivateChannel>

# relationships

Collection of relationships the bot user has (user accounts only)
Type: Collection<Relationship>

# shards

Collection of shards Eris is using
Type: Collection<Shard>

# startTime

Timestamp of bot ready event
Type: Number

# token

The bot user token
Type: String

# unavailableGuilds

Collection of unavailable guilds the bot is in
Type: Collection<UnavailableGuilds>

# uptime

How long in milliseconds the bot has been up for
Type: Number

# user

The bot user
Type: ExtendedUser

# userGuildSettings

Object mapping guild IDs to individual guild settings for the bot user (user accounts only)
Type: Object

# users

Collection of users the bot sees
Type: Collection<User>

# userSettings

Object containing the user account settings (user accounts only)
Type: Object

# voiceConnections

Extended collection of active VoiceConnections the bot has
Type: Collection<VoiceConnection>

# Methods

Please reference Eris.Client for a full method reference. The Chariot.js client does not expose any usable public methods.

# Events

Please reference Eris.Client for a full event reference. The Chariot.js client does not expose any usable public events.