Skip to content
PhantomJS resource pool based on generic-pool
Branch: master
Clone or download
Latest commit 563d4c2 Jul 2, 2017
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Fix #12 Jul 1, 2017
test feat(maxUses): added maxUses test Feb 7, 2017
.babelrc Update example in README to use require instead of import and use add… Jun 30, 2017
.eslintrc initial commit Nov 28, 2016
.gitignore ignore npmrc Nov 28, 2016
.npmignore initial commit Nov 28, 2016
.travis.yml initial commit Nov 28, 2016
LICENSE initial commit Nov 28, 2016 Update TravisCI badge Jul 2, 2017
package.json 1.2.2 Jul 1, 2017


Build Status

Resource pool based on generic-pool for PhantomJS.

Creating new phantom instances with phantom.create() can be slow. If you are frequently creating new instances and destroying them, as a result of HTTP requests for example, this module can help by keeping a pool of phantom instances alive and making it easy to re-use them across requests.

Here's an artificial benchmark to illustrate:

Starting benchmark without pool

noPool-0: 786.829ms
noPool-1: 790.822ms
noPool-2: 795.150ms
noPool-3: 788.928ms
noPool-4: 793.788ms
noPool-5: 798.075ms
noPool-6: 813.130ms
noPool-7: 803.801ms
noPool-8: 782.936ms
noPool-9: 805.630ms

Starting benchmark with pool

pool-0: 48.160ms
pool-1: 98.966ms
pool-2: 89.573ms
pool-3: 99.057ms
pool-4: 101.970ms
pool-5: 102.967ms
pool-6: 102.938ms
pool-7: 99.359ms
pool-8: 101.972ms
pool-9: 103.309ms


Using pool in this benchmark results in an average >8x speed increase.


npm install --save phantom-pool

Requires Node v6+


See ./test directory for usage examples.

const createPhantomPool = require('phantom-pool')

// Returns a generic-pool instance
const pool = createPhantomPool({
  max: 10, // default
  min: 2, // default
  // how long a resource can stay idle in pool before being removed
  idleTimeoutMillis: 30000, // default.
  // maximum number of times an individual resource can be reused before being destroyed; set to 0 to disable
  maxUses: 50, // default
  // function to validate an instance prior to use; see
  validator: () => Promise.resolve(true), // defaults to always resolving true
  // validate resource before borrowing; required for `maxUses and `validator`
  testOnBorrow: true, // default
  // For all opts, see opts at
  phantomArgs: [['--ignore-ssl-errors=true', '--disk-cache=true'], {
    logLevel: 'debug',
  }], // arguments passed to phantomjs-node directly, default is `[]`. For all opts, see

// Automatically acquires a phantom instance and releases it back to the
// pool when the function resolves or throws
pool.use(async (instance) => {
  const page = await instance.createPage()
  const status = await'', { operation: 'GET' })
  if (status !== 'success') {
    throw new Error('cannot open')
  const content = await'content')
  return content
}).then((content) => {

// Destroying the pool:
pool.drain().then(() => pool.clear())

// For more API doc, see


When using phantom-pool, you should be aware that the phantom instance you are getting might not be in a completely clean state. It could have browser history, cookies or other persistent data from a previous use.

If that is an issue for you, make sure you clean up any sensitive data on the phantom instance before returning it to the pool.

You can’t perform that action at this time.