summaryrefslogtreecommitdiffstats
path: root/testing/docs/assert.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 17:32:43 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 17:32:43 +0000
commit6bf0a5cb5034a7e684dcc3500e841785237ce2dd (patch)
treea68f146d7fa01f0134297619fbe7e33db084e0aa /testing/docs/assert.rst
parentInitial commit. (diff)
downloadthunderbird-6bf0a5cb5034a7e684dcc3500e841785237ce2dd.tar.xz
thunderbird-6bf0a5cb5034a7e684dcc3500e841785237ce2dd.zip
Adding upstream version 1:115.7.0.upstream/1%115.7.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'testing/docs/assert.rst')
-rw-r--r--testing/docs/assert.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/testing/docs/assert.rst b/testing/docs/assert.rst
new file mode 100644
index 0000000000..4957efb568
--- /dev/null
+++ b/testing/docs/assert.rst
@@ -0,0 +1,17 @@
+Assert module
+=============
+
+For XPCShell tests and mochitests, ``Assert`` is already present as an
+instantiated global to which you can refer - you don't need to construct it
+yourself. You can immediately start using ``Assert.ok`` and similar methods as
+test assertions.
+
+The full class documentation follows, but it is perhaps worth noting that this
+API is largely identical to
+`NodeJS' assert module <https://nodejs.org/api/assert.html>`_, with some
+omissions/changes including strict mode and string matching.
+
+.. js:autoclass:: Assert
+ :members: ok, equal, notEqual, strictEqual, notStrictEqual, deepEqual, notDeepEqual,
+ greater, less, greaterOrEqual, lessOrEqual, stringContains, stringMatches,
+ throws, rejects, *