gabarito: gabarito.Gabarito

Adds a test within the gabarito.

The test is an object containing various methods. Each method is treated as a test clause. Every draft is run to check if it works.

• test <Object>

  The test itself

Creates a custom matcher using the function as a matching criteria.

The function will receive a value to examinate and should return a boolean indicating whether the criteria is met.

• fn <Function>

  The matcher function

Matcher for varargs

• fn <Function>
• [msg] <String>

  The optional message format

Just like the grabber matcher, this matcher that always passes. It stores the values passed to the matcher for further inspection later on.

It works as a varargs matcher.

Returns a matcher that always passes. This matcher stores the value passed to the matcher for further inspection later on.

Matcher for a given type

• type <Function>
• [msg] <String>

  The optional message format

Literal value matcher

If given value is an object (not a function) or an array, it uses parts.equals, otherwise it will check for it's identity

• v <Mixed>
• [msg] <String>

Tells gabarito to send a message. Messages wont be shown on the console output, they are useful for sending specific messages to the reporters.

• args <Mixed> (*..n)

Register an event listener for a given event.

Available events:

• init: The initialization of the gabarito verification.
• begin: The beginning of a test verification.
• enter: When gabarito is about to enter into a clause verification.
• pass: Whenever a clause passes.
• fail: Whenever a clause fails.
• end: When a test verification has ended.
• complete: When all the test verifications have completed.
• say: Custom event to emit whatever message.

• event <String>
• listener <Function>

Resets the gabarito to it's initial state, removing all listeners as well.

Tells gabarito to say something.

• args <Mixed> (*..n)

Creates an instance of gabarito.Spy

• fn <Function>

  Function to spy on

Adds a test using the gabarito.TestBuilder within gabarito.

• [name] <String>

  The test's name

Verify all tests

• [done] <Function>