Updated docs

This commit is contained in:
hydrabolt
2015-11-20 16:40:26 +00:00
parent 10ea6a9336
commit b6f158fac4
22 changed files with 25 additions and 20 deletions

View File

@@ -3,6 +3,8 @@
Cache
=====
**extends Array**
A Cache object extends an Array (so it can be used like a regular array) but introduces helper functions to make it more useful when developing with discord.js. Unlike a regular array, it doesn't care about the instance or prototype of an object, it works purely on properties.
Functions

View File

@@ -3,6 +3,8 @@
Client
======
**extends EventEmitter_**
This page contains documentation on the `Discord.Client` class. This should be used when you want to start creating things with the API.
Attributes

View File

@@ -1,3 +1,4 @@
.. _Client : ./docs_client.html
.. _Cache : ./docs_cache.html
.. _Promises : https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise
.. _Promises : https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise
.. _EventEmitter : https://nodejs.org/api/events.html#events_class_events_eventemitter

View File

@@ -4,4 +4,4 @@ exports.IDLE = 0;
exports.LOGGING_IN = 1;
exports.LOGGED_IN = 2;
exports.READY = 3;
exports.DISCONNECTED = 4;
exports.DISCONNECTED = 4;

View File

@@ -1389,7 +1389,7 @@ var InternalClient = (function () {
if (channel instanceof PMChannel) {
//PM CHANNEL
client.emit("channelUpdated", self.private_channels.update(channel, new PMChannel(data, client)));
client.emit("channelUpdated", channel, self.private_channels.update(channel, new PMChannel(data, client)));
} else {
if (channel.server) {
if (channel.type === "text") {

View File

@@ -127,4 +127,4 @@ var PacketType = {
exports.API_ENDPOINT = API;
exports.Endpoints = Endpoints;
exports.PacketType = PacketType;
exports.Permissions = Permissions;
exports.Permissions = Permissions;

View File

@@ -27,4 +27,4 @@ var Channel = (function (_Equality) {
return Channel;
})(Equality);
module.exports = Channel;
module.exports = Channel;

View File

@@ -72,4 +72,4 @@ var ChannelPermissions = (function () {
return ChannelPermissions;
})();
module.exports = ChannelPermissions;
module.exports = ChannelPermissions;

View File

@@ -29,4 +29,4 @@ var Invite = (function () {
return Invite;
})();
module.exports = Invite;
module.exports = Invite;

View File

@@ -83,4 +83,4 @@ var PermissionOverwrite = (function () {
return PermissionOverwrite;
})();
module.exports = PermissionOverwrite;
module.exports = PermissionOverwrite;

View File

@@ -136,4 +136,4 @@ var Role = (function () {
return Role;
})();
module.exports = Role;
module.exports = Role;

View File

@@ -166,4 +166,4 @@ var Server = (function (_Equality) {
return Server;
})(Equality);
module.exports = Server;
module.exports = Server;

View File

@@ -55,4 +55,4 @@ var User = (function (_Equality) {
return User;
})(Equality);
module.exports = User;
module.exports = User;

View File

@@ -18,4 +18,4 @@ var VoiceChannel = (function (_ServerChannel) {
return VoiceChannel;
})(ServerChannel);
module.exports = VoiceChannel;
module.exports = VoiceChannel;

View File

@@ -2,4 +2,4 @@
exports.reg = function (c, a) {
return [c].concat(Array.prototype.slice.call(a));
};
};

View File

@@ -30,7 +30,7 @@ var Cache = (function (_Array) {
};
Cache.prototype.getAll = function getAll(key, value) {
var found = [];
var found = new Cache(this.discrim);
this.forEach(function (val, index, array) {
if (val.hasOwnProperty(key) && val[key] == value) {
found.push(val);

View File

@@ -42,4 +42,4 @@ var Equality = (function () {
return Equality;
})();
module.exports = Equality;
module.exports = Equality;

View File

@@ -126,4 +126,4 @@ var AudioEncoder = (function () {
return AudioEncoder;
})();
module.exports = AudioEncoder;
module.exports = AudioEncoder;

View File

@@ -19,4 +19,4 @@ var StreamIntent = (function (_EventEmitter) {
return StreamIntent;
})(EventEmitter);
module.exports = StreamIntent;
module.exports = StreamIntent;

View File

@@ -329,4 +329,4 @@ var VoiceConnection = (function (_EventEmitter) {
return VoiceConnection;
})(EventEmitter);
module.exports = VoiceConnection;
module.exports = VoiceConnection;

View File

@@ -23,4 +23,4 @@ var VoicePacket = function VoicePacket(data, sequence, time, ssrc) {
return returnBuffer;
};
module.exports = VoicePacket;
module.exports = VoicePacket;

View File

@@ -14,4 +14,4 @@ module.exports = {
TextChannel: require("./Structures/TextChannel"),
User: require("./Structures/User"),
VoiceChannel: require("./Structures/VoiceChannel")
};
};