Home

Classes

  • Hook
    • error
  • Mocha
    • addFile
    • allowUncaught
    • asyncOnly
    • bail
    • checkLeaks
    • color
    • delay
    • diff
    • enableTimeouts
    • fgrep
    • forbidOnly
    • forbidPending
    • fullTrace
    • global
    • grep
    • growl
    • hideDiff
    • ignoreLeaks
    • inlineDiffs
    • invert
    • noHighlighting
    • reporter
    • retries
    • run
    • slow
    • timeout
    • ui
    • unloadFiles
    • useColors
    • useInlineDiffs
  • Base
    • exports.list
  • Doc
  • Dot
  • HTML
    • addCodeToggle
    • suiteURL
    • testURL
  • JSON
  • JSONStream
  • Landing
  • List
  • Markdown
  • Min
  • Nyan
  • Progress
  • Spec
  • TAP
  • XUnit
    • done
    • test
    • write
  • utils
    • exports.lookupFiles
  • Runnable
  • Runner
    • abort
    • globals
    • grep
    • grepTotal
    • run
  • Suite
    • create
    • fullTitle
    • titlePath
    • total
  • Test

Modules

  • Base
  • Context
  • Doc
  • Dot
  • Errors
    • createInvalidArgumentTypeError
    • createInvalidArgumentValueError
    • createInvalidExceptionError
    • createInvalidInterfaceError
    • createInvalidReporterError
    • createMissingArgumentError
    • createNoFilesMatchPatternError
    • createUnsupportedError
  • Growl
    • isCapable
    • isCapable
    • notify
    • notify
  • HTML
    • error
    • fragment
    • hideSuitesWithout
    • makeUrl
    • on
    • text
    • unhide
  • JSON
  • JSONStream
  • Landing
  • lib/cli/options
    • loadMochaOpts
    • loadOptions
    • loadPkgRc
    • loadRc
  • lib/stats-collector
  • List
  • Markdown
  • Min
  • Nyan
    • write
  • Progress
  • Spec
  • TAP
  • utils
    • clamp
    • clean
    • createMap
    • defineConstants
    • isPromise
    • noop
    • stackTraceFilter
  • XUnit
    • tag

Externals

  • EventEmitter
  • yargsParser

Tutorials

  • Create a Custom Reporter

Interfaces

  • Arguments

Global

  • after
  • afterEach
  • before
  • beforeEach
  • Date
  • EventEmitter
  • globals
  • Pending
  • Progress
  • runWithSuite
  • util

Mocha's API Documentation


Congratulations! You've found Mocha's API documentation. These docs are for developers who wish to:

  • Create an extension for Mocha, or
  • Develop Mocha itself, or
  • Do something else fancy with Mocha

Otherwise, you probably want the main documentation.

Other Links

  • Main Documentation
  • Release Notes / History / Changes
  • Code of Conduct
  • Gitter Chatroom (ask questions here!)
  • Google Group
  • Issue Tracker

Documentation generated by JSDoc 3.6.3 using the @mocha/docdash theme.