class

RemoteAuth

Source: authStrategies/RemoteAuth.js:55

Remote-based authentication

Methods

checkpoint()
shutdown()

new RemoteAuth(options)

Parameters

Name Type Optional Description

options

 

 

options

Values in options have the following properties:

Name Type Optional Description

store

 

 

Remote database store instance

clientId

 

 

Client id to distinguish instances if you are using multiple, otherwise keep null if you are using only one instance

dataPath

 

 

Change the default path for saving session files, default is: "./.wwebjs_auth/"

backupSyncIntervalMs

 

 

Sets the time interval for periodic session backups. Accepts values starting from 60000ms {1 minute}

initialSyncDelayMs

 

 

Delay before the first checkpoint for a newly paired session

identityResolver

 

 

Trusted resolver for the companion fingerprint; required for verified native PostgreSQL mode

requireFingerprintVerification

 

 

Fail readiness unless the trusted fingerprint matches. Defaults to true in production.

rmMaxRetries

 

 

Sets the maximum number of retries for removing the session directory

Methods

checkpoint()

Queues a serialized durable checkpoint. Periodic calls are coalesced so a slow store can never build an unbounded interval backlog.

async

shutdown()

Persists a final checkpoint without deleting the remote session, then removes the ephemeral Chromium profile.