Skip to content

armgit / mocha

Public Imported from GitHub
0

☕️ Classic, reliable, trusted test framework for Node.js and the browser

Documented 'require' interface

Raynos (Jake Verbaten)370ae0bf2c91
diff --git a/index.md b/index.md
index ce9f57cf..e3b537b1 100644
--- a/index.md
+++ b/index.md
@@ -433,6 +433,29 @@ Testing asynchronous code with Mocha could not be simpler! Simply invoke the cal
ok('foo'.length == 3);
});
+<h3 id="require-interface">Require</h3>
+
+The `require` interface allows you to require the `describe` and friend words
+ directly using `require` and call them whatever you want. This interface
+ is also useful if you want to avoid global variables in your tests.
+
+ var testCase = require('mocha').describe
+ var pre = require('mocha').before
+ var assertions = require('mocha').assertions
+ var assert = require('assert')
+
+ testCase('Array', function(){
+ pre(function(){
+ // ...
+ });
+
+ testCase('#indexOf()', function(){
+ assertions('should return -1 when not present', function(){
+ assert.equal([1,2,3].indexOf(4), -1);
+ });
+ });
+ });
+
<h2 id="reporters">Reporters</h2>
Mocha reporters adjust to the terminal window,