Merge pull request #880 from william-monroy/docs/idle

docs: (✏️) added documentation for idle feature
codigoencasa · Oct 9, 2023 · 6677522 · 6677522
2 parents f42f8ec + bf23558
commit 6677522
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 10 deletions.
diff --git a/packages/docs/src/root.tsx b/packages/docs/src/root.tsx
@@ -47,6 +47,7 @@ export default component$(() => {
                 { name: 'fallBack', link: '/docs/fall-back' },
                 { name: 'endFlow', link: '/docs/end-flow' },
                 { name: 'gotoFlow', link: '/docs/goto-flow' },
+                { name: 'idle', link: '/docs/idle' },
                 { name: 'blacklist', link: '/docs/blacklist' },
             ],
         },

diff --git a/packages/docs/src/routes/docs/idle/index.mdx b/packages/docs/src/routes/docs/idle/index.mdx
@@ -0,0 +1,45 @@
+import Navigation from '../../../components/widgets/Navigation'
+
+# idle
+
+Esta funcionalidad te permite dada una cantidad de tiempo de inactividad en el chat, ejecutar una acción.
+
+## Ejemplo
+
+En el siguiente ejemplo, si el usuario no responde en 2 segundos, se ejecutará la acción de cancelar el flujo.
+
+```js
+const { addKeyword } = require('@bot-whatsapp/bot')
+
+const flujoFinal = addKeyword(EVENTS.ACTION).addAnswer('Se canceló por inactividad')
+
+const flujoPrincipal = addKeyword(['hola'])
+    .addAnswer(
+        'Debes de responder antes de que transcurran 2 segundos',
+        { capture: true, idle: 2000 }, // idle: 2000 = 2 segundos
+        async (ctx, { gotoFlow, inRef }) => {
+            if (ctx?.idleFallBack) {
+                return gotoFlow(flujoFinal)
+            }
+        }
+    )
+    .addAnswer('gracias!')
+
+```
+
+## API
+
+### Propiedades
+
+- **idle** - Tiempo de inactividad en milisegundos
+- **idleFallBack** - Si se ejecutó la acción por inactividad
+
+
+---
+
+<Navigation
+    pages={[
+        { name: 'Instalación', link: '/docs/install' },
+        { name: 'Conceptos', link: '/docs/essential' },
+    ]}
+/>
diff --git a/packages/docs/src/services/github.ts b/packages/docs/src/services/github.ts
@@ -11,18 +11,13 @@ export const fetchGithub = async (token: string) => {
             Authorization: `Bearer ${token}`,
         },
     })
-    const listUsers = await data.json()
+    try {
+        const listUsers = await data.json()
         return listUsers.map((u: any) => ({
             ...u,
             avatar_url: `${u.avatar_url}&s=80`,
         }))
-    // try {
-    //     const listUsers = await data.json()
-    //     return listUsers.map((u: any) => ({
-    //         ...u,
-    //         avatar_url: `${u.avatar_url}&s=80`,
-    //     }))
-    // } catch (error) {
-    //     return []
-    // }
+    } catch (error) {
+        return []
+    }
 }