eddy/whatsapp-web.js
Watch
1
0
Fork
You've already forked whatsapp-web.js
 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

chore(): generate docs

Browse source
This commit is contained in:
WWebJS Bot 2025-12-13 04:56:03 +00:00
commit 376c60668c
76 changed files with 849 additions and 323 deletions
Download patch file Download diff file Expand all files Collapse all files

120
docs/Client.js.html
View file

@ -4,7 +4,7 @@
<head>
<meta name="generator" content="JSDoc 3.6.11">
<meta charset="utf-8">
<title>whatsapp-web.js 1.34.2 &raquo; Source: Client.js</title>
<title>whatsapp-web.js 1.34.3 &raquo; Source: Client.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">
@ -15,7 +15,7 @@
<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>2</a>
<a href="index.html" class="jsdoc-navbar-package-name">whatsapp-web.<wbr>js 1.<wbr>34.<wbr>3</a>
</div>
</div>
</nav>
@ -37,7 +37,7 @@ const moduleRaid &#x3D; require(&#x27;@pedroslopez/moduleraid/moduleraid&#x27;);
const Util &#x3D; require(&#x27;./util/Util&#x27;);
const InterfaceController &#x3D; require(&#x27;./util/InterfaceController&#x27;);
const { WhatsWebURL, DefaultOptions, Events, WAState } &#x3D; require(&#x27;./util/Constants&#x27;);
const { WhatsWebURL, DefaultOptions, Events, WAState, MessageTypes } &#x3D; require(&#x27;./util/Constants&#x27;);
const { ExposeAuthStore } &#x3D; require(&#x27;./util/Injected/AuthStore/AuthStore&#x27;);
const { ExposeStore } &#x3D; require(&#x27;./util/Injected/Store&#x27;);
const { ExposeLegacyAuthStore } &#x3D; require(&#x27;./util/Injected/AuthStore/LegacyAuthStore&#x27;);
@ -58,6 +58,7 @@ const {exposeFunctionIfAbsent} &#x3D; require(&#x27;./util/Puppeteer&#x27;);
* @param {string} options.webVersion - The version of WhatsApp Web to use. Use options.webVersionCache to configure how the version is retrieved.
* @param {object} options.webVersionCache - Determines how to retrieve the WhatsApp Web version. Defaults to a local cache (LocalWebCache) that falls back to latest if the requested version is not found.
* @param {number} options.authTimeoutMs - Timeout for authentication selector in puppeteer
* @param {function} options.evalOnNewDoc - function to eval on new doc
* @param {object} options.puppeteer - Puppeteer launch options. View docs here: https://github.com/puppeteer/puppeteer/
* @param {number} options.qrMaxRetries - How many times should the qrcode be refreshed before giving up
* @param {string} options.restartOnAuthFail - @deprecated This option should be set directly on the LegacySessionAuth.
@ -126,7 +127,22 @@ class Client extends EventEmitter {
* Private function
*/
async inject() {
await this.pupPage.waitForFunction(&#x27;window.Debug?.VERSION !&#x3D; undefined&#x27;, {timeout: this.options.authTimeoutMs});
if(this.options.authTimeoutMs &#x3D;&#x3D;&#x3D; undefined){
this.options.authTimeoutMs &#x3D; 30000;
}
let start &#x3D; Date.now();
let timeout &#x3D; this.options.authTimeoutMs;
let res &#x3D; false;
while(start &gt; (Date.now() - timeout)){
res &#x3D; await this.pupPage.evaluate(&#x27;window.Debug?.VERSION !&#x3D; undefined&#x27;);
if(res){break;}
await new Promise(r &#x3D;&gt; setTimeout(r, 200));
}
if(!res){
throw &#x27;auth timeout&#x27;;
}
await this.setDeviceName(this.options.deviceName, this.options.browserName);
const pairWithPhoneNumber &#x3D; this.options.pairWithPhoneNumber;
const version &#x3D; await this.getWWebVersion();
@ -256,9 +272,17 @@ class Client extends EventEmitter {
await new Promise(r &#x3D;&gt; setTimeout(r, 2000));
await this.pupPage.evaluate(ExposeLegacyStore);
}
// Check window.Store Injection
await this.pupPage.waitForFunction(&#x27;window.Store !&#x3D; undefined&#x27;);
let start &#x3D; Date.now();
let res &#x3D; false;
while(start &gt; (Date.now() - 30000)){
// Check window.Store Injection
res &#x3D; await this.pupPage.evaluate(&#x27;window.Store !&#x3D; undefined&#x27;);
if(res){break;}
await new Promise(r &#x3D;&gt; setTimeout(r, 200));
}
if(!res){
throw &#x27;ready timeout&#x27;;
}
/**
* Current connection information
@ -331,7 +355,7 @@ class Client extends EventEmitter {
page &#x3D; await browser.newPage();
} else {
const browserArgs &#x3D; [...(puppeteerOpts.args || [])];
if(!browserArgs.find(arg &#x3D;&gt; arg.includes(&#x27;--user-agent&#x27;))) {
if(this.options.userAgent !&#x3D;&#x3D; false &amp;amp;&amp;amp; !browserArgs.find(arg &#x3D;&gt; arg.includes(&#x27;--user-agent&#x27;))) {
browserArgs.push(&#x60;--user-agent&#x3D;${this.options.userAgent}&#x60;);
}
// navigator.webdriver fix
@ -344,8 +368,9 @@ class Client extends EventEmitter {
if (this.options.proxyAuthentication !&#x3D;&#x3D; undefined) {
await page.authenticate(this.options.proxyAuthentication);
}
await page.setUserAgent(this.options.userAgent);
if(this.options.userAgent !&#x3D;&#x3D; false) {
await page.setUserAgent(this.options.userAgent);
}
if (this.options.bypassCSP) await page.setBypassCSP(true);
this.pupBrowser &#x3D; browser;
@ -353,7 +378,11 @@ class Client extends EventEmitter {
await this.authStrategy.afterBrowserInitialized();
await this.initWebVersionCache();
if (this.options.evalOnNewDoc !&#x3D;&#x3D; undefined) {
await page.evaluateOnNewDocument(this.options.evalOnNewDoc);
}
// ocVersion (isOfficialClient patch)
// remove after 2.3000.x hard release
await page.evaluateOnNewDocument(() &#x3D;&gt; {
@ -979,9 +1008,10 @@ class Client extends EventEmitter {
*/
async sendMessage(chatId, content, options &#x3D; {}) {
const isChannel &#x3D; /@\w*newsletter\b/.test(chatId);
const isStatus &#x3D; /@\w*broadcast\b/.test(chatId);
if (isChannel &amp;amp;&amp;amp; [
options.sendMediaAsDocument, options.quotedMessageId,
options.sendMediaAsDocument, options.quotedMessageId,
options.parseVCards, options.isViewOnce,
content instanceof Location, content instanceof Contact,
content instanceof Buttons, content instanceof List,
@ -989,6 +1019,16 @@ class Client extends EventEmitter {
].includes(true)) {
console.warn(&#x27;The message type is currently not supported for sending in channels,\nthe supported message types are: text, image, sticker, gif, video, voice and poll.&#x27;);
return null;
} else if (isStatus &amp;amp;&amp;amp; [
options.sendMediaAsDocument, options.quotedMessageId,
options.parseVCards, options.isViewOnce, options.sendMediaAsSticker,
content instanceof Location, content instanceof Contact,
content instanceof Poll, content instanceof Buttons, content instanceof List,
Array.isArray(content) &amp;amp;&amp;amp; content.length &gt; 0 &amp;amp;&amp;amp; content[0] instanceof Contact
].includes(true)) {
console.warn(&#x27;The message type is currently not supported for sending in status broadcast,\nthe supported message types are: text, image, gif, audio and video.&#x27;);
return null;
}
if (options.mentions) {
@ -1224,7 +1264,12 @@ class Client extends EventEmitter {
return ContactFactory.create(this, contact);
}
/**
* Get message by ID
* @param {string} messageId
* @returns {Promise&amp;lt;Message&gt;}
*/
async getMessageById(messageId) {
const msg &#x3D; await this.pupPage.evaluate(async messageId &#x3D;&gt; {
let msg &#x3D; window.Store.Msg.get(messageId);
@ -2001,7 +2046,7 @@ class Client extends EventEmitter {
return labels.map(data &#x3D;&gt; new Label(this, data));
}
/**
* Get all current Broadcast
* @returns {Promise&amp;lt;Array&amp;lt;Broadcast&gt;&gt;}
@ -2013,6 +2058,49 @@ class Client extends EventEmitter {
return broadcasts.map(data &#x3D;&gt; new Broadcast(this, data));
}
/**
* Get broadcast instance by current user ID
* @param {string} contactId
* @returns {Promise&amp;lt;Broadcast&gt;}
*/
async getBroadcastById(contactId) {
const broadcast &#x3D; await this.pupPage.evaluate(async (userId) &#x3D;&gt; {
let status;
try {
status &#x3D; window.Store.Status.get(userId);
if (!status) {
status &#x3D; await window.Store.Status.find(userId);
}
} catch {
status &#x3D; null;
}
if (status) return window.WWebJS.getStatusModel(status);
}, contactId);
return new Broadcast(this, broadcast);
}
/**
* Revoke current own status messages
* @param {string} messageId
* @returns {Promise&amp;lt;void&gt;}
*/
async revokeStatusMessage(messageId) {
return await this.pupPage.evaluate(async (msgId) &#x3D;&gt; {
const status &#x3D; window.Store.Status.getMyStatus();
if (!status) return;
const msg &#x3D;
window.Store.Msg.get(msgId) || (await window.Store.Msg.getMessagesById([msgId]))?.messages?.[0];
if (!msg) return;
if (!msg.id.fromMe || !msg.id.remote.isStatus())
throw &#x27;Invalid usage! Can only revoke the message its from own status broadcast&#x27;;
return await window.Store.StatusUtils.sendStatusRevokeMsgAction(status, msg);
}, messageId);
}
/**
* Get Label instance by ID
* @param {string} labelId
@ -2456,7 +2544,7 @@ class Client extends EventEmitter {
async getPollVotes(messageId) {
const msg &#x3D; await this.getMessageById(messageId);
if (!msg) return [];
if (msg.type !&#x3D; &#x27;poll_creation&#x27;) throw &#x27;Invalid usage! Can only be used with a pollCreation message&#x27;;
if (msg.type !&#x3D; MessageTypes.POLL_CREATION) throw &#x27;Invalid usage! Can only be used with a pollCreation message&#x27;;
const pollVotes &#x3D; await this.pupPage.evaluate( async (msg) &#x3D;&gt; {
const msgKey &#x3D; window.Store.MsgKey.fromString(msg.id._serialized);
@ -2486,7 +2574,7 @@ module.exports &#x3D; Client;
<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 November 6, 2025.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.11 on December 13, 2025.
</p>
</div>
</footer>