Skip to content

Commit 0f2f73a

Browse files
authored
Merge pull request #84 from amilajack/patch-1
Updated examples to es6
2 parents 8edf823 + 76e68b3 commit 0f2f73a

File tree

1 file changed

+22
-21
lines changed

1 file changed

+22
-21
lines changed

README.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
## WebPageTest API Wrapper for NodeJS
22

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)
44
[![NPM Version](https://img.shields.io/npm/v/webpagetest.svg?style=flat)](https://www.npmjs.org/package/webpagetest)
55
[![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)
77

88
[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.
99

@@ -32,10 +32,10 @@ $ docker run -it --rm webpagetest-api -k YOURAPIKEY test https://twitter.com/mar
3232

3333
### Module
3434
```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');
3737

38-
wpt.runTest('https://twitter.com/marcelduran', function(err, data) {
38+
wpt.runTest('https://twitter.com/marcelduran', (err, data) => {
3939
console.log(err || data);
4040
});
4141
```
@@ -372,7 +372,7 @@ Methods and options (including the one letter shorthands) are the same when usin
372372
### Parameters
373373
* **id**: test ID string _required_
374374
* **options**: parameters object _optional_, see below
375-
* **callback**: the callback `function(error, data)` _optional_
375+
* **callback**: the callback `(error, data)` _optional=> _
376376
* **url_or_script**: decoded url or script string _required_
377377
* **port**: port number _optional_ \[default: 7791\]
378378
* **script**: script array in the format:
@@ -393,7 +393,7 @@ Methods and options (including the one letter shorthands) are the same when usin
393393
* `scriptToString` script array values 1-N are optional. e.g:
394394

395395
```javascript
396-
var script = wpt.scriptToString([
396+
const script = wpt.scriptToString([
397397
{logData: 0},
398398
{navigate: 'http://foo.com/login'},
399399
{logData: 1},
@@ -402,7 +402,8 @@ var script = wpt.scriptToString([
402402
{submitForm: 'action=http://foo.com/main'},
403403
'waitForComplete'
404404
]);
405-
wpt.runTest(script, function(err, data) {
405+
406+
wpt.runTest(script, (err, data) => {
406407
console.log(err || data);
407408
});
408409
```
@@ -524,36 +525,36 @@ wpt.runTest(script, function(err, data) {
524525

525526
#### 1. Instantiating
526527
```javascript
527-
var WebPageTest = require('webpagetest');
528+
const WebPageTest = require('webpagetest');
528529

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');
531532
```
532533

533534
#### 2. Get available locations
534535
```javascript
535-
wpt.getLocations(function(err, data) {
536+
wpt.getLocations((err, data) => {
536537
console.log(err || data);
537538
});
538539
```
539540

540541
#### 3. Run test on https://twitter.com/marcelduran from San Jose on IE9
541542
```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) => {
543544
console.log(err || data);
544545
});
545546
```
546547

547548
#### 4. Check current test status
548549
```javascript
549-
wpt.getTestStatus('121025_PT_N8K', function(err, data) {
550+
wpt.getTestStatus('121025_PT_N8K', (err, data) => {
550551
console.log(err || data);
551552
});
552553
```
553554

554555
#### 5. Get test results
555556
```javascript
556-
wpt.getTestResults('121025_PT_N8K', function(err, data) {
557+
wpt.getTestResults('121025_PT_N8K', (err, data) => {
557558
console.log(err || data);
558559
});
559560
```
@@ -564,21 +565,21 @@ wpt.getWaterfallImage('121025_PT_N8K', {
564565
thumbnail: true,
565566
repeatView: true,
566567
dataURI: true
567-
}, function(err, data, info) {
568+
}, (err, data, info) => {
568569
console.log(err || data, info);
569570
});
570571
```
571572

572573
#### Run test on https://twitter.com/marcelduran and poll results every 5 seconds timing out in 60 seconds
573574
```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) => {
575576
console.log(err || data);
576577
});
577578
```
578579

579580
#### Or run test on https://twitter.com/marcelduran and wait results listening on localhost\* port 8000\*\*
580581
```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) => {
582583
console.log(err || data);
583584
});
584585
```
@@ -616,13 +617,13 @@ https://localhost:8443
616617

617618
### Module
618619
```javascript
619-
var server = wpt.listen(8080, function(err, data) {
620+
const server = wpt.listen(8080, (err, data) => {
620621
if (err) throw err;
621622
console.log('listening on ' + data.url);
622623
}); // listen on port 8080 (optional), default port is 7791
623624

624-
setTimeout(function() {
625-
server.close(function() {
625+
setTimeout(() => {
626+
server.close(() => {
626627
console.log('server closed');
627628
});
628629
}, 10000); // wait for 10s before stop listening

0 commit comments

Comments
 (0)