Home

Classes

  • Hook
    • error
    • reset
  • Mocha
    • addFile
    • allowUncaught
    • asyncOnly
    • bail
    • checkLeaks
    • cleanReferencesAfterRun
    • color
    • delay
    • diff
    • dispose
    • enableGlobalSetup
    • enableGlobalTeardown
    • fgrep
    • forbidOnly
    • forbidPending
    • fullTrace
    • global
    • globalSetup
    • globalTeardown
    • grep
    • growl
    • hasGlobalSetupFixtures
    • hasGlobalTeardownFixtures
    • inlineDiffs
    • invert
    • lazyLoadFiles
    • loadFilesAsync
    • noHighlighting
    • parallelMode
    • reporter
    • retries
    • rootHooks
    • run
    • runGlobalSetup
    • runGlobalTeardown
    • slow
    • timeout
    • ui
    • unloadFiles
  • Base
    • exports.list
  • Doc
  • Dot
  • HTML
    • addCodeToggle
    • suiteURL
    • testURL
  • JSON
  • JSONStream
  • Landing
  • List
  • Markdown
  • Min
  • Nyan
  • Progress
  • Spec
  • TAP
  • XUnit
    • done
    • test
    • write
  • Runnable
    • reset
  • Runner
    • abort
    • dispose
    • globals
    • grep
    • grepTotal
    • run
    • runAsync
  • Suite
    • create
    • dispose
    • fullTitle
    • reset
    • titlePath
    • total
  • Test
    • reset

Modules

  • Base
  • browser/Progress
    • Progress
  • Context
  • Doc
  • Dot
  • Growl
    • isCapable
    • isCapable
    • notify
    • notify
  • HTML
    • error
    • fragment
    • hideSuitesWithout
    • makeUrl
    • on
    • text
    • unhide
  • interfaces/common
    • after
    • afterEach
    • before
    • beforeEach
    • runWithSuite
  • JSON
  • JSONStream
  • Landing
  • lib/cli
    • loadOptions
    • loadPkgRc
    • loadRc
    • lookupFiles
    • lookupFiles
    • main
  • lib/errors
    • createFatalError
    • createForbiddenExclusivityError
    • createInvalidArgumentTypeError
    • createInvalidArgumentValueError
    • createInvalidExceptionError
    • createInvalidInterfaceError
    • createInvalidLegacyPluginError
    • createInvalidPluginDefinitionError
    • createInvalidPluginError
    • createInvalidPluginImplementationError
    • createInvalidReporterError
    • createMissingArgumentError
    • createMochaInstanceAlreadyDisposedError
    • createMochaInstanceAlreadyRunningError
    • createNoFilesMatchPatternError
    • createUnsupportedError
  • lib/stats-collector
  • List
  • Markdown
  • Min
  • Nyan
    • write
  • Pending
    • Pending
  • Progress
  • Spec
  • TAP
  • utils
    • clamp
    • clean
    • createMap
    • defineConstants
    • isPromise
    • noop
    • stackTraceFilter
    • supportsEsModules
  • XUnit
    • tag

Externals

  • EventEmitter
  • yargsParser

Tutorials

  • Create a Custom Reporter

Interfaces

  • Arguments

Global

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!)
  • Issue Tracker

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