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
@@ -22,10 +22,10 @@ $ webpagetest test https://twitter.com/marcelduran
22
22
23
23
### Module
24
24
``` javascript
25
- var WebPageTest = require (' webpagetest' );
26
- var wpt = new WebPageTest (' www.webpagetest.org' );
25
+ const WebPageTest = require (' webpagetest' );
26
+ const wpt = new WebPageTest (' www.webpagetest.org' );
27
27
28
- wpt .runTest (' https://twitter.com/marcelduran' , function (err , data ) {
28
+ wpt .runTest (' https://twitter.com/marcelduran' , (err , data ) => {
29
29
console .log (err || data);
30
30
});
31
31
```
@@ -362,7 +362,7 @@ Methods and options (including the one letter shorthands) are the same when usin
362
362
### Parameters
363
363
* ** id** : test ID string _ required_
364
364
* ** options** : parameters object _ optional_ , see below
365
- * ** callback** : the callback ` function (error, data)` _ optional _
365
+ * ** callback** : the callback ` (error, data) ` _ optional=> _
366
366
* ** url_or_script** : decoded url or script string _ required_
367
367
* ** port** : port number _ optional_ \[ default: 7791\]
368
368
* ** script** : script array in the format:
@@ -383,7 +383,7 @@ Methods and options (including the one letter shorthands) are the same when usin
383
383
* ` scriptToString ` script array values 1-N are optional. e.g:
384
384
385
385
``` javascript
386
- var script = wpt .scriptToString ([
386
+ const script = wpt .scriptToString ([
387
387
{logData: 0 },
388
388
{navigate: ' http://foo.com/login' },
389
389
{logData: 1 },
@@ -392,7 +392,8 @@ var script = wpt.scriptToString([
392
392
{submitForm: ' action=http://foo.com/main' },
393
393
' waitForComplete'
394
394
]);
395
- wpt .runTest (script, function (err , data ) {
395
+
396
+ wpt .runTest (script, (err , data ) => {
396
397
console .log (err || data);
397
398
});
398
399
```
@@ -514,36 +515,36 @@ wpt.runTest(script, function(err, data) {
514
515
515
516
#### 1. Instantiating
516
517
``` javascript
517
- var WebPageTest = require (' webpagetest' );
518
+ const WebPageTest = require (' webpagetest' );
518
519
519
- var wpt = new WebPageTest (' my-wpt.foo.com' ); // default: www.webpagetest.org
520
- var wptPublic = new WebPageTest (' www.webpagetest.org' , ' MY_API_KEY' );
520
+ const wpt = new WebPageTest (' my-wpt.foo.com' ); // default: www.webpagetest.org
521
+ const wptPublic = new WebPageTest (' www.webpagetest.org' , ' MY_API_KEY' );
521
522
```
522
523
523
524
#### 2. Get available locations
524
525
``` javascript
525
- wpt .getLocations (function (err , data ) {
526
+ wpt .getLocations ((err , data ) => {
526
527
console .log (err || data);
527
528
});
528
529
```
529
530
530
531
#### 3. Run test on https://twitter.com/marcelduran from San Jose on IE9
531
532
``` javascript
532
- wpt .runTest (' https://twitter.com/marcelduran' , {location: ' SanJose_IE9' }, function (err , data ) {
533
+ wpt .runTest (' https://twitter.com/marcelduran' , {location: ' SanJose_IE9' }, (err , data ) => {
533
534
console .log (err || data);
534
535
});
535
536
```
536
537
537
538
#### 4. Check current test status
538
539
``` javascript
539
- wpt .getTestStatus (' 121025_PT_N8K' , function (err , data ) {
540
+ wpt .getTestStatus (' 121025_PT_N8K' , (err , data ) => {
540
541
console .log (err || data);
541
542
});
542
543
```
543
544
544
545
#### 5. Get test results
545
546
``` javascript
546
- wpt .getTestResults (' 121025_PT_N8K' , function (err , data ) {
547
+ wpt .getTestResults (' 121025_PT_N8K' , (err , data ) => {
547
548
console .log (err || data);
548
549
});
549
550
```
@@ -554,21 +555,21 @@ wpt.getWaterfallImage('121025_PT_N8K', {
554
555
thumbnail: true ,
555
556
repeatView: true ,
556
557
dataURI: true
557
- }, function (err , data , info ) {
558
+ }, (err , data , info ) => {
558
559
console .log (err || data, info);
559
560
});
560
561
```
561
562
562
563
#### Run test on https://twitter.com/marcelduran and poll results every 5 seconds timing out in 60 seconds
563
564
``` javascript
564
- wpt .runTest (' https://twitter.com/marcelduran' , {pollResults: 5 , timeout: 60 }, function (err , data ) {
565
+ wpt .runTest (' https://twitter.com/marcelduran' , {pollResults: 5 , timeout: 60 }, (err , data ) => {
565
566
console .log (err || data);
566
567
});
567
568
```
568
569
569
570
#### Or run test on https://twitter.com/marcelduran and wait results listening on localhost\* port 8000\*\*
570
571
``` javascript
571
- wpt .runTest (' https://twitter.com/marcelduran' , {waitResults: ' localhost:8000' }, function (err , data ) {
572
+ wpt .runTest (' https://twitter.com/marcelduran' , {waitResults: ' localhost:8000' }, (err , data ) => {
572
573
console .log (err || data);
573
574
});
574
575
```
@@ -606,13 +607,13 @@ https://localhost:8443
606
607
607
608
### Module
608
609
``` javascript
609
- var server = wpt .listen (8080 , function (err , data ) {
610
+ const server = wpt .listen (8080 , (err , data ) => {
610
611
if (err) throw err;
611
612
console .log (' listening on ' + data .url );
612
613
}); // listen on port 8080 (optional), default port is 7791
613
614
614
- setTimeout (function () {
615
- server .close (function () {
615
+ setTimeout (() => {
616
+ server .close (() => {
616
617
console .log (' server closed' );
617
618
});
618
619
}, 10000 ); // wait for 10s before stop listening
0 commit comments