api documentation for dredd (v3.4.2)

HTTP API Testing Framework

table of contents

  1. module dredd
    1. function dredd (config)
    2. function dredd.dredd_command (options, cb)
    3. function dredd.hooks (options)
    4. function dredd.hooks_worker_client (runner)
    5. function dredd.transaction_runner (configuration1)
    6. object dredd.blueprint_utils
    7. object dredd.child_process
    8. object dredd.config_utils
    9. object dredd.configuration
    10. object dredd.dredd_command.prototype
    11. object dredd.hooks.prototype
    12. object dredd.hooks_worker_client.prototype
    13. object dredd.interactive_config
    14. object dredd.logger
    15. object dredd.options
    16. object dredd.transaction_runner.prototype
    17. object dredd.which
  2. module dredd.blueprint_utils
    1. function dredd.blueprint_utils.characterIndexToPosition (charIndex, code)
    2. function dredd.blueprint_utils.rangesToLinesText (ranges)
    3. function dredd.blueprint_utils.sortNumbersAscending (a, b)
    4. function dredd.blueprint_utils.warningLocationToRanges (warningLocation, text)
  3. module dredd.child_process
    1. function dredd.child_process.signalKill (childProcess, callback)
    2. function dredd.child_process.signalTerm (childProcess, callback)
    3. function dredd.child_process.spawn ()
    4. function dredd.child_process.terminate (childProcess, options, callback)
  4. module dredd.config_utils
    1. function dredd.config_utils.load (path)
    2. function dredd.config_utils.parseCustom (customArray)
    3. function dredd.config_utils.save (argsOrigin, path)
  5. module dredd.configuration
    1. function dredd.configuration.applyConfiguration (config)
    2. function dredd.configuration.applyLoggingOptions (options)
  6. module dredd.dredd_command
    1. function dredd.dredd_command (options, cb)
  7. module dredd.dredd_command.prototype
    1. function dredd.dredd_command.prototype.checkRequiredArgs ()
    2. function dredd.dredd_command.prototype.commandSigInt ()
    3. function dredd.dredd_command.prototype.exitWithStatus (error, stats)
    4. function dredd.dredd_command.prototype.initConfig ()
    5. function dredd.dredd_command.prototype.initDredd (configuration)
    6. function dredd.dredd_command.prototype.lastArgvIsApiEndpoint ()
    7. function dredd.dredd_command.prototype.loadDreddFile ()
    8. function dredd.dredd_command.prototype.logDebuggingInfo (config)
    9. function dredd.dredd_command.prototype.moveBlueprintArgToPath ()
    10. function dredd.dredd_command.prototype.parseCustomConfig ()
    11. function dredd.dredd_command.prototype.run ()
    12. function dredd.dredd_command.prototype.runDredd (dreddInstance)
    13. function dredd.dredd_command.prototype.runExitingActions ()
    14. function dredd.dredd_command.prototype.runServerAndThenDredd (callback)
    15. function dredd.dredd_command.prototype.setExitOrCallback ()
    16. function dredd.dredd_command.prototype.setOptimistArgv ()
    17. function dredd.dredd_command.prototype.stopServer (callback)
    18. function dredd.dredd_command.prototype.takeRestOfParamsAsPath ()
  8. module dredd.hooks
    1. function dredd.hooks (options)
  9. module dredd.hooks.prototype
    1. function dredd.hooks.prototype.addHook (hooks, name, hook)
    2. function dredd.hooks.prototype.after (name, hook)
    3. function dredd.hooks.prototype.afterAll (hook)
    4. function dredd.hooks.prototype.afterEach (hook)
    5. function dredd.hooks.prototype.before (name, hook)
    6. function dredd.hooks.prototype.beforeAll (hook)
    7. function dredd.hooks.prototype.beforeEach (hook)
    8. function dredd.hooks.prototype.beforeEachValidation (hook)
    9. function dredd.hooks.prototype.beforeValidation (name, hook)
    10. function dredd.hooks.prototype.dumpHooksFunctionsToStrings ()
    11. function dredd.hooks.prototype.log ()
  10. module dredd.hooks_worker_client
    1. function dredd.hooks_worker_client (runner)
  11. module dredd.hooks_worker_client.prototype
    1. function dredd.hooks_worker_client.prototype.connectToHandler (callback)
    2. function dredd.hooks_worker_client.prototype.disconnectFromHandler ()
    3. function dredd.hooks_worker_client.prototype.registerHooks (callback)
    4. function dredd.hooks_worker_client.prototype.setCommandAndCheckForExecutables (callback)
    5. function dredd.hooks_worker_client.prototype.spawnHandler (callback)
    6. function dredd.hooks_worker_client.prototype.start (callback)
    7. function dredd.hooks_worker_client.prototype.stop (callback)
    8. function dredd.hooks_worker_client.prototype.terminateHandler (callback)
  12. module dredd.interactive_config
    1. function dredd.interactive_config.processAnswers (config, answers, callback)
    2. function dredd.interactive_config.prompt (config, callback)
    3. function dredd.interactive_config.run (config, callback)
    4. function dredd.interactive_config.updateCircle ()
    5. function dredd.interactive_config.updateTravis ()
  13. module dredd.logger
    1. boolean dredd.logger.emitErrs
    2. boolean dredd.logger.exitOnError
    3. boolean dredd.logger.padLevels
    4. boolean dredd.logger.stripColors
    5. function dredd.logger.actual (msg)
    6. function dredd.logger.complete (msg)
    7. function dredd.logger.debug (msg)
    8. function dredd.logger.error (msg)
    9. function dredd.logger.expected (msg)
    10. function dredd.logger.fail (msg)
    11. function dredd.logger.hook (msg)
    12. function dredd.logger.info (msg)
    13. function dredd.logger.pass (msg)
    14. function dredd.logger.request (msg)
    15. function dredd.logger.silly (msg)
    16. function dredd.logger.skip (msg)
    17. function dredd.logger.test (msg)
    18. function dredd.logger.verbose (msg)
    19. function dredd.logger.warn (msg)
    20. number dredd.logger._eventsCount
    21. object dredd.logger._events
    22. object dredd.logger._names
    23. object dredd.logger.domain
    24. object dredd.logger.exceptionHandlers
    25. object dredd.logger.filters
    26. object dredd.logger.id
    27. object dredd.logger.levels
    28. object dredd.logger.profilers
    29. object dredd.logger.rewriters
    30. object dredd.logger.transports
    31. string dredd.logger.level
  14. module dredd.transaction_runner
    1. function dredd.transaction_runner (configuration1)
  15. module dredd.transaction_runner.prototype
    1. function dredd.transaction_runner.prototype.config (config)
    2. function dredd.transaction_runner.prototype.configureTransaction (transaction, callback)
    3. function dredd.transaction_runner.prototype.createTest (transaction)
    4. function dredd.transaction_runner.prototype.emitError (error, test)
    5. function dredd.transaction_runner.prototype.emitHookError (error, data)
    6. function dredd.transaction_runner.prototype.emitResult (transaction, callback)
    7. function dredd.transaction_runner.prototype.ensureTransactionResultsGeneralSection (transaction)
    8. function dredd.transaction_runner.prototype.executeAllTransactions (transactions, hooks, callback)
    9. function dredd.transaction_runner.prototype.executeTransaction (transaction, hooks, callback)
    10. function dredd.transaction_runner.prototype.failTransaction (transaction, reason)
    11. function dredd.transaction_runner.prototype.getFullPath (serverPath, requestPath)
    12. function dredd.transaction_runner.prototype.getRequestOptionsFromTransaction (transaction)
    13. function dredd.transaction_runner.prototype.isMultipart (requestOptions)
    14. function dredd.transaction_runner.prototype.parseServerUrl (serverUrl)
    15. function dredd.transaction_runner.prototype.performRequest (options, callback)
    16. function dredd.transaction_runner.prototype.performRequestAndValidate (test, transaction, hooks, callback)
    17. function dredd.transaction_runner.prototype.replaceLineFeedInBody (transaction, requestOptions)
    18. function dredd.transaction_runner.prototype.run (transactions, callback)
    19. function dredd.transaction_runner.prototype.runHook (hook, data, callback)
    20. function dredd.transaction_runner.prototype.runHooksForData (hooks, data, legacy, callback)
    21. function dredd.transaction_runner.prototype.runLegacyHook (hook, data, callback)
    22. function dredd.transaction_runner.prototype.runSandboxedHookFromString (hookString, data, callback)
    23. function dredd.transaction_runner.prototype.sandboxedHookResultsHandler (err, data, results, callback)
    24. function dredd.transaction_runner.prototype.sandboxedWrappedCode (hookCode)
    25. function dredd.transaction_runner.prototype.setContentLength (transaction)
    26. function dredd.transaction_runner.prototype.skipTransaction (transaction, reason)
    27. function dredd.transaction_runner.prototype.validateTransaction (test, transaction, callback)
  16. module dredd.which
    1. function dredd.which (command)

module dredd

function dredd (config)

function dredd.dredd_command (options, cb)

function dredd.hooks (options)

function dredd.hooks_worker_client (runner)

function dredd.transaction_runner (configuration1)

module dredd.blueprint_utils

function dredd.blueprint_utils.characterIndexToPosition (charIndex, code)

function dredd.blueprint_utils.rangesToLinesText (ranges)

function dredd.blueprint_utils.sortNumbersAscending (a, b)

function dredd.blueprint_utils.warningLocationToRanges (warningLocation, text)

module dredd.child_process

function dredd.child_process.signalKill (childProcess, callback)

function dredd.child_process.signalTerm (childProcess, callback)

function dredd.child_process.spawn ()

function dredd.child_process.terminate (childProcess, options, callback)

module dredd.config_utils

function dredd.config_utils.load (path)

function dredd.config_utils.parseCustom (customArray)

function dredd.config_utils.save (argsOrigin, path)

module dredd.configuration

function dredd.configuration.applyConfiguration (config)

function dredd.configuration.applyLoggingOptions (options)

module dredd.dredd_command

function dredd.dredd_command (options, cb)

module dredd.dredd_command.prototype

function dredd.dredd_command.prototype.checkRequiredArgs ()

function dredd.dredd_command.prototype.commandSigInt ()

function dredd.dredd_command.prototype.exitWithStatus (error, stats)

function dredd.dredd_command.prototype.initConfig ()

function dredd.dredd_command.prototype.initDredd (configuration)

function dredd.dredd_command.prototype.lastArgvIsApiEndpoint ()

function dredd.dredd_command.prototype.loadDreddFile ()

function dredd.dredd_command.prototype.logDebuggingInfo (config)

function dredd.dredd_command.prototype.moveBlueprintArgToPath ()

function dredd.dredd_command.prototype.parseCustomConfig ()

function dredd.dredd_command.prototype.run ()

function dredd.dredd_command.prototype.runDredd (dreddInstance)

function dredd.dredd_command.prototype.runExitingActions ()

function dredd.dredd_command.prototype.runServerAndThenDredd (callback)

function dredd.dredd_command.prototype.setExitOrCallback ()

function dredd.dredd_command.prototype.setOptimistArgv ()

function dredd.dredd_command.prototype.stopServer (callback)

function dredd.dredd_command.prototype.takeRestOfParamsAsPath ()

module dredd.hooks

function dredd.hooks (options)

module dredd.hooks.prototype

function dredd.hooks.prototype.addHook (hooks, name, hook)

function dredd.hooks.prototype.after (name, hook)

function dredd.hooks.prototype.afterAll (hook)

function dredd.hooks.prototype.afterEach (hook)

function dredd.hooks.prototype.before (name, hook)

function dredd.hooks.prototype.beforeAll (hook)

function dredd.hooks.prototype.beforeEach (hook)

function dredd.hooks.prototype.beforeEachValidation (hook)

function dredd.hooks.prototype.beforeValidation (name, hook)

function dredd.hooks.prototype.dumpHooksFunctionsToStrings ()

function dredd.hooks.prototype.log ()

module dredd.hooks_worker_client

function dredd.hooks_worker_client (runner)

module dredd.hooks_worker_client.prototype

function dredd.hooks_worker_client.prototype.connectToHandler (callback)

function dredd.hooks_worker_client.prototype.disconnectFromHandler ()

function dredd.hooks_worker_client.prototype.registerHooks (callback)

function dredd.hooks_worker_client.prototype.setCommandAndCheckForExecutables (callback)

function dredd.hooks_worker_client.prototype.spawnHandler (callback)

function dredd.hooks_worker_client.prototype.start (callback)

function dredd.hooks_worker_client.prototype.stop (callback)

function dredd.hooks_worker_client.prototype.terminateHandler (callback)

module dredd.interactive_config

function dredd.interactive_config.processAnswers (config, answers, callback)

function dredd.interactive_config.prompt (config, callback)

function dredd.interactive_config.run (config, callback)

function dredd.interactive_config.updateCircle ()

function dredd.interactive_config.updateTravis ()

module dredd.logger

function dredd.logger.actual (msg)

function dredd.logger.complete (msg)

function dredd.logger.debug (msg)

function dredd.logger.error (msg)

function dredd.logger.expected (msg)

function dredd.logger.fail (msg)

function dredd.logger.hook (msg)

function dredd.logger.info (msg)

function dredd.logger.pass (msg)

function dredd.logger.request (msg)

function dredd.logger.silly (msg)

function dredd.logger.skip (msg)

function dredd.logger.test (msg)

function dredd.logger.verbose (msg)

function dredd.logger.warn (msg)

module dredd.transaction_runner

function dredd.transaction_runner (configuration1)

module dredd.transaction_runner.prototype

function dredd.transaction_runner.prototype.config (config)

function dredd.transaction_runner.prototype.configureTransaction (transaction, callback)

function dredd.transaction_runner.prototype.createTest (transaction)

function dredd.transaction_runner.prototype.emitError (error, test)

function dredd.transaction_runner.prototype.emitHookError (error, data)

function dredd.transaction_runner.prototype.emitResult (transaction, callback)

function dredd.transaction_runner.prototype.ensureTransactionResultsGeneralSection (transaction)

function dredd.transaction_runner.prototype.executeAllTransactions (transactions, hooks, callback)

function dredd.transaction_runner.prototype.executeTransaction (transaction, hooks, callback)

function dredd.transaction_runner.prototype.failTransaction (transaction, reason)

function dredd.transaction_runner.prototype.getFullPath (serverPath, requestPath)

function dredd.transaction_runner.prototype.getRequestOptionsFromTransaction (transaction)

function dredd.transaction_runner.prototype.isMultipart (requestOptions)

function dredd.transaction_runner.prototype.parseServerUrl (serverUrl)

function dredd.transaction_runner.prototype.performRequest (options, callback)

function dredd.transaction_runner.prototype.performRequestAndValidate (test, transaction, hooks, callback)

function dredd.transaction_runner.prototype.replaceLineFeedInBody (transaction, requestOptions)

function dredd.transaction_runner.prototype.run (transactions, callback)

function dredd.transaction_runner.prototype.runHook (hook, data, callback)

function dredd.transaction_runner.prototype.runHooksForData (hooks, data, legacy, callback)

function dredd.transaction_runner.prototype.runLegacyHook (hook, data, callback)

function dredd.transaction_runner.prototype.runSandboxedHookFromString (hookString, data, callback)

function dredd.transaction_runner.prototype.sandboxedHookResultsHandler (err, data, results, callback)

function dredd.transaction_runner.prototype.sandboxedWrappedCode (hookCode)

function dredd.transaction_runner.prototype.setContentLength (transaction)

function dredd.transaction_runner.prototype.skipTransaction (transaction, reason)

function dredd.transaction_runner.prototype.validateTransaction (test, transaction, callback)

module dredd.which

function dredd.which (command)

[ this document was created with utility2 ]