tiny-assert
v0.1.0
Published
TinyAssert is very simple and lightweight assertion library
Downloads
31
Readme
Tiny Assert
TinyAssert is simple and lightweight assertion library.
API
assert.ok()
(value:Boolean, msg?:String) -> void
Throw if value
is not truly. Using msg
as assertion error message.
value == true
assert.notOk()
(value:Boolean, msg?:String) -> void
Throw if value
is truthy. Using msg
as assertion error message text.
value != true
Check if a
non-strictly doesn't equal b
.
assert.equal()
(a:*, b:*, msg?:String) -> void
Check if a
strictly equals b
.
a === b
assert.notEqual()
(a:*, b:*[, msg:String]) -> void
Check if a
doesn't strictly equal b
.
a !== b
assert.oneOf()
(a:*, b:Array<*>, msg?:String) -> void
Check if a
is presented in a list b
.
b.indexOf(a) > -1
assert.notOneOf()
(a:*, b:Array<*>, msg?:String) -> void
Check if a
isn't presented in list b
b.indexOf(a) < 0
assert.match()
(a:*, b:Object, msg?:String) -> void
Check if properties of b
be strictly equal to properties of a
.
a[k] === b[k]
assert.notMatch()
(a:*, b:Object, msg?:String) -> void
Check if properties of b
be strictly equal to properties of a
.
a[k] !== b[k]
assert.fail()
(msg:String) -> void
Throws assert exception with msg
as a text.
assert.throws()
(fn:() -> *, error: String|Error|Object, msg?:String) -> void
Check if function throws an assertion of defined shape. If error
is
a string, then error.toString() value will be compared against the string. If it's an Error constructor, then instanceof
check will be performed. If it's an Object, then each property of error
will be checked to equality to actual error properties.
assert.doesNotThrow()
(fn:() -> *, error: String|Error|Object, msg?:String) -> void
Performs the same checks as assert.throws
but expects all comparisons to return false
.
assert.rejects()
(fn:() -> Promise<*,Error>, error: String|Error|Object, msg?:String) -> void
Same as assert.throws
but for promises.
assert.doesNotReject()
(fn:() -> Promise<*,Error>, error: String|Error|Object, msg?:String) -> void
Same as assert.doesNotThrow
but for promises.
License
MIT © Rumkin