recommended.md

recommended

This is a preset for using the recommended plugins:

• polyfill:
  • automation
  • headless
  • screen
  • viewport
  • webdriver
• humanize:
  • click
  • cursor
  • dialog

Options

Plugin options can be provided:

• polyfill:
  • screen: polyfill.screen plugins options.
  • viewport: polyfill.viewport plugins options.
• humanize:
  • click: humanize.click plugins options.
  • cursor: humanize.cursor plugins options.
  • dialog: humanize.dialog plugins options.

Plugins can be disabled by passing the value to false.

Examples

Use the preset with default options.

import { chromium } from "playwright-ghost";
import plugins from "playwright-ghost/plugins";

const browser = await chromium.launch({
  plugins: plugins.recommended(),
});
// ...

Use the preset and specify polyfill.screen, humanize.click and humanize.cursor plugin options.

import { chromium } from "playwright-ghost";
import plugins from "playwright-ghost/plugins";

const browser = await chromium.launch({
  plugins: plugins.recommended({
    polyfill: {
      screen: { width: 2560, height: 1440 },
    },
    humanize: {
      click: { delay: { min: 50, max: 200 } },
      cursor: { start: { x: 100, y: 100 } },
    },
  }),
});
// ...

Use all recommended plugins except polyfill.headless.

import { chromium } from "playwright-ghost";
import plugins from "playwright-ghost/plugins";

const browser = await chromium.launch({
  plugins: plugins.recommended({
    polyfill: {
      headless: false,
    },
  }),
});
// ...

Use all recommended plugins except humanize plugins (click, cursor and dialog).

import { chromium } from "playwright-ghost";
import plugins from "playwright-ghost/plugins";

const browser = await chromium.launch({
  plugins: plugins.recommended({
    humanize: false,
  }),
});
// ...

Advanced

Import

If you want to import only this preset, you can use the "playwright-ghost/plugins/recommended" path in the import.

import { chromium } from "playwright-ghost";
import recommendedPlugins from "playwright-ghost/plugins/recommended";

const browser = await chromium.launch({
  plugins: recommendedPlugins(),
});
// ...