Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-16 03:23:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs 6.66%

Browse Source
This commit is contained in:
hydrabolt
2016-02-13 18:21:59 +00:00
parent 4e03c0b1a2
commit 7144ead048
10 changed files with 628 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
lib/index.js
View File

@@ -1,5 +1,35 @@
"use strict";
/**
* Object containing user agent data required for API requests.
* @typedef {(object)} UserAgent
* @property {string} [url=https://github.com/hydrabolt/discord.js] URL to the repository/homepage of the creator.
* @property {string} [version=6.0.0] version of your bot.
* @property {string} full stringified user-agent that is generate automatically upon changes. Read-only.
*/
/**
* Object containing properties that can be used to alter the client's functionality.
* @typedef {(object)} ClientOptions
* @property {boolean} [compress=true] whether or not large packets that are sent over WebSockets should be compressed.
* @property {boolean} [revive=false] whether the Client should attempt to automatically reconnect if it is disconnected.
* @property {boolean} [rate_limit_as_error=false] whether rejections to API requests due to rate-limiting should be treated as errors.
* @property {Number} [large_threshold=250] an integer between 0 and 250. When a server has more users than `options.large_threshold`, only the online/active users are cached.
*/
/**
* Object containing properties that will be applied when deleting messages
* @typedef {(object)} MessageDeletionOptions
* @property {Number} [wait] If set, the message will be deleted after `options.wait` milliseconds.
*/
/**
* Object containing properties that will be used when fetching channel logs. You cannot specify _both_ `options.before` and `options.after`
* @typedef {(object)} ChannelLogsOptions
* @property {MessageResolvable} [before] When fetching logs, it will fetch from messages before `options.before` but not including it.
* @property {MessageResolvable} [after] When fetching logs, it will fetch from messages after `options.after` but not including it.
*/
exports.__esModule = true;
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
@@ -65,20 +95,20 @@ var _UtilCacheJs = require("./Util/Cache.js");
var _UtilCacheJs2 = _interopRequireDefault(_UtilCacheJs);
exports["default"] = {
Client: _ClientClient2["default"],
Channel: _StructuresChannel2["default"],
ChannelPermissions: _StructuresChannelPermissions2["default"],
Invite: _StructuresInvite2["default"],
Message: _StructuresMessage2["default"],
PermissionOverwrite: _StructuresPermissionOverwrite2["default"],
PMChannel: _StructuresPMChannel2["default"],
Role: _StructuresRole2["default"],
Server: _StructuresServer2["default"],
ServerChannel: _StructuresServerChannel2["default"],
TextChannel: _StructuresTextChannel2["default"],
User: _StructuresUser2["default"],
VoiceChannel: _StructuresVoiceChannel2["default"],
Constants: _Constants2["default"],
Cache: _UtilCacheJs2["default"]
Client: _ClientClient2["default"],
Channel: _StructuresChannel2["default"],
ChannelPermissions: _StructuresChannelPermissions2["default"],
Invite: _StructuresInvite2["default"],
Message: _StructuresMessage2["default"],
PermissionOverwrite: _StructuresPermissionOverwrite2["default"],
PMChannel: _StructuresPMChannel2["default"],
Role: _StructuresRole2["default"],
Server: _StructuresServer2["default"],
ServerChannel: _StructuresServerChannel2["default"],
TextChannel: _StructuresTextChannel2["default"],
User: _StructuresUser2["default"],
VoiceChannel: _StructuresVoiceChannel2["default"],
Constants: _Constants2["default"],
Cache: _UtilCacheJs2["default"]
};
module.exports = exports["default"];