Interface CreateOptions

interface CreateOptions {
    autoClose?: number;
    browser?: Browser | BrowserContext;
    browserArgs?: string[];
    browserSessionToken?: SessionToken;
    browserWS?: string;
    catchLinkCode?: LinkByCodeCallback;
    catchQR?: CatchQRCallback;
    createPathFileToken?: boolean;
    debug?: boolean;
    deviceName?: string | false;
    deviceSyncTimeout?: number;
    devtools?: boolean;
    disableGoogleAnalytics?: boolean;
    disableWelcome?: boolean;
    folderNameToken?: string;
    googleAnalyticsId?: string;
    headless?: boolean | "shell";
    linkPreviewApiServers?: string[];
    logger?: Logger;
    logQR?: boolean;
    mkdirFolderToken?: string;
    onLoadingScreen?: LoadingScreenCallback;
    page?: Page;
    phoneNumber?: string;
    poweredBy?: string;
    proxy?: {
        password: string;
        url: string;
        username: string;
    };
    puppeteerOptions?: PuppeteerLaunchOptions;
    session?: string;
    sessionToken?: SessionToken;
    statusFind?: StatusFindCallback;
    tokenStore?: string | TokenStore<SessionToken>;
    updatesLog?: boolean;
    useChrome?: boolean;
    waitForLogin?: boolean;
    whatsappVersion?: string;
}

Hierarchy (view full)

Properties

autoClose? browser? browserArgs? browserSessionToken? browserWS? catchLinkCode? catchQR? createPathFileToken? debug? deviceName? deviceSyncTimeout? devtools? disableGoogleAnalytics? disableWelcome? folderNameToken? googleAnalyticsId? headless? linkPreviewApiServers? logger? logQR? mkdirFolderToken? onLoadingScreen? page? phoneNumber? poweredBy? proxy? puppeteerOptions? session? sessionToken? statusFind? tokenStore? updatesLog? useChrome? waitForLogin? whatsappVersion?

Properties

OptionalautoClose

autoClose?: number

Automatically closes the wppconnect only when scanning the QR code (default 60000 miliseconds, if you want to turn it off, assign 0 or false)

Default

60000

Optionalbrowser

browser?: Browser | BrowserContext

Pass a external browser instance, can be used with electron

OptionalbrowserArgs

browserArgs?: string[]

Parameters to be added into the chrome browser instance

OptionalbrowserSessionToken

browserSessionToken?: SessionToken

Pass the session token information you can receive this token with the await client.getSessionTokenBrowser () function

Deprecated

in favor of sessionToken

OptionalbrowserWS

browserWS?: string

If you want to use browserWSEndpoint

OptionalcatchLinkCode

catchLinkCode?: LinkByCodeCallback

A callback will be received, informing a code to you connect

OptionalcatchQR

catchQR?: CatchQRCallback

A callback will be received, informing the status of the qrcode

OptionalcreatePathFileToken

createPathFileToken?: boolean

Creates a folder when inserting an object in the client's browser, to work it is necessary to pass the parameters in the function create browserSessionToken

Deprecated

See tokenStore

Default

true

Optionaldebug

debug?: boolean

Opens a debug session

Default

false

OptionaldeviceName

deviceName?: string | false

Define the connected device name in WhatsApp app

Default

'WPPConnect'

OptionaldeviceSyncTimeout

deviceSyncTimeout?: number

Automatically closes the wppconnect only when is syncing the device (default 180000 miliseconds, 3 minutes, if you want to turn it off, assign 0 or false)

Default

180000 (3 minutes)

Optionaldevtools

devtools?: boolean

Open devtools by default

Default

false

OptionaldisableGoogleAnalytics

disableGoogleAnalytics?: boolean

Disable custom Google Analytics

Default

true

OptionaldisableWelcome

disableWelcome?: boolean

Will disable the welcoming message which appears in the beginning

Default

false

OptionalfolderNameToken

folderNameToken?: string

Folder name when saving tokens if tokenStore is 'file'.

Default

'tokens'

OptionalgoogleAnalyticsId

googleAnalyticsId?: string

Custom Google Analytics Tracker Id, like 'G-XXXXXXXXXX' collect analytics data to your GA account

Default

null

Optionalheadless

headless?: boolean | "shell"

Headless chrome

Default

true

OptionallinkPreviewApiServers

linkPreviewApiServers?: string[]

Set custom Link Preview API servers

Default

null

Optionallogger

logger?: Logger

Wait for in chat to return a instance of Whatsapp

Default

false

OptionallogQR

logQR?: boolean

Logs QR automatically in terminal

Default

true

OptionalmkdirFolderToken

mkdirFolderToken?: string

folder directory tokens, just inside the wppconnect folder, example: { mkdirFolderToken: '/node_modules', } //will save the tokens folder in the node_modules directory

Deprecated

See tokenStore

OptionalonLoadingScreen

onLoadingScreen?: LoadingScreenCallback

A callback will be received, informing data as percentage and loading screen message

Optionalpage

page?: Page

Pass a external page instance, can be used with electron

OptionalphoneNumber

phoneNumber?: string

Insert the phone number for connect by link phone, qr code not wil generate

OptionalpoweredBy

poweredBy?: string

Custom variable for Google Analytics

Default

'WPPConnect'

Optionalproxy

proxy?: {
    password: string;
    url: string;
    username: string;
}

Define the proxy settings for the connection

Type declaration

  • password: string

    The password for the proxy server

  • url: string

    The URL of the proxy server

  • username: string

    The username for the proxy server

Default

null

OptionalpuppeteerOptions

puppeteerOptions?: PuppeteerLaunchOptions

Will be passed to puppeteer.launch

Optionalsession

session?: string

You must pass a string type parameter, this parameter will be the name of the client's session. If the parameter is not passed, the section name will be "session".

OptionalsessionToken

sessionToken?: SessionToken

Initial token to log in in WhatsApp. If not passed, the client will get it from tokenStore.

Deprecated

OptionalstatusFind

statusFind?: StatusFindCallback

A callback will be received, informing the customer's status

OptionaltokenStore

tokenStore?: string | TokenStore<SessionToken>

Token store used to manage token tokenStore

Default

'file'

Deprecated

OptionalupdatesLog

updatesLog?: boolean

Logs info updates automatically in terminal

Default

true

OptionaluseChrome

useChrome?: boolean

If false will use Chromium instance

Default

true

OptionalwaitForLogin

waitForLogin?: boolean

Wait for in chat to return a instance of Whatsapp

Default

false

OptionalwhatsappVersion

whatsappVersion?: string

Quando definido, essa opção força o carregamento de uma versão específica do WhatsApp WEB Normalmente, versões mais antigas continuam funcionando por mais um tempo, assim, com essa opção, é possível ter uma janela de tempo maior para se preparar para atualizações. Caso seja definido vazio ou null, será usado a versão atual, ou seja, sem forçar versão específica.

Default

2.2134.x

Settings

Member Visibility

On This Page

Properties