feat: customise linked device name (#3325)

* feat: add functionality for setting device and browser names

* feat: add usage example

* feat: add usage example

* docs: add docs for new functionality

* docs: add missing property

* docs: supplement the implementation documentation
This commit is contained in:
alechkos 2025-08-06 15:50:42 +03:00 • committed by GitHub
commit ca30ac4b18
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 37 additions and 0 deletions

View file

@ -3,6 +3,17 @@ const { Client, Location, Poll, List, Buttons, LocalAuth } = require('./index');
const client = new Client({
authStrategy: new LocalAuth(),
// proxyAuthentication: { username: 'username', password: 'password' },
/**
* This option changes the browser name from defined in user agent to custom.
*/
// deviceName: 'Your custom name',
/**
* This option changes browser type from defined in user agent to yours. It affects the browser icon
* that is displayed in 'linked devices' section.
* Valid value are: 'Chrome' | 'Firefox' | 'IE' | 'Opera' | 'Safari' | 'Edge'.
* If another value is provided, the browser icon in 'linked devices' section will be gray.
*/
// browserName: 'Firefox',
puppeteer: {
// args: ['--proxy-server=proxy-server-that-requires-authentication.example.com'],
headless: false,