chariot.js/docs/assets/js/22.5c7aa786.js

An extremely lightweight and extensible Eris client framework

(window.webpackJsonp=window.webpackJsonp||[]).push([[22],{209:function(t,e,r){"use strict";r.r(e);var a=r(0),s=Object(a.a)({},(function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("div",{staticClass:"content"},[t._m(0),t._v(" "),r("p",[t._v("Colorful logger class used by Chariot.js internally featuring various log levels and colorful level dependent logging methods")]),t._v(" "),t._m(1),t._v(" "),t._m(2),t._v(" "),t._m(3),t._v(" "),r("div",{attrs:{id:"properties"}},[r("h3",{attrs:{id:"success-title-body"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#success-title-body"}},[t._v("#")]),t._v(" success(title, body) "),r("Badge",{attrs:{text:"Static",type:"chariot"}})],1),t._v(" "),r("Method",{attrs:{"method-description":"Log something related to being successful. Date and Title components get logged in bold green."}}),t._v(" "),r("div",{staticClass:"table-methods"},[r("table",[t._m(4),t._v(" "),r("tbody",[r("tr",[t._m(5),t._v(" "),r("td",[r("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[t._v("String"),r("OutboundLink")],1)]),t._v(" "),r("td",[r("Fa-Times")],1),t._v(" "),r("td",[t._v("N/A")]),t._v(" "),r("td",[t._v("The title of the success log enty")])]),t._v(" "),r("tr",[t._m(6),t._v(" "),r("td",[r("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[t._v("String"),r("OutboundLink")],1)]),t._v(" "),r("td",[r("Fa-Times")],1),t._v(" "),r("td",[t._v("N/A")]),t._v(" "),r("td",[t._v("The body of the success log enty")])])])]),t._v(" "),r("ReturnValue",{attrs:{"return-type":"void","return-type-url":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/void","return-help":"Calling this method returns nothing.",tail:"true"}}),t._v(" "),r("CodeExample"),t._v(" "),t._m(7)],1),t._v(" "),r("hr",{staticClass:"method-divider"}),t._v(" "),r("h3",{attrs:{id:"warning-title-body"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#warning-title-body"}},[t._v("#")]),t._v(" warning(title, body) "),r("Badge",{attrs:{text:"Static",type:"chariot"}})],1),t._v(" "),r("Method",{attrs:{"method-description":"Log something related to a warning. Date and Title components get logged in bold orange."}}),t._v(" "),r("div",{staticClass:"table-methods"},[r("table",[t._m(8),t._v(" "),r("tbody",[r("tr",[t._m(9),t._v(" "),r("td",[r("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[t._v("String"),r("OutboundLink")],1)]),t._v(" "),r("td",[r("Fa-Times")],1),t._v(" "),r("td",[t._v("N/A")]),t._v(" "),r("td",[t._v("The title of the warning log enty")])]),t._v(" "),r("tr",[t._m(10),t._v(" "),r("td",[r("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[t._v("String"),r("OutboundLink")],1)]),t._v(" "),r("td",[r("Fa-Times")],1),t._v(" "),r("td",[t._v("N/A")]),t._v(" "),r("td",[t._v("The body of the warning log enty")])])])]),t._v(" "),r("ReturnValue",{attrs:{"return-type":"void","return-type-url":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/void","return-help":"Calling this method returns nothing.",tail:"true"}}),t._v(" "),r("CodeExample"),t._v(" "),t._m(11)],1),t._v(" "),r("hr",{staticClass:"method-divider"}),t._v(" "),r("h3",{attrs:{id:"error-title-body"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#error-title-body"}},[t._v("#")]),t._v(" error(title, body) "),r("Badge",{attrs:{text:"Static",type:"chariot"}})],1),t._v(" "),r("Method",{attrs:{"method-description":"Log something related to an error. Date and Title components get logged in bold red."}}),t._v(" "),r("div",{staticClass:"table-methods"},[r("table",[t._m(12),t._v(" "),r("tbody",[r("tr",[t._m(13),t._v(" "),r("td",[r("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[t._v("String"),r("OutboundLink")],1)]),t._v(" "),r("td",[r("Fa-Times")],1),t._v(" "),r("td",[t._v("N/A")]),t._v(" "),r("td",[t._v("The title of the error log enty")])]),t._v(" "),r("tr",[t._m(14),t._v(" "),r("td",[r("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[t._v("String"),r("OutboundLink")],1)]),t._v(" "),r("td",[r("Fa-Times")],1),t._v(" "),r("td",[t._v("N/A")]),t._v(" "),r("td",[t._v("The body of the error log enty")])])])]),t._v(" "),r("ReturnValue",{attrs:{"return-type":"void","return-type-url":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/void","return-help":"Calling this method returns nothing.",tail:"true"}}),t._v(" "),r("CodeExample"),t._v(" "),t._m(15)],1),t._v(" "),r("hr",{staticClass:"method-divider"}),t._v(" "),r("h3",{attrs:{id:"debug-title-body"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#debug-title-body"}},[t._v("#")]),t._v(" debug(title, body) "),r("Badge",{attrs:{text:"Static",type:"chariot"}})],1),t._v(" "),r("Method",{attrs:{"method-description":"Log something related to debugging. Date and Title components get logged in bold magenta."}}),t._v(" "),r("div",{staticClass:"table-methods"},[r("table",[t._m(16),t._v(" "),r("tbody",[r("tr",[t._m(17),t._v(" "),r("td",[r("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[t._v("String"),r("OutboundLink")],1)]),t._v(" "),r("td",[r("Fa-Times")],1),t._v(" "),r("td",[t._v("N/A")]),t._v(" "),r("td",[t._v("The title of the debug log enty")])]),t._v(" "),r("tr",[t._m(18),t._v(" "),r("td",[r("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[t._v("String"),r("OutboundLink")],1)]),t._v(" "),r("td",[r("Fa-Times")],1),t._v(" "),r("td",[t._v("N/A")]),t._v(" "),r("td",[t._v("The body of the debug log enty")])])])]),t._v(" "),r("ReturnValue",{attrs:{"return-type":"void","return-type-url":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/void","return-help":"Calling this method returns nothing.",tail:"true"}}),t._v(" "),r("CodeExample"),t._v(" "),t._m(19)],1),t._v(" "),r("hr",{staticClass:"method-divider"}),t._v(" "),r("h3",{attrs:{id:"command-body"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#command-body"}},[t._v("#")]),t._v(" command(body) "),r("Badge",{attrs:{text:"Static",type:"chariot"}})],1),t._v(" "),r("Method",{attrs:{"method-description":"Log something related to command usage. Date and Title components get logged in bold green."}}),t._v(" "),r("div",{staticClass:"table-methods"},[r("table",[t._m(20),t._v(" "),r("tbody",[r("tr",[t._m(21),t._v(" "),r("td",[r("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[t._v("String"),r("OutboundLink")],1)]),t._v(" "),r("td",[r("Fa-Times")],1),t._v(" "),r("td",[t._v("N/A")]),t._v(" "),r("td",[t._v("The body of the log enty")])])])]),t._v(" "),r("ReturnValue",{attrs:{"return-type":"void","return-type-url":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/void","return-help":"Calling this method returns nothing.",tail:"true"}}),t._v(" "),r("CodeExample"),t._v(" "),t._m(22)],1),t._v(" "),r("hr",{staticClass:"method-divider"}),t._v(" "),r("h3",{attrs:{id:"event-body"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#event-body"}},[t._v("#")]),t._v(" event(body) "),r("Badge",{attrs:{text:"Static",type:"chariot"}})],1),t._v(" "),r("Method",{attrs:{"method-description":"Log something related to a Discord event. Date and Title components get logged in bold orange."}}),t._v(" "),r("div",{staticClass:"table-methods"},[r("table",[t._m(23),t._v(" "),r("tbody",[r("tr",[t._m(24),t._v(" "),r("td",[r("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[t._v("String"),r("OutboundLink")],1)]),t._v(" "),r("td",[r("Fa-Times")],1),t._v(" "),r("td",[t._v("N/A")]),t._v(" "),r("td",[t._v("The body of the log enty")])])])]),t._v(" "),r("ReturnValue",{attrs:{"return-type":"void","return-type-url":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/void","return-help":"Calling this method returns nothing.",tail:"true"}}),t._v(" "),r("CodeExample"),t._v(" "),t._m(25)],1)],1)])}),[function(){var t=this.$createElement,e=this._self._c||t;return e("h1",{attrs:{id:"logger"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#logger"}},[this._v("#")]),this._v(" Logger")])},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("The "),e("a",{attrs:{href:"#"}},[this._v("Chariot.Logger")]),this._v(" class only exposes static methods. An object instantiation isn't required.")])},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")])},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("title")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("code",[this._v("body")])])},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("div",{staticClass:"language-js extra-class"},[r("pre",{pre:!0,attrs:{class:"language-js"}},[r("code",[t._v("Logger"),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("success")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'SUCCESS Example'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'An example was successful!'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/* ⇨ [ 16.09.2019 12:34:56 ] [ SUCCESS Example ] An example was successful! */")]),t._v("\n")])])])},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("title")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("code",[this._v("body")])])},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("div",{staticClass:"language-js extra-class"},[r("pre",{pre:!0,attrs:{class:"language-js"}},[r("code",[t._v("Logger"),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("warning")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'WARNING Example'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'This is a warning!'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/* ⇨ [ 16.09.2019 12:34:56 ] [ WARNING Example ] This is a warning! */")]),t._v("\n")])])])},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("title")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("code",[this._v("body")])])},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("div",{staticClass:"language-js extra-class"},[r("pre",{pre:!0,attrs:{class:"language-js"}},[r("code",[t._v("Logger"),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("error")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ERROR Example'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'An example was unsuccessful!'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/* ⇨ [ 16.09.2019 12:34:56 ] [ ERROR Example ] An example was unsuccessful! */")]),t._v("\n")])])])},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("title")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("code",[this._v("body")])])},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("div",{staticClass:"language-js extra-class"},[r("pre",{pre:!0,attrs:{class:"language-js"}},[r("code",[t._v("Logger"),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("debug")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'DEBUG Example'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'This is a debug log!'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/* ⇨ [ 16.09.2019 12:34:56 ] [ DEBUG Example ] This is a debug log! */")]),t._v("\n")])])])},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("body")])])},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("div",{staticClass:"language-js extra-class"},[r("pre",{pre:!0,attrs:{class:"language-js"}},[r("code",[t._v("Logger"),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("command")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Someone used the help command!'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/* ⇨ [ 16.09.2019 12:34:56 ] [ COMMAND ] Someone used the help command! */")]),t._v("\n")])])])},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("body")])])},function(){var t=this,e=t.$createElement,r=t._self._c||e;return r("div",{staticClass:"language-js extra-class"},[r("pre",{pre:!0,attrs:{class:"language-js"}},[r("code",[t._v("Logger"),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("event")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),r("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Joined a new guild!'")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),r("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),r("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/* ⇨ [ 16.09.2019 12:34:56 ] [ EVENT ] Joined a new guild! */")]),t._v("\n")])])])}],!1,null,null,null);e.default=s.exports}}]);