docs: Translated example code (wppconnect-team#2226)

gekkedev · Jul 18, 2024 · 91b2c40 · 91b2c40
1 parent 5a2239d
commit 91b2c40
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 25 deletions.
diff --git a/docs/getting-started/configuring-logger.md b/docs/getting-started/configuring-logger.md
@@ -79,7 +79,7 @@ const files = new winston.transports.File({ filename: 'combined.log' });
 wppconnect.defaultLogger.add(files); // Add file transport
 
 //Optional: create a custom console with error level
-const console = new winston.transports.Console({ level: 'erro' });
+const console = new winston.transports.Console({ level: 'error' });
 wppconnect.defaultLogger.add(console); // Add console transport
 
 //Optional: Remove the custom transport

diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md
@@ -5,6 +5,10 @@ The first thing that you had to do is install the `npm package`:
 ```bash
 npm i --save @wppconnect-team/wppconnect
 ```
+or with Yarn:
+```bash
+yarn add @wppconnect-team/wppconnect
+```
 
 or for [Nightly releases](https://github.com/wppconnect-team/wppconnect/releases/tag/nightly):
 

diff --git a/docs/getting-started/receiving-messages.md b/docs/getting-started/receiving-messages.md
@@ -18,10 +18,10 @@ function start(client) {
       client
         .sendText(message.from, 'Hello, how I may help you?')
         .then((result) => {
-          console.log('Result: ', result); //return object success
+          console.log('Result: ', result); //return success object
         })
-        .catch((erro) => {
-          console.error('Error when sending: ', erro); //return object error
+        .catch((error) => {
+          console.error('Error when sending: ', error); //return error object
         });
     }
   });

diff --git a/examples/basic/index.js b/examples/basic/index.js
@@ -19,18 +19,18 @@ const wppconnect = require('../../dist');
 wppconnect
   .create()
   .then((client) => start(client))
-  .catch((erro) => {
-    console.log(erro);
+  .catch((error) => {
+    console.log(error);
   });
 
 function start(client) {
   client.onMessage((message) => {
     if (message.body === 'Hi' && message.isGroupMsg === false) {
       client
-        .sendText(message.from, 'Welcome Wppconnect')
+        .sendText(message.from, 'Welcome to Wppconnect')
         .then((result) => {})
-        .catch((erro) => {
-          console.error('Error when sending: ', erro); //return object error
+        .catch((error) => {
+          console.error('Error when sending: ', error); //return error object
         });
     }
   });

diff --git a/examples/bot-functions/index.js b/examples/bot-functions/index.js
@@ -18,7 +18,7 @@ const wppconnect = require('../../dist');
 
 wppconnect
   .create({
-    session: 'teste',
+    session: 'test',
     onLoadingScreen: (percent, message) => {
       console.log('LOADING_SCREEN', percent, message);
     },
@@ -84,30 +84,30 @@ function start(client) {
           await client.setChatState(msg.from, '2');
         }
       } else if (msg.body.startsWith('!btn')) {
-        await client.sendMessageOptions(msg.from, 'teste', {
-          title: 'CALÇA JEN FEMININA',
-          footer: 'Escolha uma opção abaixo',
+        await client.sendMessageOptions(msg.from, 'test', {
+          title: "WOMEN'S JEANS PANTS",
+          footer: 'Choose an option below',
           isDynamicReplyButtonsMsg: true,
           dynamicReplyButtons: [
             {
-              buttonId: 'idSim',
+              buttonId: 'idYes',
               buttonText: {
-                displayText: 'SIM',
+                displayText: 'YES',
               },
               type: 1,
             },
             {
-              buttonId: 'idNao',
+              buttonId: 'idNo',
               buttonText: {
-                displayText: 'NÃO',
+                displayText: 'NO',
               },
               type: 1,
             },
           ],
         });
       }
-    } catch (e) {
-      console.log(e);
+    } catch (error) {
+      console.log(error);
     }
   });
 }
diff --git a/examples/newsletter/index.js b/examples/newsletter/index.js
@@ -18,11 +18,11 @@ const wppconnect = require('../../dist');
 
 wppconnect
   .create({
-    session: 'teste',
+    session: 'test',
   })
   .then((client) => start(client))
-  .catch((erro) => {
-    console.log(erro);
+  .catch((error) => {
+    console.log(error);
   });
 
 function start(client) {

diff --git a/examples/orders/index.js b/examples/orders/index.js
@@ -20,8 +20,8 @@ const froms = [];
 wppconnect
   .create()
   .then((client) => start(client))
-  .catch((erro) => {
-    console.log(erro);
+  .catch((error) => {
+    console.log(error);
   });
 
 function start(client) {
@@ -33,7 +33,7 @@ function start(client) {
       froms.push(message.from);
       client.sendText(
         message.from,
-        `Please, save your order id, and get order for test porpouse`
+        `Please save your order ID, and get your order for testing purposes`
       );
       client.sendText(message.from, `${order.id}`);
     }