# protractor-watcher-plugin

> Watcher Plugin for Protractor

Latest version **0.0.5** (published 2016-02-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install protractor-watcher-plugin
pnpm add protractor-watcher-plugin
yarn add protractor-watcher-plugin
bun add protractor-watcher-plugin
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2016-02-26 |
| First published | 2015-03-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Raphael Hirtenfelder |
| Maintainers | hirtenfelder |
| Keywords | angular, protractor, watcher, performance, test |

## Links

- npm: https://www.npmjs.com/package/protractor-watcher-plugin
- Repository: https://github.com/hirtenfelder/protractor-watcher-plugin
- Homepage: https://github.com/hirtenfelder/protractor-watcher-plugin#readme
- Issues: https://github.com/hirtenfelder/protractor-watcher-plugin/issues
- npm.io page: https://npm.io/package/protractor-watcher-plugin

## Recent versions

- 0.0.5 (latest) — 2016-02-26
- 0.0.4 — 2015-06-30
- 0.0.2 — 2015-03-19
- 0.0.1 — 2015-03-11

## README

# Watcher Plugin

[![Build Status](https://api.travis-ci.org/hirtenfelder/protractor-watcher-plugin.svg?branch=master)](https://travis-ci.org/hirtenfelder/protractor-watcher-plugin)
[![NPM version](https://img.shields.io/npm/v/protractor-watcher-plugin.svg)](https://www.npmjs.com/package/protractor-watcher-plugin)
[![Dependency Status](https://img.shields.io/david/hirtenfelder/protractor-watcher-plugin.svg?style=flat)](https://david-dm.org/hirtenfelder/protractor-watcher-plugin)
[![devDependency Status](https://img.shields.io/david/dev/hirtenfelder/protractor-watcher-plugin.svg?style=flat)](https://david-dm.org/hirtenfelder/protractor-watcher-plugin#info=devDependencies&view=table)
[![DUB](https://img.shields.io/dub/l/vibe-d.svg)](LICENSE)

To many watchers may have a negative impact for the performance of an [AngularJS](https://www.angularjs.org/) application. In particular
if you don't use one-time-bindings (new with AngularJS 1.5) in cobination with ng-repeat or ng-grid.
This [Protractor plugin](https://github.com/angular/protractor/blob/master/docs/plugins.md) will help you, 
to keep the number of watchers used by your AngularJS application in sight. 

It simply counts all the watchers of the page which is being tested and compares it with a predefined value (maxAllowedWatchers). 
If the number of watchers exceeds the allowed limit, the test fails. You can define a general limit or limits with url patterns.

## It's BETA

Keep in mind, the Protractor Plugin API is BETA and may change without a major version bump.

## Getting Started

The plugin runs with [Protractor](http://angular.github.io/protractor/#/) 3.x and AngularJS 1.x Once you're familiar with that process, you may install this plugin with the node package manager:

```
npm install protractor-watcher-plugin
```

## Plugin configuration

You can enable the plugin in the protractor configuration file. The maxAllowedWatchers attribute is used as default limit.
The usage of urlPatterns is optional. If defined, the plugin will override the default limit with the limit, configured by
the url pattern. If maxAllowedWatchers is undefined, the default value of 100 will be used.

If the plugin is used as a node module, you may use it with the *package* instead of the *path* option.

### Example configuration

```javascript
exports.config = {
  seleniumAddress: 'http://localhost:4444/wd/hub',
  specs: ['*-spec.js'],
  capabilities: {
    browserName: 'chrome'
  },
  plugins: [{
    path: 'path/to/the/plugin',
    maxAllowedWatchers: 15,
    urlPatterns: [{
      urlPattern: '#/mysite',
      maxAllowedWatchers: 12
    }]
  }]
}
```

### Example spec

To run the example spec do these steps:

- Update Driver Manager (webdriver-manager update)
- Start Selenium (webdriver-manager start)
- Run Protractor (protractor example/example-conf.js)

If you run the example spec together with the example configuration, the test should fail and logs following message:

```
The maximum number of watchers [12] has been exceeded. Number of watchers found [13]
```

### Test suite

To run the test suite just use the provided npm test script:

```
npm test
```

---
_Source: https://npm.io/package/protractor-watcher-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._