summaryrefslogtreecommitdiffstats
path: root/docs/WriteYourTests/Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md
diff options
context:
space:
mode:
authorCorentin Le Gall <corentinlgs@gmail.com>2018-07-19 15:57:30 +0200
committerCorentin Le Gall <corentinlgs@gmail.com>2018-07-24 14:42:12 +0200
commitc96df58a88b60c7501b3c8a758c0277c17088371 (patch)
tree1e982c565a4fd0ba65a382cc1cba97efe891c34b /docs/WriteYourTests/Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md
parent55673d50338f041763e6e38f38ea3fc311f2bdc1 (diff)
Changed doc to GitBook format + added doc
-Changed README.md to a complet GitBook doc. -Added explanations about EvtGrpReceived functions. -Corrected mistakes + reduced lines length. Change-Id: I1a077ddf6acb520a9158de658d3c09b12a2029d4 Signed-off-by: Corentin Le Gall <corentinlgs@gmail.com>
Diffstat (limited to 'docs/WriteYourTests/Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md')
-rw-r--r--docs/WriteYourTests/Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/WriteYourTests/Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md b/docs/WriteYourTests/Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md
new file mode 100644
index 0000000..843f651
--- /dev/null
+++ b/docs/WriteYourTests/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