api documentation for protractor (v5.1.1)

Webdriver E2E test wrapper for Angular.

table of contents

  1. module protractor
    1. function protractor.ActionSequence (driver)
    2. function protractor.Builder ()
    3. function protractor.Capabilities (Capabilities|Map<string, ?>|Object)
    4. function protractor.Command (name)
    5. function protractor.ElementArrayFinder (browser_, getWebElements = null, locator_, actionResults_ = null)
    6. function protractor.ElementFinder (browser_, elementArrayFinder)
    7. function protractor.EventEmitter (type, var_args)
    8. function protractor.FileDetector (driver, path)
    9. function protractor.ProtractorBrowser (webdriverInstance, opt_baseUrl, opt_rootElement, opt_untrackOutstandingTimeouts, opt_blockingProxyUrl)
    10. function protractor.ProtractorBy (by.locatorName(args)
    11. function protractor.ProtractorExpectedConditions (browser)
    12. function protractor.Ptor ()
    13. function protractor.Session (Object|Capabilities)
    14. function protractor.WebDriver (Session|IThenable<!Session>)
    15. function protractor.WebElement (!IThenable<string>|string)
    16. function protractor.WebElementPromise (driver, el)
    17. object protractor.Browser
    18. object protractor.Button
    19. object protractor.Capability
    20. object protractor.CommandName
    21. object protractor.Key
    22. object protractor.bpRunner
    23. object protractor.browser
    24. object protractor.clientsidescripts
    25. object protractor.configParser
    26. object protractor.debugger
    27. object protractor.element
    28. object protractor.error
    29. object protractor.exitCodes
    30. object protractor.expectedConditions
    31. object protractor.launcher
    32. object protractor.locators
    33. object protractor.logger
    34. object protractor.logging
    35. object protractor.plugins
    36. object protractor.promise
    37. object protractor.ptor
    38. object protractor.runner
    39. object protractor.taskLogger
    40. object protractor.taskRunner
    41. object protractor.taskScheduler
    42. object protractor.until
    43. object protractor.util
    44. object protractor.utils
  2. module protractor.Key
    1. function protractor.Key.chord (var_args)
    2. string protractor.Key.ADD
    3. string protractor.Key.ALT
    4. string protractor.Key.ARROW_DOWN
    5. string protractor.Key.ARROW_LEFT
    6. string protractor.Key.ARROW_RIGHT
    7. string protractor.Key.ARROW_UP
    8. string protractor.Key.BACK_SPACE
    9. string protractor.Key.CANCEL
    10. string protractor.Key.CLEAR
    11. string protractor.Key.COMMAND
    12. string protractor.Key.CONTROL
    13. string protractor.Key.DECIMAL
    14. string protractor.Key.DELETE
    15. string protractor.Key.DIVIDE
    16. string protractor.Key.DOWN
    17. string protractor.Key.END
    18. string protractor.Key.ENTER
    19. string protractor.Key.EQUALS
    20. string protractor.Key.ESCAPE
    21. string protractor.Key.F1
    22. string protractor.Key.F10
    23. string protractor.Key.F11
    24. string protractor.Key.F12
    25. string protractor.Key.F2
    26. string protractor.Key.F3
    27. string protractor.Key.F4
    28. string protractor.Key.F5
    29. string protractor.Key.F6
    30. string protractor.Key.F7
    31. string protractor.Key.F8
    32. string protractor.Key.F9
    33. string protractor.Key.HELP
    34. string protractor.Key.HOME
    35. string protractor.Key.INSERT
    36. string protractor.Key.LEFT
    37. string protractor.Key.META
    38. string protractor.Key.MULTIPLY
    39. string protractor.Key.NULL
    40. string protractor.Key.NUMPAD0
    41. string protractor.Key.NUMPAD1
    42. string protractor.Key.NUMPAD2
    43. string protractor.Key.NUMPAD3
    44. string protractor.Key.NUMPAD4
    45. string protractor.Key.NUMPAD5
    46. string protractor.Key.NUMPAD6
    47. string protractor.Key.NUMPAD7
    48. string protractor.Key.NUMPAD8
    49. string protractor.Key.NUMPAD9
    50. string protractor.Key.PAGE_DOWN
    51. string protractor.Key.PAGE_UP
    52. string protractor.Key.PAUSE
    53. string protractor.Key.RETURN
    54. string protractor.Key.RIGHT
    55. string protractor.Key.SEMICOLON
    56. string protractor.Key.SEPARATOR
    57. string protractor.Key.SHIFT
    58. string protractor.Key.SPACE
    59. string protractor.Key.SUBTRACT
    60. string protractor.Key.TAB
    61. string protractor.Key.UP
  3. module protractor.bpRunner
    1. function protractor.bpRunner.BlockingProxyRunner (config)
  4. module protractor.browser
    1. function protractor.browser.AbstractExtendedWebDriver {{signature}}
    2. function protractor.browser.AbstractWebDriver {{signature}}
    3. function protractor.browser.ActionSequence (driver)
    4. function protractor.browser.Builder ()
    5. function protractor.browser.By (using, value)
    6. function protractor.browser.Capabilities (Capabilities|Map<string, ?>|Object)
    7. function protractor.browser.Condition (!WebDriver)
    8. function protractor.browser.EventEmitter (type, var_args)
    9. function protractor.browser.FileDetector (driver, path)
    10. function protractor.browser.ProtractorBrowser (webdriverInstance, opt_baseUrl, opt_rootElement, opt_untrackOutstandingTimeouts, opt_blockingProxyUrl)
    11. function protractor.browser.Session (Object|Capabilities)
    12. function protractor.browser.ThenableWebDriver (...args)
    13. function protractor.browser.TouchSequence (driver)
    14. function protractor.browser.WebDriver (Session|IThenable<!Session>)
    15. function protractor.browser.WebElement (!IThenable<string>|string)
    16. function protractor.browser.WebElementCondition (!WebDriver)
    17. function protractor.browser.WebElementPromise (driver, el)
    18. object protractor.browser.Browser
    19. object protractor.browser.Button
    20. object protractor.browser.Capability
    21. object protractor.browser.Key
    22. object protractor.browser.error
    23. object protractor.browser.logging
    24. object protractor.browser.promise
    25. object protractor.browser.until
  5. module protractor.clientsidescripts
    1. function protractor.clientsidescripts.protractorBaseModuleFn (trackOutstandingTimeouts)
    2. string protractor.clientsidescripts.allowAnimations
    3. string protractor.clientsidescripts.evaluate
    4. string protractor.clientsidescripts.findAllRepeaterRows
    5. string protractor.clientsidescripts.findBindings
    6. string protractor.clientsidescripts.findByButtonText
    7. string protractor.clientsidescripts.findByCssContainingText
    8. string protractor.clientsidescripts.findByModel
    9. string protractor.clientsidescripts.findByOptions
    10. string protractor.clientsidescripts.findByPartialButtonText
    11. string protractor.clientsidescripts.findRepeaterColumn
    12. string protractor.clientsidescripts.findRepeaterElement
    13. string protractor.clientsidescripts.findRepeaterRows
    14. string protractor.clientsidescripts.getLocationAbsUrl
    15. string protractor.clientsidescripts.getPendingHttpRequests
    16. string protractor.clientsidescripts.installInBrowser
    17. string protractor.clientsidescripts.setLocation
    18. string protractor.clientsidescripts.testForAngular
    19. string protractor.clientsidescripts.waitForAngular
  6. module protractor.configParser
    1. function protractor.configParser.ConfigParser ()
  7. module protractor.debugger
    1. function protractor.debugger.DebugHelper (browserUnderDebug_)
  8. module protractor.element
    1. function protractor.element.ElementArrayFinder (browser_, getWebElements = null, locator_, actionResults_ = null)
    2. function protractor.element.ElementFinder (browser_, elementArrayFinder)
    3. function protractor.element.WebdriverWebElement {{signature}}
  9. module protractor.error
    1. function protractor.error.ElementNotSelectableError (opt_error)
    2. function protractor.error.ElementNotVisibleError (opt_error)
    3. function protractor.error.InvalidArgumentError (opt_error)
    4. function protractor.error.InvalidCookieDomainError (opt_error)
    5. function protractor.error.InvalidElementCoordinatesError (opt_error)
    6. function protractor.error.InvalidElementStateError (opt_error)
    7. function protractor.error.InvalidSelectorError (opt_error)
    8. function protractor.error.JavascriptError (opt_error)
    9. function protractor.error.MoveTargetOutOfBoundsError (opt_error)
    10. function protractor.error.NoSuchAlertError (opt_error)
    11. function protractor.error.NoSuchElementError (opt_error)
    12. function protractor.error.NoSuchFrameError (opt_error)
    13. function protractor.error.NoSuchSessionError (opt_error)
    14. function protractor.error.NoSuchWindowError (opt_error)
    15. function protractor.error.ScriptTimeoutError (opt_error)
    16. function protractor.error.SessionNotCreatedError (opt_error)
    17. function protractor.error.StaleElementReferenceError (opt_error)
    18. function protractor.error.TimeoutError (opt_error)
    19. function protractor.error.UnableToCaptureScreenError (opt_error)
    20. function protractor.error.UnableToSetCookieError (opt_error)
    21. function protractor.error.UnexpectedAlertOpenError (opt_error, opt_text)
    22. function protractor.error.UnknownCommandError (opt_error)
    23. function protractor.error.UnknownMethodError (opt_error)
    24. function protractor.error.UnsupportedOperationError (opt_error)
    25. function protractor.error.WebDriverError (opt_error)
    26. function protractor.error.checkLegacyResponse (responseObj)
    27. function protractor.error.checkResponse (data)
    28. function protractor.error.encodeError (err)
    29. function protractor.error.throwDecodedError (data)
    30. object protractor.error.ErrorCode
  10. module protractor.exitCodes
    1. function protractor.exitCodes.BrowserError (logger, message)
    2. function protractor.exitCodes.ConfigError (logger, message, error)
    3. function protractor.exitCodes.ErrorHandler (errMsgs, e)
    4. function protractor.exitCodes.IError {{signature}}
    5. function protractor.exitCodes.ProtractorError (logger, message, code, error)
  11. module protractor.expectedConditions
    1. function protractor.expectedConditions.ProtractorExpectedConditions (browser)
  12. module protractor.launcher
    1. function protractor.launcher.init (configFile, additionalConfig)
  13. module protractor.locators
    1. function protractor.locators.ProtractorBy (by.locatorName(args)
    2. function protractor.locators.WebdriverBy ()
    3. function protractor.locators.isProtractorLocator (x)
  14. module protractor.logger
    1. function protractor.logger.Logger (id)
    2. object protractor.logger.LogLevel
    3. object protractor.logger.WriteTo
  15. module protractor.logging
    1. function protractor.logging.Entry (!Level|string|number)
    2. function protractor.logging.Level (name, level)
    3. function protractor.logging.LogManager ()
    4. function protractor.logging.Logger (name, opt_level)
    5. function protractor.logging.Preferences ()
    6. function protractor.logging.addConsoleHandler (opt_logger)
    7. function protractor.logging.getLevel (nameOrValue)
    8. function protractor.logging.getLogger (name)
    9. function protractor.logging.installConsoleHandler ()
    10. function protractor.logging.removeConsoleHandler (opt_logger)
    11. object protractor.logging.Type
  16. module protractor.plugins
    1. function protractor.plugins.Plugins (config)
    2. object protractor.plugins.PromiseType
  17. module protractor.promise
    1. boolean protractor.promise.LONG_STACK_TRACES
    2. boolean protractor.promise.USE_PROMISE_MANAGER
    3. function protractor.promise.CancellableThenable (new: CancellableThenable, ...?)
    4. function protractor.promise.CancellationError (opt_msg)
    5. function protractor.promise.ControlFlow ()
    6. function protractor.promise.Deferred (opt_flow)
    7. function protractor.promise.MultipleUnhandledRejectionError (Set<*>)
    8. function protractor.promise.Promise ( * function((T|IThenable<T>|Thenable)
    9. function protractor.promise.Scheduler ()
    10. function protractor.promise.Thenable (new: Thenable, ...?)
    11. function protractor.promise.all (arr)
    12. function protractor.promise.asap (value, callback, opt_errback)
    13. function protractor.promise.captureStackTrace (name, msg, opt_topFn)
    14. function protractor.promise.checkedNodeCall (fn, var_args)
    15. function protractor.promise.consume (generatorFn, opt_self, ...var_args)
    16. function protractor.promise.controlFlow ()
    17. function protractor.promise.createFlow (callback)
    18. function protractor.promise.defer ()
    19. function protractor.promise.delayed (ms)
    20. function protractor.promise.filter (arr, fn, opt_self)
    21. function protractor.promise.finally (promise, callback)
    22. function protractor.promise.fulfilled (opt_value)
    23. function protractor.promise.fullyResolved (value)
    24. function protractor.promise.isGenerator (fn)
    25. function protractor.promise.isPromise (value)
    26. function protractor.promise.map (arr, fn, opt_self)
    27. function protractor.promise.rejected (opt_reason)
    28. function protractor.promise.setDefaultFlow (flow)
    29. function protractor.promise.when (value, opt_callback, opt_errback)
  18. module protractor.ptor
    1. function protractor.ptor.Ptor ()
    2. object protractor.ptor.protractor
  19. module protractor.runner
    1. function protractor.runner.Runner (config)
  20. module protractor.taskLogger
    1. function protractor.taskLogger.TaskLogger (data)
  21. module protractor.taskRunner
    1. function protractor.taskRunner.TaskRunner (configFile, additionalConfig, task, runInFork)
  22. module protractor.taskScheduler
    1. function protractor.taskScheduler.TaskQueue (capabilities, specLists)
    2. function protractor.taskScheduler.TaskScheduler (combination of capabilities and spec)
  23. module protractor.until
    1. function protractor.until.ableToSwitchToFrame (frame)
    2. function protractor.until.alertIsPresent ()
    3. function protractor.until.elementIsDisabled (element)
    4. function protractor.until.elementIsEnabled (element)
    5. function protractor.until.elementIsNotSelected (element)
    6. function protractor.until.elementIsNotVisible (element)
    7. function protractor.until.elementIsSelected (element)
    8. function protractor.until.elementIsVisible (element)
    9. function protractor.until.elementLocated (locator)
    10. function protractor.until.elementTextContains (element, substr)
    11. function protractor.until.elementTextIs (element, text)
    12. function protractor.until.elementTextMatches (element, regex)
    13. function protractor.until.elementsLocated (locator)
    14. function protractor.until.stalenessOf (element)
    15. function protractor.until.titleContains (substr)
    16. function protractor.until.titleIs (title)
    17. function protractor.until.titleMatches (regex)
    18. function protractor.until.urlContains (substrUrl)
    19. function protractor.until.urlIs (url)
    20. function protractor.until.urlMatches (regex)
  24. module protractor.util
    1. function protractor.util.falseIfMissing (error)
    2. function protractor.util.filterStackTrace (text)
    3. function protractor.util.joinTestLogs (log1, log2)
    4. function protractor.util.passBoolean (value)
    5. function protractor.util.runFilenameOrFn_ (configDir, filenameOrFn, args)

module protractor

function protractor.ActionSequence (driver)

function protractor.Builder ()

function protractor.Capabilities (Capabilities|Map<string, ?>|Object)

function protractor.Command (name)

function protractor.ElementArrayFinder (browser_, getWebElements = null, locator_, actionResults_ = null)

function protractor.ElementFinder (browser_, elementArrayFinder)

function protractor.EventEmitter (type, var_args)

function protractor.FileDetector (driver, path)

function protractor.ProtractorBrowser (webdriverInstance, opt_baseUrl, opt_rootElement, opt_untrackOutstandingTimeouts, opt_blockingProxyUrl)

function protractor.ProtractorBy (by.locatorName(args)

function protractor.ProtractorExpectedConditions (browser)

function protractor.Ptor ()

function protractor.Session (Object|Capabilities)

function protractor.WebDriver (Session|IThenable<!Session>)

function protractor.WebElement (!IThenable<string>|string)

function protractor.WebElementPromise (driver, el)

module protractor.Key

function protractor.Key.chord (var_args)

module protractor.bpRunner

function protractor.bpRunner.BlockingProxyRunner (config)

module protractor.browser

function protractor.browser.AbstractExtendedWebDriver {{signature}}

function protractor.browser.AbstractWebDriver {{signature}}

function protractor.browser.ActionSequence (driver)

function protractor.browser.Builder ()

function protractor.browser.By (using, value)

function protractor.browser.Capabilities (Capabilities|Map<string, ?>|Object)

function protractor.browser.Condition (!WebDriver)

function protractor.browser.EventEmitter (type, var_args)

function protractor.browser.FileDetector (driver, path)

function protractor.browser.ProtractorBrowser (webdriverInstance, opt_baseUrl, opt_rootElement, opt_untrackOutstandingTimeouts, opt_blockingProxyUrl)

function protractor.browser.Session (Object|Capabilities)

function protractor.browser.ThenableWebDriver (...args)

function protractor.browser.TouchSequence (driver)

function protractor.browser.WebDriver (Session|IThenable<!Session>)

function protractor.browser.WebElement (!IThenable<string>|string)

function protractor.browser.WebElementCondition (!WebDriver)

function protractor.browser.WebElementPromise (driver, el)

module protractor.clientsidescripts

function protractor.clientsidescripts.protractorBaseModuleFn (trackOutstandingTimeouts)

module protractor.configParser

function protractor.configParser.ConfigParser ()

module protractor.debugger

function protractor.debugger.DebugHelper (browserUnderDebug_)

module protractor.element

function protractor.element.ElementArrayFinder (browser_, getWebElements = null, locator_, actionResults_ = null)

function protractor.element.ElementFinder (browser_, elementArrayFinder)

function protractor.element.WebdriverWebElement {{signature}}

module protractor.error

function protractor.error.ElementNotSelectableError (opt_error)

function protractor.error.ElementNotVisibleError (opt_error)

function protractor.error.InvalidArgumentError (opt_error)

function protractor.error.InvalidCookieDomainError (opt_error)

function protractor.error.InvalidElementCoordinatesError (opt_error)

function protractor.error.InvalidElementStateError (opt_error)

function protractor.error.InvalidSelectorError (opt_error)

function protractor.error.JavascriptError (opt_error)

function protractor.error.MoveTargetOutOfBoundsError (opt_error)

function protractor.error.NoSuchAlertError (opt_error)

function protractor.error.NoSuchElementError (opt_error)

function protractor.error.NoSuchFrameError (opt_error)

function protractor.error.NoSuchSessionError (opt_error)

function protractor.error.NoSuchWindowError (opt_error)

function protractor.error.ScriptTimeoutError (opt_error)

function protractor.error.SessionNotCreatedError (opt_error)

function protractor.error.StaleElementReferenceError (opt_error)

function protractor.error.TimeoutError (opt_error)

function protractor.error.UnableToCaptureScreenError (opt_error)

function protractor.error.UnableToSetCookieError (opt_error)

function protractor.error.UnexpectedAlertOpenError (opt_error, opt_text)

function protractor.error.UnknownCommandError (opt_error)

function protractor.error.UnknownMethodError (opt_error)

function protractor.error.UnsupportedOperationError (opt_error)

function protractor.error.WebDriverError (opt_error)

function protractor.error.checkLegacyResponse (responseObj)

function protractor.error.checkResponse (data)

function protractor.error.encodeError (err)

function protractor.error.throwDecodedError (data)

module protractor.exitCodes

function protractor.exitCodes.BrowserError (logger, message)

function protractor.exitCodes.ConfigError (logger, message, error)

function protractor.exitCodes.ErrorHandler (errMsgs, e)

function protractor.exitCodes.IError {{signature}}

function protractor.exitCodes.ProtractorError (logger, message, code, error)

module protractor.expectedConditions

function protractor.expectedConditions.ProtractorExpectedConditions (browser)

module protractor.launcher

function protractor.launcher.init (configFile, additionalConfig)

module protractor.locators

function protractor.locators.ProtractorBy (by.locatorName(args)

function protractor.locators.WebdriverBy ()

function protractor.locators.isProtractorLocator (x)

module protractor.logger

function protractor.logger.Logger (id)

module protractor.logging

function protractor.logging.Entry (!Level|string|number)

function protractor.logging.Level (name, level)

function protractor.logging.LogManager ()

function protractor.logging.Logger (name, opt_level)

function protractor.logging.Preferences ()

function protractor.logging.addConsoleHandler (opt_logger)

function protractor.logging.getLevel (nameOrValue)

function protractor.logging.getLogger (name)

function protractor.logging.installConsoleHandler ()

function protractor.logging.removeConsoleHandler (opt_logger)

module protractor.plugins

function protractor.plugins.Plugins (config)

module protractor.promise

function protractor.promise.CancellableThenable (new: CancellableThenable, ...?)

function protractor.promise.CancellationError (opt_msg)

function protractor.promise.ControlFlow ()

function protractor.promise.Deferred (opt_flow)

function protractor.promise.MultipleUnhandledRejectionError (Set<*>)

function protractor.promise.Promise ( * function((T|IThenable<T>|Thenable)

function protractor.promise.Scheduler ()

function protractor.promise.Thenable (new: Thenable, ...?)

function protractor.promise.all (arr)

function protractor.promise.asap (value, callback, opt_errback)

function protractor.promise.captureStackTrace (name, msg, opt_topFn)

function protractor.promise.checkedNodeCall (fn, var_args)

function protractor.promise.consume (generatorFn, opt_self, ...var_args)

function protractor.promise.controlFlow ()

function protractor.promise.createFlow (callback)

function protractor.promise.defer ()

function protractor.promise.delayed (ms)

function protractor.promise.filter (arr, fn, opt_self)

function protractor.promise.finally (promise, callback)

function protractor.promise.fulfilled (opt_value)

function protractor.promise.fullyResolved (value)

function protractor.promise.isGenerator (fn)

function protractor.promise.isPromise (value)

function protractor.promise.map (arr, fn, opt_self)

function protractor.promise.rejected (opt_reason)

function protractor.promise.setDefaultFlow (flow)

function protractor.promise.when (value, opt_callback, opt_errback)

module protractor.ptor

function protractor.ptor.Ptor ()

module protractor.runner

function protractor.runner.Runner (config)

module protractor.taskLogger

function protractor.taskLogger.TaskLogger (data)

module protractor.taskRunner

function protractor.taskRunner.TaskRunner (configFile, additionalConfig, task, runInFork)

module protractor.taskScheduler

function protractor.taskScheduler.TaskQueue (capabilities, specLists)

function protractor.taskScheduler.TaskScheduler (combination of capabilities and spec)

module protractor.until

function protractor.until.ableToSwitchToFrame (frame)

function protractor.until.alertIsPresent ()

function protractor.until.elementIsDisabled (element)

function protractor.until.elementIsEnabled (element)

function protractor.until.elementIsNotSelected (element)

function protractor.until.elementIsNotVisible (element)

function protractor.until.elementIsSelected (element)

function protractor.until.elementIsVisible (element)

function protractor.until.elementLocated (locator)

function protractor.until.elementTextContains (element, substr)

function protractor.until.elementTextIs (element, text)

function protractor.until.elementTextMatches (element, regex)

function protractor.until.elementsLocated (locator)

function protractor.until.stalenessOf (element)

function protractor.until.titleContains (substr)

function protractor.until.titleIs (title)

function protractor.until.titleMatches (regex)

function protractor.until.urlContains (substrUrl)

function protractor.until.urlIs (url)

function protractor.until.urlMatches (regex)

module protractor.util

function protractor.util.falseIfMissing (error)

function protractor.util.filterStackTrace (text)

function protractor.util.joinTestLogs (log1, log2)

function protractor.util.passBoolean (value)

function protractor.util.runFilenameOrFn_ (configDir, filenameOrFn, args)

[ this document was created with utility2 ]