neft

> [Wiki](Home) ▸ [[API Reference|API-Reference]] ▸ **Assertions** # Assertions Access it with: ```javascript const { assert } = Neft; ``` > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee) ## Table of contents * [Assertions](#assertions) * [assert](#assert) * [**Class** assert.AssertionError](#class-assertassertionerror) * [scope](#scope) * [ok](#ok) * [notOk](#notok) * [is](#is) * [isNot](#isnot) * [isDefined](#isdefined) * [isNotDefined](#isnotdefined) * [isPrimitive](#isprimitive) * [isNotPrimitive](#isnotprimitive) * [isString](#isstring) * [isNotString](#isnotstring) * [isFloat](#isfloat) * [isNotFloat](#isnotfloat) * [isInteger](#isinteger) * [isNotInteger](#isnotinteger) * [isBoolean](#isboolean) * [isNotBoolean](#isnotboolean) * [isFunction](#isfunction) * [isNotFunction](#isnotfunction) * [isObject](#isobject) * [isNotObject](#isnotobject) * [isPlainObject](#isplainobject) * [isNotPlainObject](#isnotplainobject) * [isArray](#isarray) * [isNotArray](#isnotarray) * [isEqual](#isequal) * [isNotEqual](#isnotequal) * [instanceOf](#instanceof) * [notInstanceOf](#notinstanceof) * [lengthOf](#lengthof) * [notLengthOf](#notlengthof) * [operator](#operator) * [match](#match) * [notMatch](#notmatch) * [Glossary](#glossary) #assert <dl><dt>Syntax</dt><dd><code>assert(*Boolean* expression, [*String* message])</code></dd><dt>Parameters</dt><dd><ul><li>expression — Boolean</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertboolean-expression-string-message) ##**Class** assert.AssertionError <dl><dt>Syntax</dt><dd><code>**Class** assert.AssertionError()</code></dd></dl> Access it with: ```javascript const { AssertionError } = Neft.assert; ``` > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#class-assertassertionerror) ##scope <dl><dt>Syntax</dt><dd><code>*assert* assert.scope(*String* message)</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>message — String</li></ul></dd><dt>Returns</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd></dl> All fail messages will be prefixed by the given *message*. > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assert-assertscopestring-message) ##ok <dl><dt>Syntax</dt><dd><code>assert.ok(*Boolean* expression, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>expression — Boolean</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertokboolean-expression-string-message) ##notOk <dl><dt>Syntax</dt><dd><code>assert.notOk(*Boolean* expression, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>expression — Boolean</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertnotokboolean-expression-string-message) ##is <dl><dt>Syntax</dt><dd><code>assert.is(*Any* actual, *Any* expected, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>actual — Any</li><li>expected — Any</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisany-actual-any-expected-string-message) ##isNot <dl><dt>Syntax</dt><dd><code>assert.isNot(*Any* actual, *Any* expected, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>actual — Any</li><li>expected — Any</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotany-actual-any-expected-string-message) ##isDefined <dl><dt>Syntax</dt><dd><code>assert.isDefined(*Any* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Any</li><li>message — String — optional</li></ul></dd></dl> Checks whether the given value is an undefined or a null. > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisdefinedany-value-string-message) ##isNotDefined <dl><dt>Syntax</dt><dd><code>assert.isNotDefined(*Any* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Any</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotdefinedany-value-string-message) ##isPrimitive <dl><dt>Syntax</dt><dd><code>assert.isPrimitive(*Any* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Any</li><li>message — String — optional</li></ul></dd></dl> Check *utils.isPrimitive()* for more details. > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisprimitiveany-value-string-message) ##isNotPrimitive <dl><dt>Syntax</dt><dd><code>assert.isNotPrimitive(*Any* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Any</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotprimitiveany-value-string-message) ##isString <dl><dt>Syntax</dt><dd><code>assert.isString(*String* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — String</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisstringstring-value-string-message) ##isNotString <dl><dt>Syntax</dt><dd><code>assert.isNotString(*Any* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Any</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotstringany-value-string-message) ##isFloat <dl><dt>Syntax</dt><dd><code>assert.isFloat(*Float* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — <a href="/Neft-io/neft/wiki/Utils-API#isfloat">Float</a></li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisfloatfloat-value-string-message) ##isNotFloat <dl><dt>Syntax</dt><dd><code>assert.isNotFloat(*Any* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Any</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotfloatany-value-string-message) ##isInteger <dl><dt>Syntax</dt><dd><code>assert.isInteger(*Integer* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — <a href="/Neft-io/neft/wiki/Utils-API#isinteger">Integer</a></li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisintegerinteger-value-string-message) ##isNotInteger <dl><dt>Syntax</dt><dd><code>assert.isNotInteger(*Any* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Any</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotintegerany-value-string-message) ##isBoolean <dl><dt>Syntax</dt><dd><code>assert.isBoolean(*Boolean* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Boolean</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisbooleanboolean-value-string-message) ##isNotBoolean <dl><dt>Syntax</dt><dd><code>assert.isNotBoolean(*Any* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Any</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotbooleanany-value-string-message) ##isFunction <dl><dt>Syntax</dt><dd><code>assert.isFunction(*Function* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Function</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisfunctionfunction-value-string-message) ##isNotFunction <dl><dt>Syntax</dt><dd><code>assert.isNotFunction(*Any* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Any</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotfunctionany-value-string-message) ##isObject <dl><dt>Syntax</dt><dd><code>assert.isObject(*Object* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — <a href="/Neft-io/neft/wiki/Utils-API#isobject">Object</a></li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisobjectobject-value-string-message) ##isNotObject <dl><dt>Syntax</dt><dd><code>assert.isNotObject(*Any* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Any</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotobjectany-value-string-message) ##isPlainObject <dl><dt>Syntax</dt><dd><code>assert.isPlainObject(*PlainObject* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — <a href="/Neft-io/neft/wiki/Utils-API#isplainobject">PlainObject</a></li><li>message — String — optional</li></ul></dd></dl> Check *utils.isPlainObject()* for more details. > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisplainobjectplainobject-value-string-message) ##isNotPlainObject <dl><dt>Syntax</dt><dd><code>assert.isNotPlainObject(*Any* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Any</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotplainobjectany-value-string-message) ##isArray <dl><dt>Syntax</dt><dd><code>assert.isArray(*Array* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Array</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisarrayarray-value-string-message) ##isNotArray <dl><dt>Syntax</dt><dd><code>assert.isNotArray(*Any* value, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Any</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotarrayany-value-string-message) ##isEqual <dl><dt>Syntax</dt><dd><code>assert.isEqual(*Any* value1, *Any* value2, [*String* message, *Object* options])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value1 — Any</li><li>value2 — Any</li><li>message — String — optional</li><li>options — <a href="/Neft-io/neft/wiki/Utils-API#isobject">Object</a> — optional</li></ul></dd></dl> Check *utils.isEqual()* for more details. The given options object accepts: [Integer](/Neft-io/neft/wiki/Utils-API#isinteger) maxDeep. > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisequalany-value1-any-value2-string-message-object-options) ##isNotEqual <dl><dt>Syntax</dt><dd><code>assert.isNotEqual(*Any* value1, *Any* value2, [*String* message, *Object* options])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value1 — Any</li><li>value2 — Any</li><li>message — String — optional</li><li>options — <a href="/Neft-io/neft/wiki/Utils-API#isobject">Object</a> — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotequalany-value1-any-value2-string-message-object-options) ##instanceOf <dl><dt>Syntax</dt><dd><code>assert.instanceOf(*Object* object, *Function* constructor, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>object — <a href="/Neft-io/neft/wiki/Utils-API#isobject">Object</a></li><li>constructor — Function</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertinstanceofobject-object-function-constructor-string-message) ##notInstanceOf <dl><dt>Syntax</dt><dd><code>assert.notInstanceOf(*Any* object, *Function* constructor, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>object — Any</li><li>constructor — Function</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertnotinstanceofany-object-function-constructor-string-message) ##lengthOf <dl><dt>Syntax</dt><dd><code>assert.lengthOf(*Any* value, *Integer* length, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Any</li><li>length — <a href="/Neft-io/neft/wiki/Utils-API#isinteger">Integer</a></li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertlengthofany-value-integer-length-string-message) ##notLengthOf <dl><dt>Syntax</dt><dd><code>assert.notLengthOf(*Any* value, *Integer* length, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Any</li><li>length — <a href="/Neft-io/neft/wiki/Utils-API#isinteger">Integer</a></li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertnotlengthofany-value-integer-length-string-message) ##operator <dl><dt>Syntax</dt><dd><code>assert.operator(*Any* value1, *String* operator, *Any* value2, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value1 — Any</li><li>operator — String</li><li>value2 — Any</li><li>message — String — optional</li></ul></dd></dl> Used to compare the two given values. ```javascript assert.operator(2, '>', 1); ``` > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertoperatorany-value1-string-operator-any-value2-string-message) ##match <dl><dt>Syntax</dt><dd><code>assert.match(*Any* value, *RegExp* regexp, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Any</li><li>regexp — RegExp</li><li>message — String — optional</li></ul></dd></dl> Used to check whether the given value tests the given regexp. ```javascript assert.match('12', /[0-9]+/); ``` > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertmatchany-value-regexp-regexp-string-message) ##notMatch <dl><dt>Syntax</dt><dd><code>assert.notMatch(*Any* value, *RegExp* regexp, [*String* message])</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Assert-API#assert">assert</a></dd><dt>Parameters</dt><dd><ul><li>value — Any</li><li>regexp — RegExp</li><li>message — String — optional</li></ul></dd></dl> > [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertnotmatchany-value-regexp-regexp-string-message) # Glossary - [assert](#assert)