whatsapp-web.js/docs/authStrategies_LocalAuth.js.html

<!doctype html>
<html>

<head>
  <meta name="generator" content="JSDoc 3.6.11">
  <meta charset="utf-8">
  <title>whatsapp-web.js 1.34.7 &raquo; Source: authStrategies/LocalAuth.js</title>
  <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Karla:400,400i,700,700i" type="text/css">
  <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Noto+Serif:400,400i,700,700i" type="text/css">
  <link rel="stylesheet" href="https://brick.a.ssl.fastly.net/Inconsolata:500" type="text/css">
  <link href="css/baseline.css" rel="stylesheet">
</head>

<body onload="prettyPrint()">
  <nav id="jsdoc-navbar" role="navigation" class="jsdoc-navbar">
    <div id="jsdoc-navbar-container">
      <div id="jsdoc-navbar-content">
        <a href="index.html" class="jsdoc-navbar-package-name">whatsapp-web.<wbr>js 1.<wbr>34.<wbr>7</a>
      </div>
    </div>
  </nav>
  <div id="jsdoc-body-container">
    <div id="jsdoc-content">
      <div id="jsdoc-content-container">
        <div id="jsdoc-banner" role="banner">
        </div>
        <div id="jsdoc-main" role="main">
          <header class="page-header">
            <h1>Source: authStrategies/LocalAuth.js</h1>
          </header>
          <article>
            <pre class="prettyprint linenums"><code>&#x27;use strict&#x27;;

const path &#x3D; require(&#x27;path&#x27;);
const fs &#x3D; require(&#x27;fs&#x27;);
const BaseAuthStrategy &#x3D; require(&#x27;./BaseAuthStrategy&#x27;);

/**
 * Local directory-based authentication
 * @param {object} options - options
 * @param {string} options.clientId - Client id to distinguish instances if you are using multiple, otherwise keep null if you are using only one instance
 * @param {string} options.dataPath - Change the default path for saving session files, default is: &quot;./.wwebjs_auth/&quot;
 * @param {number} options.rmMaxRetries - Sets the maximum number of retries for removing the session directory
 */
class LocalAuth extends BaseAuthStrategy {
    constructor({ clientId, dataPath, rmMaxRetries } &#x3D; {}) {
        super();

        const idRegex &#x3D; /^[-_\w]+$/i;
        if (clientId &amp;amp;&amp;amp; !idRegex.test(clientId)) {
            throw new Error(
                &#x27;Invalid clientId. Only alphanumeric characters, underscores and hyphens are allowed.&#x27;,
            );
        }

        this.dataPath &#x3D; path.resolve(dataPath || &#x27;./.wwebjs_auth/&#x27;);
        this.clientId &#x3D; clientId;
        this.rmMaxRetries &#x3D; rmMaxRetries ?? 4;
    }

    async beforeBrowserInitialized() {
        const puppeteerOpts &#x3D; this.client.options.puppeteer;
        const sessionDirName &#x3D; this.clientId
            ? &#x60;session-${this.clientId}&#x60;
            : &#x27;session&#x27;;
        const dirPath &#x3D; path.join(this.dataPath, sessionDirName);

        if (
            puppeteerOpts.userDataDir &amp;amp;&amp;amp;
            puppeteerOpts.userDataDir !&#x3D;&#x3D; dirPath
        ) {
            throw new Error(
                &#x27;LocalAuth is not compatible with a user-supplied userDataDir.&#x27;,
            );
        }

        fs.mkdirSync(dirPath, { recursive: true });

        this.client.options.puppeteer &#x3D; {
            ...puppeteerOpts,
            userDataDir: dirPath,
        };

        this.userDataDir &#x3D; dirPath;
    }

    async logout() {
        if (this.userDataDir) {
            await fs.promises
                .rm(this.userDataDir, {
                    recursive: true,
                    force: true,
                    maxRetries: this.rmMaxRetries,
                })
                .catch((e) &#x3D;&gt; {
                    throw new Error(e);
                });
        }
    }
}

module.exports &#x3D; LocalAuth;
</code></pre>
          </article>
        </div>
      </div>
      <nav id="jsdoc-toc-nav" role="navigation"></nav>
    </div>
  </div>
  <footer id="jsdoc-footer" class="jsdoc-footer">
    <div id="jsdoc-footer-container">
      <p>
        Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.11 on April 24, 2026.
      </p>
    </div>
  </footer>
  <script src="scripts/jquery.min.js"></script>
  <script src="scripts/tree.jquery.js"></script>
  <script src="scripts/prettify.js"></script>
  <script src="scripts/jsdoc-toc.js"></script>
  <script src="scripts/linenumber.js"></script>
  <script src="scripts/scrollanchor.js"></script>
</body>

</html>