1 line
6.0 KiB
JavaScript
1 line
6.0 KiB
JavaScript
(window.webpackJsonp=window.webpackJsonp||[]).push([[187],{398:function(t,s,a){"use strict";a.r(s);var e=a(37),n=Object(e.a)({},function(){var t=this,s=t.$createElement,a=t._self._c||s;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#functions","aria-hidden":"true"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),a("p",[a("a",{attrs:{id:"assert"}})]),t._v(" "),a("h2",{attrs:{id:"assert"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#assert","aria-hidden":"true"}},[t._v("#")]),t._v(" assert")]),t._v(" "),a("p",[t._v("▸ "),a("strong",[t._v("assert")]),t._v("<"),a("code",[t._v("T")]),t._v(">(test: "),a("em",[a("code",[t._v("Falsy")]),t._v(" | "),a("code",[t._v("T")])]),t._v(", message: "),a("em",[a("code",[t._v("string")]),t._v(" | "),a("code",[t._v("MessageFn")])]),t._v(", code?: "),a("em",[a("code",[t._v("number")])]),t._v(", data?: "),a("em",[a("code",[t._v("any")])]),t._v("): "),a("code",[t._v("boolean")])]),t._v(" "),a("p",[a("em",[t._v("Defined in "),a("a",{attrs:{href:"https://github.com/polkadot-js/common/blob/db4b221/packages/util/src/assert.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("assert.ts:28"),a("OutboundLink")],1)])]),t._v(" "),a("p",[a("em",[a("strong",[t._v("name")])]),t._v(": assert")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("summary")])]),t._v(": Checks for a valid test, if not ExtError is thrown.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("description")])]),t._v(": Checks that "),a("code",[t._v("test")]),t._v(" is a truthy value. If value is falsy ("),a("code",[t._v("null")]),t._v(", "),a("code",[t._v("undefined")]),t._v(", "),a("code",[t._v("false")]),t._v(", ...), it throws an ExtError with the supplied "),a("code",[t._v("message")]),t._v(" and an optional "),a("code",[t._v("code")]),t._v(" and "),a("code",[t._v("data")]),t._v(". When "),a("code",[t._v("test")]),t._v(" passes, "),a("code",[t._v("true")]),t._v(" is returned.")]),t._v(" "),a("p",[a("em",[a("strong",[t._v("example")])]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript line-numbers-mode"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" assert "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@polkadot/util'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("assert")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'True should be true'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// true returned")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("assert")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'False should not be true'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ExtError thrown")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("assert")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'message'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ExtError with 'message'")]),t._v("\n")])]),t._v(" "),a("div",{staticClass:"line-numbers-wrapper"},[a("span",{staticClass:"line-number"},[t._v("1")]),a("br"),a("span",{staticClass:"line-number"},[t._v("2")]),a("br"),a("span",{staticClass:"line-number"},[t._v("3")]),a("br"),a("span",{staticClass:"line-number"},[t._v("4")]),a("br"),a("span",{staticClass:"line-number"},[t._v("5")]),a("br")])]),a("p",[a("strong",[t._v("Type parameters:")])]),t._v(" "),a("h4",{attrs:{id:"t"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#t","aria-hidden":"true"}},[t._v("#")]),t._v(" T")]),t._v(" "),a("p",[a("strong",[t._v("Parameters:")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("test")]),t._v(" "),a("td",[a("code",[t._v("Falsy")]),t._v(" | "),a("code",[t._v("T")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[t._v("message")]),t._v(" "),a("td",[a("code",[t._v("string")]),t._v(" | "),a("code",[t._v("MessageFn")])]),t._v(" "),a("td",[t._v("-")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Default value")]),t._v(" code")]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("ExtError.CODES.ASSERT")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("Optional")]),t._v(" data")]),t._v(" "),a("td",[a("code",[t._v("any")])]),t._v(" "),a("td",[t._v("-")])])])]),t._v(" "),a("p",[a("strong",[t._v("Returns:")]),t._v(" "),a("code",[t._v("boolean")])]),t._v(" "),a("hr")])},[],!1,null,null,null);s.default=n.exports}}]); |