Skip to content

Commit b6d2abc

Browse files
rickypcrickypc
committed
Generates the latest documentation.
1 parent 918a3fb commit b6d2abc

1 file changed

Lines changed: 13 additions & 106 deletions

File tree

‎README.md‎

Lines changed: 13 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
[![Version](https://img.shields.io/npm/v/puppeteer-extra-plugin-angular.svg)](http://bit.ly/32X27uf)
2-
[![Downloads](https://img.shields.io/npm/dt/puppeteer-extra-plugin-angular.svg)](http://bit.ly/32X27uf)
3-
[![Dependency Status](https://img.shields.io/david/rickypc/puppeteer-extra-plugin-angular.svg)](http://bit.ly/2SM3Ygy)
4-
[![Dev Dependency Status](https://img.shields.io/david/dev/rickypc/puppeteer-extra-plugin-angular.svg)](http://bit.ly/30ZDj2P)
5-
[![Code Style](https://img.shields.io/badge/code%20style-Airbnb-red.svg)](http://bit.ly/2JYN1gk)
6-
[![Build](https://img.shields.io/travis/rickypc/puppeteer-extra-plugin-angular.svg)](http://bit.ly/2YuZRuH)
7-
[![Coverage](https://img.shields.io/codecov/c/github/rickypc/puppeteer-extra-plugin-angular.svg)](http://bit.ly/2Kb1F2Y)
8-
[![License](https://img.shields.io/npm/l/puppeteer-extra-plugin-angular.svg)](http://bit.ly/2yi7gyO)
1+
[![Version](https://img.shields.io/npm/v/puppeteer-extra-plugin-angular.svg)](https://bit.ly/32X27uf)
2+
[![Downloads](https://img.shields.io/npm/dt/puppeteer-extra-plugin-angular.svg)](https://bit.ly/32X27uf)
3+
[![Dependency Status](https://img.shields.io/david/rickypc/puppeteer-extra-plugin-angular.svg)](https://bit.ly/2SM3Ygy)
4+
[![Dev Dependency Status](https://img.shields.io/david/dev/rickypc/puppeteer-extra-plugin-angular.svg)](https://bit.ly/30ZDj2P)
5+
[![Code Style](https://img.shields.io/badge/code%20style-Airbnb-red.svg)](https://bit.ly/2JYN1gk)
6+
[![Build](https://img.shields.io/travis/rickypc/puppeteer-extra-plugin-angular.svg)](https://bit.ly/2YuZRuH)
7+
[![Coverage](https://img.shields.io/codecov/c/github/rickypc/puppeteer-extra-plugin-angular.svg)](https://bit.ly/2Kb1F2Y)
8+
[![License](https://img.shields.io/npm/l/puppeteer-extra-plugin-angular.svg)](https://bit.ly/2yi7gyO)
99

1010
Puppeteer Extra Plugin Angular
1111
==============================
1212

13-
A plugin for [puppeteer-extra](http://bit.ly/2JYg8Aa) to provide [puppeteer](http://bit.ly/2JX4gOZ) functionality with [Angular](http://bit.ly/2Yw8Mw6) synchronization support.
13+
A plugin for [puppeteer-extra](https://bit.ly/2JYg8Aa) to provide [puppeteer](https://bit.ly/2JX4gOZ) functionality with [Angular](https://bit.ly/2Yw8Mw6) synchronization support.
1414

1515
Installation
1616
-
@@ -94,12 +94,6 @@ puppeteer.use(require('puppeteer-extra-plugin-angular')());
9494
* [.fillOut(configs, [data])](#module_puppeteer-extra-plugin-angular.Form.fillOut) ⇒ <code>Promise.&lt;void&gt;</code>
9595
* [.Navigate](#module_puppeteer-extra-plugin-angular.Navigate)
9696
* [.untilReady(url, [timeout])](#module_puppeteer-extra-plugin-angular.Navigate.untilReady) ⇒ <code>Promise.&lt;void&gt;</code>
97-
* [.PromiseTimeout](#module_puppeteer-extra-plugin-angular.PromiseTimeout)
98-
* _static_
99-
* [.untilSettledOrTimedOut(executor, timeoutExecutor, timeout)](#module_puppeteer-extra-plugin-angular.PromiseTimeout.untilSettledOrTimedOut) ⇒ <code>Promise.&lt;\*&gt;</code>
100-
* _inner_
101-
* [~Executor](#module_puppeteer-extra-plugin-angular.PromiseTimeout..Executor) : <code>function</code>
102-
* [~TimeoutExecutor](#module_puppeteer-extra-plugin-angular.PromiseTimeout..TimeoutExecutor) : <code>function</code>
10397
* [.Toggle](#module_puppeteer-extra-plugin-angular.Toggle)
10498
* [.check(selector, [label])](#module_puppeteer-extra-plugin-angular.Toggle.check) ⇒ <code>Promise.&lt;boolean&gt;</code>
10599
* [.deselectByText(selector, values, [label])](#module_puppeteer-extra-plugin-angular.Toggle.deselectByText) ⇒ <code>Promise.&lt;boolean&gt;</code>
@@ -202,93 +196,6 @@ Navigate to given url and wait for Angular to be ready.
202196
```js
203197
await page.navigateUntilReady('https://angular.io', 5000);
204198
```
205-
<a name="module_puppeteer-extra-plugin-angular.PromiseTimeout"></a>
206-
207-
### puppeteer-extra-plugin-angular.PromiseTimeout
208-
**Kind**: static constant of [<code>puppeteer-extra-plugin-angular</code>](#module_puppeteer-extra-plugin-angular)
209-
210-
* [.PromiseTimeout](#module_puppeteer-extra-plugin-angular.PromiseTimeout)
211-
* _static_
212-
* [.untilSettledOrTimedOut(executor, timeoutExecutor, timeout)](#module_puppeteer-extra-plugin-angular.PromiseTimeout.untilSettledOrTimedOut) ⇒ <code>Promise.&lt;\*&gt;</code>
213-
* _inner_
214-
* [~Executor](#module_puppeteer-extra-plugin-angular.PromiseTimeout..Executor) : <code>function</code>
215-
* [~TimeoutExecutor](#module_puppeteer-extra-plugin-angular.PromiseTimeout..TimeoutExecutor) : <code>function</code>
216-
217-
<a name="module_puppeteer-extra-plugin-angular.PromiseTimeout.untilSettledOrTimedOut"></a>
218-
219-
#### PromiseTimeout.untilSettledOrTimedOut(executor, timeoutExecutor, timeout) ⇒ <code>Promise.&lt;\*&gt;</code>
220-
Provide timeout procedure on inflight promise.
221-
222-
**Kind**: static method of [<code>PromiseTimeout</code>](#module_puppeteer-extra-plugin-angular.PromiseTimeout)
223-
**Returns**: <code>Promise.&lt;\*&gt;</code> - Resolve or reject response value.
224-
225-
| Param | Type | Description |
226-
| --- | --- | --- |
227-
| executor | <code>Executor</code> | Executor function. |
228-
| timeoutExecutor | <code>TimeoutExecutor</code> | Timeout executor function. |
229-
| timeout | <code>number</code> | Maximum wait timeout. |
230-
231-
**Example**
232-
```js
233-
const response = await PromiseTimeout.untilSettledOrTimedOut((resolve, reject, pending) => {
234-
// Do something promising here...
235-
if (pending()) {
236-
// Do something more promising here...
237-
resolve(true);
238-
}
239-
}, (resolve, reject) => {
240-
reject(Error('error'));
241-
}, 5000);
242-
```
243-
<a name="module_puppeteer-extra-plugin-angular.PromiseTimeout..Executor"></a>
244-
245-
#### PromiseTimeout~Executor : <code>function</code>
246-
Executor function that is executed immediately by the Promise implementation.
247-
248-
**Kind**: inner typedef of [<code>PromiseTimeout</code>](#module_puppeteer-extra-plugin-angular.PromiseTimeout)
249-
250-
| Param | Type | Description |
251-
| --- | --- | --- |
252-
| resolve | <code>function</code> | Resolve the promise. |
253-
| reject | <code>function</code> | Reject the promise. |
254-
| pending | <code>function</code> | True if Promise is not timed out, otherwise false. |
255-
256-
**Example**
257-
```js
258-
const executor = (resolve, reject, pending) => {
259-
// Do something promising here...
260-
if (pending()) {
261-
try {
262-
// Do something more promising here...
263-
resolve(true);
264-
} catch (ex) {
265-
reject(false);
266-
}
267-
}
268-
};
269-
```
270-
<a name="module_puppeteer-extra-plugin-angular.PromiseTimeout..TimeoutExecutor"></a>
271-
272-
#### PromiseTimeout~TimeoutExecutor : <code>function</code>
273-
Timeout executor function that is executed when max wait timeout is reached.
274-
275-
**Kind**: inner typedef of [<code>PromiseTimeout</code>](#module_puppeteer-extra-plugin-angular.PromiseTimeout)
276-
277-
| Param | Type | Description |
278-
| --- | --- | --- |
279-
| resolve | <code>function</code> | Resolve the promise. |
280-
| reject | <code>function</code> | Reject the promise. |
281-
282-
**Example**
283-
```js
284-
const timeoutExecutor = (resolve, reject) => {
285-
try {
286-
resolve(true);
287-
} catch (ex) {
288-
reject(false);
289-
}
290-
};
291-
```
292199
<a name="module_puppeteer-extra-plugin-angular.Toggle"></a>
293200

294201
### puppeteer-extra-plugin-angular.Toggle
@@ -482,7 +389,7 @@ const response = await logger.debugAndReturn(true, 'debug message %s', Error('er
482389

483390
Development Dependencies
484391
-
485-
You will need to install [Node.js](http://bit.ly/2SMCGXK) as a local development dependency. The `npm` package manager comes bundled with all recent releases of `Node.js`.
392+
You will need to install [Node.js](https://bit.ly/2SMCGXK) as a local development dependency. The `npm` package manager comes bundled with all recent releases of `Node.js`.
486393

487394
`npm install` will attempt to resolve any `npm` module dependencies that have been declared in the project’s `package.json` file, installing them into the `node_modules` folder.
488395

@@ -512,14 +419,14 @@ If you would like to contribute code to Puppeteer Extra Plugin Angular project y
512419

513420
When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible. Please also include appropriate test cases.
514421

515-
Before your code can be accepted into the project you must also sign the [Puppeteer Extra Plugin Angular CLA](http://bit.ly/2Y8t4w9) (Individual Contributor License Agreement).
422+
Before your code can be accepted into the project you must also sign the [Puppeteer Extra Plugin Angular CLA](https://bit.ly/2Y8t4w9) (Individual Contributor License Agreement).
516423

517424
That's it! Thank you for your contribution!
518425

519426
License
520427
-
521428
Copyright (c) 2018 - 2019 Richard Huang.
522429

523-
This plugin is free software, licensed under: [GNU Affero General Public License (AGPL-3.0)](http://bit.ly/2yi7gyO).
430+
This plugin is free software, licensed under: [GNU Affero General Public License (AGPL-3.0)](https://bit.ly/2yi7gyO).
524431

525-
Documentation and other similar content are provided under [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](http://bit.ly/2SMCRlS).
432+
Documentation and other similar content are provided under [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://bit.ly/2SMCRlS).

0 commit comments

Comments
 (0)