> [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
- Syntax
assert(*Boolean* expression, [*String* message])- Parameters
- expression — Boolean
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertboolean-expression-string-message)
##**Class** assert.AssertionError
- Syntax
**Class** assert.AssertionError()
Access it with:
```javascript
const { AssertionError } = Neft.assert;
```
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#class-assertassertionerror)
##scope
- Syntax
*assert* assert.scope(*String* message)- Static method of
- assert
- Parameters
- Returns
- assert
All fail messages will be prefixed by the given *message*.
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assert-assertscopestring-message)
##ok
- Syntax
assert.ok(*Boolean* expression, [*String* message])- Static method of
- assert
- Parameters
- expression — Boolean
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertokboolean-expression-string-message)
##notOk
- Syntax
assert.notOk(*Boolean* expression, [*String* message])- Static method of
- assert
- Parameters
- expression — Boolean
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertnotokboolean-expression-string-message)
##is
- Syntax
assert.is(*Any* actual, *Any* expected, [*String* message])- Static method of
- assert
- Parameters
- actual — Any
- expected — Any
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisany-actual-any-expected-string-message)
##isNot
- Syntax
assert.isNot(*Any* actual, *Any* expected, [*String* message])- Static method of
- assert
- Parameters
- actual — Any
- expected — Any
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotany-actual-any-expected-string-message)
##isDefined
- Syntax
assert.isDefined(*Any* value, [*String* message])- Static method of
- assert
- Parameters
- value — Any
- message — String — optional
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
- Syntax
assert.isNotDefined(*Any* value, [*String* message])- Static method of
- assert
- Parameters
- value — Any
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotdefinedany-value-string-message)
##isPrimitive
- Syntax
assert.isPrimitive(*Any* value, [*String* message])- Static method of
- assert
- Parameters
- value — Any
- message — String — optional
Check *utils.isPrimitive()* for more details.
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisprimitiveany-value-string-message)
##isNotPrimitive
- Syntax
assert.isNotPrimitive(*Any* value, [*String* message])- Static method of
- assert
- Parameters
- value — Any
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotprimitiveany-value-string-message)
##isString
- Syntax
assert.isString(*String* value, [*String* message])- Static method of
- assert
- Parameters
- value — String
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisstringstring-value-string-message)
##isNotString
- Syntax
assert.isNotString(*Any* value, [*String* message])- Static method of
- assert
- Parameters
- value — Any
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotstringany-value-string-message)
##isFloat
- Syntax
assert.isFloat(*Float* value, [*String* message])- Static method of
- assert
- Parameters
- value — Float
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisfloatfloat-value-string-message)
##isNotFloat
- Syntax
assert.isNotFloat(*Any* value, [*String* message])- Static method of
- assert
- Parameters
- value — Any
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotfloatany-value-string-message)
##isInteger
- Syntax
assert.isInteger(*Integer* value, [*String* message])- Static method of
- assert
- Parameters
- value — Integer
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisintegerinteger-value-string-message)
##isNotInteger
- Syntax
assert.isNotInteger(*Any* value, [*String* message])- Static method of
- assert
- Parameters
- value — Any
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotintegerany-value-string-message)
##isBoolean
- Syntax
assert.isBoolean(*Boolean* value, [*String* message])- Static method of
- assert
- Parameters
- value — Boolean
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisbooleanboolean-value-string-message)
##isNotBoolean
- Syntax
assert.isNotBoolean(*Any* value, [*String* message])- Static method of
- assert
- Parameters
- value — Any
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotbooleanany-value-string-message)
##isFunction
- Syntax
assert.isFunction(*Function* value, [*String* message])- Static method of
- assert
- Parameters
- value — Function
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisfunctionfunction-value-string-message)
##isNotFunction
- Syntax
assert.isNotFunction(*Any* value, [*String* message])- Static method of
- assert
- Parameters
- value — Any
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotfunctionany-value-string-message)
##isObject
- Syntax
assert.isObject(*Object* value, [*String* message])- Static method of
- assert
- Parameters
- value — Object
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisobjectobject-value-string-message)
##isNotObject
- Syntax
assert.isNotObject(*Any* value, [*String* message])- Static method of
- assert
- Parameters
- value — Any
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotobjectany-value-string-message)
##isPlainObject
- Syntax
assert.isPlainObject(*PlainObject* value, [*String* message])- Static method of
- assert
- Parameters
Check *utils.isPlainObject()* for more details.
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisplainobjectplainobject-value-string-message)
##isNotPlainObject
- Syntax
assert.isNotPlainObject(*Any* value, [*String* message])- Static method of
- assert
- Parameters
- value — Any
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotplainobjectany-value-string-message)
##isArray
- Syntax
assert.isArray(*Array* value, [*String* message])- Static method of
- assert
- Parameters
- value — Array
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisarrayarray-value-string-message)
##isNotArray
- Syntax
assert.isNotArray(*Any* value, [*String* message])- Static method of
- assert
- Parameters
- value — Any
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotarrayany-value-string-message)
##isEqual
- Syntax
assert.isEqual(*Any* value1, *Any* value2, [*String* message, *Object* options])- Static method of
- assert
- Parameters
- value1 — Any
- value2 — Any
- message — String — optional
- options — Object — optional
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
- Syntax
assert.isNotEqual(*Any* value1, *Any* value2, [*String* message, *Object* options])- Static method of
- assert
- Parameters
- value1 — Any
- value2 — Any
- message — String — optional
- options — Object — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertisnotequalany-value1-any-value2-string-message-object-options)
##instanceOf
- Syntax
assert.instanceOf(*Object* object, *Function* constructor, [*String* message])- Static method of
- assert
- Parameters
- object — Object
- constructor — Function
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertinstanceofobject-object-function-constructor-string-message)
##notInstanceOf
- Syntax
assert.notInstanceOf(*Any* object, *Function* constructor, [*String* message])- Static method of
- assert
- Parameters
- object — Any
- constructor — Function
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertnotinstanceofany-object-function-constructor-string-message)
##lengthOf
- Syntax
assert.lengthOf(*Any* value, *Integer* length, [*String* message])- Static method of
- assert
- Parameters
- value — Any
- length — Integer
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertlengthofany-value-integer-length-string-message)
##notLengthOf
- Syntax
assert.notLengthOf(*Any* value, *Integer* length, [*String* message])- Static method of
- assert
- Parameters
- value — Any
- length — Integer
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertnotlengthofany-value-integer-length-string-message)
##operator
- Syntax
assert.operator(*Any* value1, *String* operator, *Any* value2, [*String* message])- Static method of
- assert
- Parameters
- value1 — Any
- operator — String
- value2 — Any
- message — String — optional
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
- Syntax
assert.match(*Any* value, *RegExp* regexp, [*String* message])- Static method of
- assert
- Parameters
- value — Any
- regexp — RegExp
- message — String — optional
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
- Syntax
assert.notMatch(*Any* value, *RegExp* regexp, [*String* message])- Static method of
- assert
- Parameters
- value — Any
- regexp — RegExp
- message — String — optional
> [`Source`](/Neft-io/neft/blob/e79ebc2b61607e795a53c22d1577605addf00689/src/assert/index.litcoffee#assertnotmatchany-value-regexp-regexp-string-message)
# Glossary
- [assert](#assert)