Pending XHR Puppeteer


| Introduction
| Installation
| Usage
| Contribute |

Introduction

Pending XHR Puppeteer is a tool that detect when there is xhr requests not yet finished. You can use it to have a xhr requests count or to wait for all xhr requests to be finished.

Installation

To install with yarn :

``bash
yarn add pending-xhr-puppeteer -D
`

To install with npm :

`bash
npm install pending-xhr-puppeteer --save-dev
`

Usage

$3

`javascript
const puppeteer = require('puppeteer');
const { PendingXHR } = require('pending-xhr-puppeteer');

const browser = await puppeteer.launch({
headless: true,
args,
});

const page = await browser.newPage();
const pendingXHR = new PendingXHR(page);
await page.goto(http://page-with-xhr);
// Here all xhr requests are not finished
await pendingXHR.waitForAllXhrFinished();
// Here all xhr requests are finished
`

$3

`javascript
const puppeteer = require('puppeteer');
const { PendingXHR } = require('pending-xhr-puppeteer');

const browser = await puppeteer.launch({
headless: true,
args,
});

const page = await browser.newPage();
const pendingXHR = new PendingXHR(page);
await page.goto(http://page-with-xhr);
console.log(pendingXHR.pendingXhrCount());
// Display the number of xhr pending
`

$3

If you need to wait xhrs but not longer than a specific time, You can race pending-xhr-puppeteer and setTimeout in a Promise.race.

`javascript
const puppeteer = require('puppeteer');
const { PendingXHR } = require('pending-xhr-puppeteer');

const browser = await puppeteer.launch({
headless: true,
args,
});

const page = await browser.newPage();
const pendingXHR = new PendingXHR(page);
await page.goto(http://page-with-xhr);
// We will wait max 1 seconde for xhrs
await Promise.race([
pendingXHR.waitForAllXhrFinished(),
new Promise(resolve => {
setTimeout(resolve, 1000);
}),
]);
console.log(pendingXHR.pendingXhrCount());
// May or may not have pending xhrs
`

Wait for all xhr triggered by an event

You can use this lib to wait for xhr triggered by any event from the UI (click, typing, ...).

Exemple :

`javascript
await page.goto(http://page-with-xhr);
await page.click('.my-selector'); // This action will trigger some xhr
// Here all xhr requests triggered by the click are not finished
await pendingXHR.waitForAllXhrFinished();
// Here all xhr requests triggered by the click are finished
`

Contribute

`bash
git clone https://github.com/jtassin/pending-xhr-puppeteer.git
cd pending-xhr-puppeteer
yarn
yarn test
``

Merge requests and issues are welcome.