Skip to content

Crawlee—A web scraping and browser automation library for Node.js to build reliable crawlers. In JavaScript and TypeScript. Extract data for AI, LLMs, RAG, or GPTs. Download HTML, PDF, JPG, PNG, and other files from websites. Works with Puppeteer, Playwright, Cheerio, JSDOM, and raw HTTP. Both headful and headless mode. With proxy rotation.

Add forgotten StealthOptions.md

Ondra Urbane6ca6eb8f3f9
diff --git a/docs/typedefs/StealthOptions.md b/docs/typedefs/StealthOptions.md
new file mode 100644
index 000000000..4e3d311de
--- /dev/null
+++ b/docs/typedefs/StealthOptions.md
@@ -0,0 +1,69 @@
+---
+id: stealthoptions
+title: StealthOptions
+---
+<a name="StealthOptions"></a>
+
+Configuration of stealth tricks for a proper hiding effect all of them should be set to true.
+These tricks are applied only when the `stealth` option is set to `true`.
+
+**Properties**
+<table>
+<thead>
+<tr>
+<th>Param</th><th>Type</th><th>Default</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>[addPlugins]</code></td><td><code>boolean</code></td><td><code>true</code></td>
+</tr>
+<tr>
+<td colspan="3"><p>If plugins should be added to the navigator.</p>
+</td></tr><tr>
+<td><code>[emulateWindowFrame]</code></td><td><code>boolean</code></td><td><code>true</code></td>
+</tr>
+<tr>
+<td colspan="3"><p>Emulates window Iframe.</p>
+</td></tr><tr>
+<td><code>[emulateWebGL]</code></td><td><code>boolean</code></td><td><code>true</code></td>
+</tr>
+<tr>
+<td colspan="3"><p>Emulates graphic card.</p>
+</td></tr><tr>
+<td><code>[emulateConsoleDebug]</code></td><td><code>boolean</code></td><td><code>true</code></td>
+</tr>
+<tr>
+<td colspan="3"><p>Emulates console.debug to return null.</p>
+</td></tr><tr>
+<td><code>[addLanguage]</code></td><td><code>boolean</code></td><td><code>true</code></td>
+</tr>
+<tr>
+<td colspan="3"><p>Adds languages to the navigator.</p>
+</td></tr><tr>
+<td><code>[hideWebDriver]</code></td><td><code>boolean</code></td><td><code>true</code></td>
+</tr>
+<tr>
+<td colspan="3"><p>Hides the webdriver by changing the navigator proto.</p>
+</td></tr><tr>
+<td><code>[hackPermissions]</code></td><td><code>boolean</code></td><td><code>true</code></td>
+</tr>
+<tr>
+<td colspan="3"><p>Fakes interaction with permissions.</p>
+</td></tr><tr>
+<td><code>[mockChrome]</code></td><td><code>boolean</code></td><td><code>true</code></td>
+</tr>
+<tr>
+<td colspan="3"><p>Adds the chrome runtime properties.</p>
+</td></tr><tr>
+<td><code>[mockChromeInIframe]</code></td><td><code>boolean</code></td><td><code>true</code></td>
+</tr>
+<tr>
+<td colspan="3"><p>Adds the chrome runtime properties inside the every newly created iframe.</p>
+</td></tr><tr>
+<td><code>[mockDeviceMemory]</code></td><td><code>boolean</code></td><td><code>true</code></td>
+</tr>
+<tr>
+<td colspan="3"><p>Sets device memory to other value than 0.</p>
+</td></tr></tbody>
+</table>