@agtm/nuxt-tools

@agtm/Nuxt Tools

Module with useful tools for Nuxt projects

Features

• ⛰ getEnvConfig

Quick Setup

1. Add @agtm/nuxt-tools dependency to your project

# Using npm
npm install --save-dev @agtm/nuxt-tools
npm install @agtm/nuxt-tools

2. Add @agtm/nuxt-tools/module to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    '@agtm/nuxt-tools'
  ]
})

That's it! You can now use My Module in your Nuxt app ✨

Guia de Uso: NuxtTool

Exemplo de uso:

<script setup>

  import { useNuxtTools } from '#imports'

  const {getEnvConfig} = useNuxtTools

</script>

Guia de Uso: SocketTools

connect

Conecta automaticamente no servidor socket à partir das varaiveis de ambiente:

NUXT_PUBLIC_SOCKET_HTTPS=true
NUXT_PUBLIC_SOCKET_HOSTNAME=localhost
NUXT_PUBLIC_SOCKET_PORT=3001

ATENÇÃO: Não esqueça de definir essas váriaveis no nuxt_config para o nuxt carrega-las:

runtimeConfig: {
  public: {
    socketHttps: false,
    socketHostname: '',
    socketPort: ''
  }
}

Exemplo de Uso:

<script setup>

  import { io } from 'socket.io-client'
  import { useSocketTools } from '#imports'
  
  const socket = useSocketTools.connect(io, '/jobs')

</script>

Guia de Uso: useTools

getEnvConfig

Carrega um atributo público definido com runtimeconfig e definido com uma variável de ambiente, validando se foi definido.

• Parâmetros:
  • attributeName (string): Nome do atributo a ser carregado e validado.
  • required (boolean): Se é requerido. Padrão é true.
• Retorno: Promise

calculateEta

Calcula o Tempo Estimado de Chegada (ETA) para atingir 100% de progresso.

• Parâmetros:
  • startAt (Date|string): Data/hora de início do processo. Aceita um objeto Date do JavaScript ou uma string que pode ser convertida em Date.
  • progress (number): Porcentagem atual de progresso, deve estar entre 0 e 100 (exclusivo).
• Retorno: string|null. Retorna o tempo estimado restante para atingir 100% de progresso de forma legível.
• Exceções: Lança um erro se o progresso não estiver entre 0 e 100 (exclusivo).

encryptText

Criptografa um texto dado usando um algoritmo de hash especificado.

• Parâmetros:
  • text (string): O texto a ser criptografado.
  • algorithm (string): O algoritmo de hash a ser usado. Padrão é 'SHA-256'.
• Retorno: Promise
• Exceções: Lançará um erro se o algoritmo de hash não for suportado.

const encryptedText = await encryptText('hello');
console.log(encryptedText);  // Saídas do texto criptografado em formato hexadecimal.

Development

Reference: https://nuxt.com/docs/guide/going-further/modules

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release