diff options
author | Romain Forlot <romain.forlot@iot.bzh> | 2018-10-29 18:37:26 +0100 |
---|---|---|
committer | Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2018-10-31 21:03:06 +0000 |
commit | 2f3654275e44f9719818a848da9a0b576d5a1b53 (patch) | |
tree | ff75764bbb2e3037f73f95a96ac5ed2fcba93465 /docs/Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md | |
parent | 2a7b4defe300dfe5eb19f775bd819e2d300b7453 (diff) |
Docs reorganization and update
Docs reorganization and update using the latest afb-test improvments and
try to make it clearer.
Change-Id: If022cdb46364ef250361bdcd420d45b360f10a2e
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs/Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md')
-rw-r--r-- | docs/Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md b/docs/Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md new file mode 100644 index 0000000..843f651 --- /dev/null +++ b/docs/Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md @@ -0,0 +1,38 @@ +# Type assertions + +The following functions all perform type checking on their argument. If the +received value is not of the right type, the failure message will contain the +expected type, the received type and the received value to help you identify +better the problem. + +* **_AFT.assertIsNumber(value)** + + Assert that the argument is a number (integer or float) + +* **_AFT.assertIsString(value)** + + Assert that the argument is a string. + +* **_AFT.assertIsTable(value)** + + Assert that the argument is a table. + +* **_AFT.assertIsBoolean(value)** + + Assert that the argument is a boolean. + +* **_AFT.assertIsFunction(value)** + + Assert that the argument is a function. + +* **_AFT.assertIsUserdata(value)** + + Assert that the argument is a userdata. + +* **_AFT.assertIsThread(value)** + + Assert that the argument is a coroutine (an object with type thread ). + +* **_AFT.assertNotIsThread(value)** + + Assert that the argument is a not coroutine (an object with type thread ).
\ No newline at end of file |