chore(): generate docs
This commit is contained in:
WWebJS Bot
parent
2dbcf8ab5d
commit
28a2d3630c
76 changed files with 890 additions and 313 deletions
142
docs/index.html
142
docs/index.html
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta name="generator" content="JSDoc 3.6.11">
|
||||
<meta charset="utf-8">
|
||||
<title>whatsapp-web.js 1.34.1 » Home</title>
|
||||
<title>whatsapp-web.js 1.34.2 » Home</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">
|
||||
|
|
@ -13,7 +13,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>1</a>
|
||||
<a href="index.html" class="jsdoc-navbar-package-name">whatsapp-web.<wbr>js 1.<wbr>34.<wbr>2</a>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
|
@ -26,14 +26,14 @@
|
|||
<div id="jsdoc-main" role="main">
|
||||
<header class="page-header">
|
||||
<h1>
|
||||
whatsapp-web.js 1.34.1
|
||||
whatsapp-web.js 1.34.2
|
||||
</h1>
|
||||
</header>
|
||||
|
||||
<article><div align="center">
|
||||
<br />
|
||||
<p>
|
||||
<a href="https://wwebjs.dev"><img src="https://github.com/wwebjs/logos/blob/main/4_Full%20Logo%20Lockup_Small/small_banner_blue.png?raw=true" title="whatsapp-web.js" alt="WWebJS Website" width="500" /></a>
|
||||
<a href="https://wwebjs.dev"><img src="https://github.com/wwebjs/assets/blob/main/Collection/GitHub/wwebjs.png?raw=true" title="whatsapp-web.js" alt="WWebJS Website" width="500" /></a>
|
||||
</p>
|
||||
<br />
|
||||
<p>
|
||||
|
|
@ -45,45 +45,27 @@
|
|||
<br />
|
||||
</div>
|
||||
<h2>About</h2>
|
||||
<p><strong>A WhatsApp API client that connects through the WhatsApp Web browser app</strong></p>
|
||||
<p>The library works by launching the WhatsApp Web browser application and managing it using Puppeteer to create an instance of WhatsApp Web, thereby mitigating the risk of being blocked. The WhatsApp API client connects through the WhatsApp Web browser app, accessing its internal functions. This grants you access to nearly all the features available on WhatsApp Web, enabling dynamic handling similar to any other Node.js application.</p>
|
||||
<p><strong>A WhatsApp API client that operates via the WhatsApp Web browser.</strong></p>
|
||||
<p>The library launches the WhatsApp Web browser app via Puppeteer, accessing its internal functions and creating a managed instance to reduce the risk of being blocked. This gives the API client nearly all WhatsApp Web features for dynamic use in a Node.js application.</p>
|
||||
<blockquote>
|
||||
<p>[!IMPORTANT]
|
||||
<strong>It is not guaranteed you will not be blocked by using this method. WhatsApp does not allow bots or unofficial clients on their platform, so this shouldn't be considered totally safe.</strong></p>
|
||||
</blockquote>
|
||||
<h2>Links</h2>
|
||||
<ul>
|
||||
<li><a href="https://wwebjs.dev">Website</a></li>
|
||||
<li><a href="https://guide.wwebjs.dev/guide">Guide</a> (<a href="https://github.com/wwebjs/wwebjs.dev/tree/main">source</a>) <em>(work in progress)</em></li>
|
||||
<li><a href="https://docs.wwebjs.dev/">Documentation</a> (<a href="https://github.com/pedroslopez/whatsapp-web.js/tree/main/docs">source</a>)</li>
|
||||
<li><a href="https://discord.gg/H7DqQs4">WWebJS Discord</a></li>
|
||||
<li><a href="https://github.com/pedroslopez/whatsapp-web.js">GitHub</a></li>
|
||||
<li><a href="https://guide.wwebjs.dev/guide">Guide</a> (<a href="https://github.com/wwebjs/wwebjs.dev/tree/main">source</a>)</li>
|
||||
<li><a href="https://docs.wwebjs.dev/">Documentation</a> (<a href="https://github.com/pedroslopez/whatsapp-web.js/tree/main/docs">source</a>)</li>
|
||||
<li><a href="https://discord.gg/H7DqQs4">Discord Server</a></li>
|
||||
<li><a href="https://npmjs.org/package/whatsapp-web.js">npm</a></li>
|
||||
</ul>
|
||||
<h2>Installation</h2>
|
||||
<p>The module is now available on npm! <code>npm i whatsapp-web.js</code></p>
|
||||
<p>The module is available on <a href="https://npmjs.org/package/whatsapp-web.js">npm</a> via <code>npm i whatsapp-web.js</code>!</p>
|
||||
<blockquote>
|
||||
<p>[!NOTE]
|
||||
<strong>Node <code>v18+</code> is required.</strong></p>
|
||||
<strong>Node <code>v18</code> or higher, is required.</strong><br>
|
||||
See the <a href="https://guide.wwebjs.dev/guide">Guide</a> for quick upgrade instructions.</p>
|
||||
</blockquote>
|
||||
<h2>QUICK STEPS TO UPGRADE NODE</h2>
|
||||
<h3>Windows</h3>
|
||||
<h4>Manual</h4>
|
||||
<p>Just get the latest LTS from the <a href="https://nodejs.org/en/download/">official node website</a>.</p>
|
||||
<h4>npm</h4>
|
||||
<pre class="prettyprint source lang-powershell"><code>sudo npm install -g n
|
||||
sudo n stable
|
||||
</code></pre>
|
||||
<h4>Choco</h4>
|
||||
<pre class="prettyprint source lang-powershell"><code>choco install nodejs-lts
|
||||
</code></pre>
|
||||
<h4>Winget</h4>
|
||||
<pre class="prettyprint source lang-powershell"><code>winget install OpenJS.NodeJS.LTS
|
||||
</code></pre>
|
||||
<h3>Ubuntu / Debian</h3>
|
||||
<pre class="prettyprint source lang-bash"><code>curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash - &&\
|
||||
sudo apt-get install -y nodejs
|
||||
</code></pre>
|
||||
<h2>Example usage</h2>
|
||||
<pre class="prettyprint source lang-js"><code>const { Client } = require('whatsapp-web.js');
|
||||
|
||||
|
|
@ -836,6 +818,11 @@ limitations under the License.</p></article>
|
|||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Chat.html#addOrEditCustomerNote" class="!symbol-index-name">Chat#<wbr>addOrEditCustomerNote(note)</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Chat.html#archive" class="!symbol-index-name">Chat#<wbr>archive()</a>
|
||||
</dt>
|
||||
|
|
@ -877,12 +864,12 @@ limitations under the License.</p></article>
|
|||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Chat.html#getLabels" class="!symbol-index-name">Chat#<wbr>getLabels()</a>
|
||||
<a href="Chat.html#getCustomerNote" class="!symbol-index-name">Chat#<wbr>getCustomerNote()</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Chat.html#getPinnedMessages" class="!symbol-index-name">Chat#<wbr>getPinnedMessages()</a>
|
||||
<a href="Chat.html#getLabels" class="!symbol-index-name">Chat#<wbr>getLabels()</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
|
|
@ -891,6 +878,11 @@ limitations under the License.</p></article>
|
|||
|
||||
<div class="symbol-index-column">
|
||||
<dl class="symbol-index-list">
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Chat.html#getPinnedMessages" class="!symbol-index-name">Chat#<wbr>getPinnedMessages()</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Chat.html#id" class="!symbol-index-name">Chat#<wbr>id</a>
|
||||
</dt>
|
||||
|
|
@ -1075,6 +1067,11 @@ limitations under the License.</p></article>
|
|||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Client.html#addOrEditCustomerNote" class="!symbol-index-name">Client#<wbr>addOrEditCustomerNote(userId, note)</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Client.html#addOrRemoveLabels" class="!symbol-index-name">Client#<wbr>addOrRemoveLabels(labelIds, chatIds)</a>
|
||||
</dt>
|
||||
|
|
@ -1345,6 +1342,11 @@ limitations under the License.</p></article>
|
|||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Client.html#getCustomerNote" class="!symbol-index-name">Client#<wbr>getCustomerNote(userId)</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Client.html#getFormattedNumber" class="!symbol-index-name">Client#<wbr>getFormattedNumber(number)</a>
|
||||
</dt>
|
||||
|
|
@ -1380,6 +1382,11 @@ limitations under the License.</p></article>
|
|||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Client.html#getPollVotes" class="!symbol-index-name">Client#<wbr>getPollVotes(messageId)</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Client.html#getProfilePicUrl" class="!symbol-index-name">Client#<wbr>getProfilePicUrl(contactId)</a>
|
||||
</dt>
|
||||
|
|
@ -1410,16 +1417,16 @@ limitations under the License.</p></article>
|
|||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Client.html#isRegisteredUser" class="!symbol-index-name">Client#<wbr>isRegisteredUser(id)</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
|
||||
<div class="symbol-index-column">
|
||||
<dl class="symbol-index-list">
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Client.html#isRegisteredUser" class="!symbol-index-name">Client#<wbr>isRegisteredUser(id)</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Client.html#logout" class="!symbol-index-name">Client#<wbr>logout()</a>
|
||||
</dt>
|
||||
|
|
@ -1968,6 +1975,11 @@ limitations under the License.</p></article>
|
|||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="GroupChat.html#addOrEditCustomerNote" class="!symbol-index-name">GroupChat#<wbr>addOrEditCustomerNote(note)</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="GroupChat.html#addParticipants" class="!symbol-index-name">GroupChat#<wbr>addParticipants(participantIds, options)</a>
|
||||
</dt>
|
||||
|
|
@ -2038,6 +2050,11 @@ limitations under the License.</p></article>
|
|||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="GroupChat.html#getCustomerNote" class="!symbol-index-name">GroupChat#<wbr>getCustomerNote()</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="GroupChat.html#getGroupMembershipRequests" class="!symbol-index-name">GroupChat#<wbr>getGroupMembershipRequests()</a>
|
||||
</dt>
|
||||
|
|
@ -2048,16 +2065,16 @@ limitations under the License.</p></article>
|
|||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="GroupChat.html#getLabels" class="!symbol-index-name">GroupChat#<wbr>getLabels()</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
|
||||
<div class="symbol-index-column">
|
||||
<dl class="symbol-index-list">
|
||||
<dt class="symbol-index-name">
|
||||
<a href="GroupChat.html#getLabels" class="!symbol-index-name">GroupChat#<wbr>getLabels()</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="GroupChat.html#getPinnedMessages" class="!symbol-index-name">GroupChat#<wbr>getPinnedMessages()</a>
|
||||
</dt>
|
||||
|
|
@ -2781,16 +2798,16 @@ limitations under the License.</p></article>
|
|||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
|
||||
<div class="symbol-index-column">
|
||||
<dl class="symbol-index-list">
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Message.html#getGroupMentions" class="!symbol-index-name">Message#<wbr>getGroupMentions()</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
|
||||
<div class="symbol-index-column">
|
||||
<dl class="symbol-index-list">
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Message.html#getInfo" class="!symbol-index-name">Message#<wbr>getInfo()</a>
|
||||
</dt>
|
||||
|
|
@ -2811,6 +2828,11 @@ limitations under the License.</p></article>
|
|||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Message.html#getPollVotes" class="!symbol-index-name">Message#<wbr>getPollVotes()</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Message.html#getQuotedMessage" class="!symbol-index-name">Message#<wbr>getQuotedMessage()</a>
|
||||
</dt>
|
||||
|
|
@ -2876,16 +2898,16 @@ limitations under the License.</p></article>
|
|||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
|
||||
<div class="symbol-index-column">
|
||||
<dl class="symbol-index-list">
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Message.html#links" class="!symbol-index-name">Message#<wbr>links</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
|
||||
<div class="symbol-index-column">
|
||||
<dl class="symbol-index-list">
|
||||
<dt class="symbol-index-name">
|
||||
<a href="Message.html#location" class="!symbol-index-name">Message#<wbr>location</a>
|
||||
</dt>
|
||||
|
|
@ -3529,6 +3551,11 @@ limitations under the License.</p></article>
|
|||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="PrivateChat.html#addOrEditCustomerNote" class="!symbol-index-name">PrivateChat#<wbr>addOrEditCustomerNote(note)</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="PrivateChat.html#archive" class="!symbol-index-name">PrivateChat#<wbr>archive()</a>
|
||||
</dt>
|
||||
|
|
@ -3570,12 +3597,12 @@ limitations under the License.</p></article>
|
|||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="PrivateChat.html#getLabels" class="!symbol-index-name">PrivateChat#<wbr>getLabels()</a>
|
||||
<a href="PrivateChat.html#getCustomerNote" class="!symbol-index-name">PrivateChat#<wbr>getCustomerNote()</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="PrivateChat.html#getPinnedMessages" class="!symbol-index-name">PrivateChat#<wbr>getPinnedMessages()</a>
|
||||
<a href="PrivateChat.html#getLabels" class="!symbol-index-name">PrivateChat#<wbr>getLabels()</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
|
|
@ -3584,6 +3611,11 @@ limitations under the License.</p></article>
|
|||
|
||||
<div class="symbol-index-column">
|
||||
<dl class="symbol-index-list">
|
||||
<dt class="symbol-index-name">
|
||||
<a href="PrivateChat.html#getPinnedMessages" class="!symbol-index-name">PrivateChat#<wbr>getPinnedMessages()</a>
|
||||
</dt>
|
||||
<dd>
|
||||
</dd>
|
||||
<dt class="symbol-index-name">
|
||||
<a href="PrivateChat.html#id" class="!symbol-index-name">PrivateChat#<wbr>id</a>
|
||||
</dt>
|
||||
|
|
@ -4344,7 +4376,7 @@ limitations under the License.</p></article>
|
|||
<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 September 10, 2025.
|
||||
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> 3.6.11 on November 6, 2025.
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
|
|
|
|||
Loading…
Reference in a new issue