Node.js SDK

Herramientas para comunicarse con la API de Virtual Queue en proyectos de Node.js.

Repositorio

Puedes encontrar el repositorio en Github

O puedes ver el paquete @vqueue/sdk en el registro de NPM.

Instalación

Instala el paquete @vqueue/sdk con el gestor de paquetes que utilices. Por ejemplo para npm

npm i @vqueue/sdk

Uso básico

info

Puedes ver ejemplos en el repositorio

Un ejemplo básico del uso en una app en Express es:

import express, { Request, Response } from 'express'
import { verifyToken } from '@vqueue/sdk'

const app = express()

const port = process.env.PORT || 3000

// Verifica el token en '/', donde se espera el parámetro de búsqueda `token`
app.get('/', (req: Request, res: Response) => {
  const token = req.query.token as string

  // Llamada a `verifyToken`
  verifyToken(token)
    // Si no hay problemas con la llamada a la API
    // se obtiene un `VerificationResult` que dice 
    // si el token es válido o no.
    .then((verificationResult) => {
      res.json(verificationResult)
      // Aquí estaría la lógica de tu aplicación discriminando
      // por el valor booleano en `verificationResult.success`
    })
    // En caso de errores como errores de conexión, UUID inválido
    // o cualquier otro error inesperado, se lanza una excepción.
    //
    // Si prefieres puedes usar la función `safeVerifyToken`
    // que nunca lanza excepción sino que devuelve {success: false,
    // message: <exception message>} en caso de errores. 
    .catch((err) => {
      console.log(err)
      res.json({
        error: 'Hubo un error al verificar el token',
        exception_message: err,
      })
    })
})

app.listen(port, () => {
  console.log(`El servidor está corriendo en http://localhost:${port}`)
})

Métodos disponibles

verifyToken(token: string, config?: VQueueVerificationConfig): Promise<VerificationResult>

Verifica el token y retorna el resultado desde la API. config acepta un objeto opcional con el campo verificationURL. Si ocurre algún error se lanza una excepción:

• VQueueInvalidUUID: Si el token no es un UUIDv4 válido.
• VQueueNetworkError: Si hay un error de conexión.
• VQueueError: Si hay algún error inesperado relacionado con la API.

saveVerifyToken(token: string, config?: VQueueVerificationConfig): Promise<VerificationResult>

Verifica el token y retorna el resultado desde la API. config acepta un objeto opcional con el campo verificationURL. Si ocurre algún error el resultado tendrá el campo success: false y la causa en el campo message.