1
1
## WebPageTest API Wrapper for NodeJS
2
2
3
- [ ![ Build Status] ( https://secure.travis-ci.org/marcelduran/webpagetest-api.png ?branch=master )] ( https://travis-ci.org/marcelduran/webpagetest-api )
3
+ [ ![ Build Status] ( https://secure.travis-ci.org/marcelduran/webpagetest-api.svg ?branch=master )] ( https://travis-ci.org/marcelduran/webpagetest-api )
4
4
[ ![ NPM Version] ( https://img.shields.io/npm/v/webpagetest.svg?style=flat )] ( https://www.npmjs.org/package/webpagetest )
5
5
[ ![ NPM Downloads] ( https://img.shields.io/npm/dm/webpagetest.svg?style=flat )] ( https://www.npmjs.org/package/webpagetest )
6
- [ ![ Dependencies Status] ( https://david-dm.org/marcelduran/webpagetest-api.png )] ( https://david-dm.org/marcelduran/webpagetest-api )
6
+ [ ![ Dependencies Status] ( https://david-dm.org/marcelduran/webpagetest-api.svg )] ( https://david-dm.org/marcelduran/webpagetest-api )
7
7
8
8
[ WebPageTest API Wrapper] ( https://marcelduran.com/webpagetest-api ) is a [ NPM] ( https://npmjs.org ) package that wraps [ WebPageTest] ( https://github.com/WPO-Foundation/webpagetest ) API for [ NodeJS] ( https://nodejs.org ) as a module and a command-line tool.
9
9
@@ -32,10 +32,10 @@ $ docker run -it --rm webpagetest-api -k YOURAPIKEY test https://twitter.com/mar
32
32
33
33
### Module
34
34
``` javascript
35
- var WebPageTest = require (' webpagetest' );
36
- var wpt = new WebPageTest (' www.webpagetest.org' );
35
+ const WebPageTest = require (' webpagetest' );
36
+ const wpt = new WebPageTest (' www.webpagetest.org' );
37
37
38
- wpt .runTest (' https://twitter.com/marcelduran' , function (err , data ) {
38
+ wpt .runTest (' https://twitter.com/marcelduran' , (err , data ) => {
39
39
console .log (err || data);
40
40
});
41
41
```
@@ -372,7 +372,7 @@ Methods and options (including the one letter shorthands) are the same when usin
372
372
### Parameters
373
373
* ** id** : test ID string _ required_
374
374
* ** options** : parameters object _ optional_ , see below
375
- * ** callback** : the callback ` function (error, data)` _ optional _
375
+ * ** callback** : the callback ` (error, data) ` _ optional=> _
376
376
* ** url_or_script** : decoded url or script string _ required_
377
377
* ** port** : port number _ optional_ \[ default: 7791\]
378
378
* ** script** : script array in the format:
@@ -393,7 +393,7 @@ Methods and options (including the one letter shorthands) are the same when usin
393
393
* ` scriptToString ` script array values 1-N are optional. e.g:
394
394
395
395
``` javascript
396
- var script = wpt .scriptToString ([
396
+ const script = wpt .scriptToString ([
397
397
{logData: 0 },
398
398
{navigate: ' http://foo.com/login' },
399
399
{logData: 1 },
@@ -402,7 +402,8 @@ var script = wpt.scriptToString([
402
402
{submitForm: ' action=http://foo.com/main' },
403
403
' waitForComplete'
404
404
]);
405
- wpt .runTest (script, function (err , data ) {
405
+
406
+ wpt .runTest (script, (err , data ) => {
406
407
console .log (err || data);
407
408
});
408
409
```
@@ -524,36 +525,36 @@ wpt.runTest(script, function(err, data) {
524
525
525
526
#### 1. Instantiating
526
527
``` javascript
527
- var WebPageTest = require (' webpagetest' );
528
+ const WebPageTest = require (' webpagetest' );
528
529
529
- var wpt = new WebPageTest (' my-wpt.foo.com' ); // default: www.webpagetest.org
530
- var wptPublic = new WebPageTest (' www.webpagetest.org' , ' MY_API_KEY' );
530
+ const wpt = new WebPageTest (' my-wpt.foo.com' ); // default: www.webpagetest.org
531
+ const wptPublic = new WebPageTest (' www.webpagetest.org' , ' MY_API_KEY' );
531
532
```
532
533
533
534
#### 2. Get available locations
534
535
``` javascript
535
- wpt .getLocations (function (err , data ) {
536
+ wpt .getLocations ((err , data ) => {
536
537
console .log (err || data);
537
538
});
538
539
```
539
540
540
541
#### 3. Run test on https://twitter.com/marcelduran from San Jose on IE9
541
542
``` javascript
542
- wpt .runTest (' https://twitter.com/marcelduran' , {location: ' SanJose_IE9' }, function (err , data ) {
543
+ wpt .runTest (' https://twitter.com/marcelduran' , {location: ' SanJose_IE9' }, (err , data ) => {
543
544
console .log (err || data);
544
545
});
545
546
```
546
547
547
548
#### 4. Check current test status
548
549
``` javascript
549
- wpt .getTestStatus (' 121025_PT_N8K' , function (err , data ) {
550
+ wpt .getTestStatus (' 121025_PT_N8K' , (err , data ) => {
550
551
console .log (err || data);
551
552
});
552
553
```
553
554
554
555
#### 5. Get test results
555
556
``` javascript
556
- wpt .getTestResults (' 121025_PT_N8K' , function (err , data ) {
557
+ wpt .getTestResults (' 121025_PT_N8K' , (err , data ) => {
557
558
console .log (err || data);
558
559
});
559
560
```
@@ -564,21 +565,21 @@ wpt.getWaterfallImage('121025_PT_N8K', {
564
565
thumbnail: true ,
565
566
repeatView: true ,
566
567
dataURI: true
567
- }, function (err , data , info ) {
568
+ }, (err , data , info ) => {
568
569
console .log (err || data, info);
569
570
});
570
571
```
571
572
572
573
#### Run test on https://twitter.com/marcelduran and poll results every 5 seconds timing out in 60 seconds
573
574
``` javascript
574
- wpt .runTest (' https://twitter.com/marcelduran' , {pollResults: 5 , timeout: 60 }, function (err , data ) {
575
+ wpt .runTest (' https://twitter.com/marcelduran' , {pollResults: 5 , timeout: 60 }, (err , data ) => {
575
576
console .log (err || data);
576
577
});
577
578
```
578
579
579
580
#### Or run test on https://twitter.com/marcelduran and wait results listening on localhost\* port 8000\*\*
580
581
``` javascript
581
- wpt .runTest (' https://twitter.com/marcelduran' , {waitResults: ' localhost:8000' }, function (err , data ) {
582
+ wpt .runTest (' https://twitter.com/marcelduran' , {waitResults: ' localhost:8000' }, (err , data ) => {
582
583
console .log (err || data);
583
584
});
584
585
```
@@ -616,13 +617,13 @@ https://localhost:8443
616
617
617
618
### Module
618
619
``` javascript
619
- var server = wpt .listen (8080 , function (err , data ) {
620
+ const server = wpt .listen (8080 , (err , data ) => {
620
621
if (err) throw err;
621
622
console .log (' listening on ' + data .url );
622
623
}); // listen on port 8080 (optional), default port is 7791
623
624
624
- setTimeout (function () {
625
- server .close (function () {
625
+ setTimeout (() => {
626
+ server .close (() => {
626
627
console .log (' server closed' );
627
628
});
628
629
}, 10000 ); // wait for 10s before stop listening
0 commit comments