chariot.js/docs/assets/js/18.8b6e4930.js

An extremely lightweight and extensible Eris client framework

(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{205:function(t,e,r){"use strict";r.r(e);var s=r(0),a=Object(s.a)({},(function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("div",{staticClass:"content"},[r("h1",{attrs:{id:"collection-extends-eris-collection"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#collection-extends-eris-collection"}},[t._v("#")]),t._v(" Collection "),r("span",{staticStyle:{"font-size":".5em"}},[t._v("extends "),r("a",{attrs:{href:"https://abal.moe/Eris/docs/Collection",target:"_blank",rel:"noopener noreferrer"}},[t._v("Eris.Collection"),r("OutboundLink")],1)])]),t._v(" "),r("p",[t._v("An Eris Collection, which extends a "),r("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map",target:"_blank",rel:"noopener noreferrer"}},[t._v("Map"),r("OutboundLink")],1),t._v(" and provides additional utility methods useful for everyday bot development.")]),t._v(" "),t._m(0),t._v(" "),t._m(1),t._v(" "),r("div",{staticClass:"table"},[r("table",[t._m(2),t._v(" "),r("tbody",[r("tr",[t._m(3),t._v(" "),t._m(4),t._v(" "),r("td",[r("Fa-Check")],1),t._v(" "),r("td",[t._v("N/A")]),t._v(" "),r("td",[t._v("A base class for all items")])]),t._v(" "),r("tr",[t._m(5),t._v(" "),t._m(6),t._v(" "),r("td",[r("Fa-Check")],1),t._v(" "),r("td",[t._v("N/A")]),t._v(" "),r("td",[t._v("The maximum amount of items to hold")])])])])]),t._v(" "),t._m(7),t._v(" "),r("div",{attrs:{id:"properties"}},[t._m(8),t._v(" "),r("property",{attrs:{"property-description":"The base class for all items that was specified when the Collection was created","property-type":"Class","property-type-url":"#"}}),t._v(" "),t._m(9),t._v(" "),r("property",{attrs:{"property-description":"Max number of items to hold. This property is undefined if no limit was specified for the Collection","property-type":"Number?","property-tail":"true","property-type-url":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number"}})],1),t._v(" "),t._m(10),t._v(" "),r("p",[t._v("Please reference "),r("a",{attrs:{href:"https://abal.moe/Eris/docs/Collection",target:"_blank",rel:"noopener noreferrer"}},[t._v("Eris.Collection"),r("OutboundLink")],1),t._v(" for a full method reference.")])])}),[function(){var t=this.$createElement,e=this._self._c||t;return e("h2",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[this._v("#")]),this._v(" Constructor")])},function(){var t=this.$createElement,e=this._self._c||t;return e("p",[this._v("Instantiation: "),e("span",{staticStyle:{"font-weight":"bold"}},[e("code",[this._v("new Collection(baseObject, limit);")])])])},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("thead",[r("tr",[r("th",[t._v("Parameter")]),t._v(" "),r("th",[t._v("Type")]),t._v(" "),r("th",[t._v("Optional")]),t._v(" "),r("th",[t._v("Default")]),t._v(" "),r("th",[t._v("Description")])])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("code",[this._v("baseObject")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("a",{attrs:{href:"#"}},[this._v("Class")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("code",[this._v("limit")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("a",{attrs:{href:"#"}},[this._v("Number")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[this._v("#")]),this._v(" Properties")])},function(){var t=this.$createElement,e=this._self._c||t;return e("h3",{attrs:{id:"baseobject"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#baseobject"}},[this._v("#")]),this._v(" baseObject")])},function(){var t=this.$createElement,e=this._self._c||t;return e("h3",{attrs:{id:"limit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#limit"}},[this._v("#")]),this._v(" limit")])},function(){var t=this.$createElement,e=this._self._c||t;return e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[this._v("#")]),this._v(" Methods")])}],!1,null,null,null);e.default=a.exports}}]);