Simplified doc-site generation
[AGL/documentation.git] / docs / 4_APIs_and_Services / 4.4_AGL_Test_Framework / 5_Reference / 4_LuaUnit_Assertion_Functions / 5_Type_Assertions.md
diff --git a/docs/4_APIs_and_Services/4.4_AGL_Test_Framework/5_Reference/4_LuaUnit_Assertion_Functions/5_Type_Assertions.md b/docs/4_APIs_and_Services/4.4_AGL_Test_Framework/5_Reference/4_LuaUnit_Assertion_Functions/5_Type_Assertions.md
new file mode 100644 (file)
index 0000000..7e49d85
--- /dev/null
@@ -0,0 +1,47 @@
+---
+edit_link: ''
+title: Type Assertions
+origin_url: >-
+  https://git.automotivelinux.org/apps/app-afb-test/plain/docs/Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md?h=master
+---
+
+<!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/apis_services/master/app-afb-test-developer-guides-api-services-book.yml -->
+
+# 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