Resumo, objetivos e inspirações

JS Utils foi criado pensando no "re-uso" constante de códigos e suas recriações em projetos distintos. Por conta dessa necessidade de recriar os recursos em multiplos projetos, foi pensado na criação dessa biblioteca para comportar esses recursos em um único (e pequeno) lugar.

ATENÇÃO: Esta é uma biblioteca em desenvolvimento, até o momento não recomendo o uso pois poderá haver mudanças mais à frente. Não nos responsabilizamos por possíveis problemas que aqui serão modificados

Sumário

• Instalando a biblioteca
• Padrões de uso da biblioteca
  • Usando um RegExp
  • Usando um Auxiliador (Helper)
  • Usando um Utiliário (util)
• Recursos de RegExp
• Recursos auxiliadores
• Recursos utilitários
• Suporte
• Patrocinadores
• Mantenedores
• Licença de uso

Instalando a biblioteca

Instalando usando o npm:

npm i @voolture-tech/js-utils

Padrões de uso da biblioteca

O foco desta biblioteca é facilitar o seu uso e consumo, portanto todos os seus recursos são de fácil acesso. Sempre que pensar em um novo recurso verifique se o mesmo já está contido na biblioteca, caso não esteja solicite-nos criando um novo issue. Sua participação é muito importante para a evolução desse projeto.

Sem mais delongas, vamos usar um exemplo de um recurso axiliador (helper) e um recurso utilitário (util) para que veja seu funcionamento.

Usando um RegExp

Alguns RegExp muito comuns são utilizados com uma certa constância, portanto adicionamos alguns disponíveis em Javascript para serem reaproveitados.

Portanto, o mesmo possui um modo próprio de uso que são destacados por @voolture-tech/js-utils/regexp seguindo o exemplo abaixo

import { email__regexp } from "@voolture-tech/js-utils/regexp"

email__regexp.test("[email protected]") 

O Exemplo acima retornará true. Veja mais em RegExp

Usando um Auxiliador (helper)

Os auxiliadores possuem seu modo de utilizacão próprio que são destacados por @voolture-tech/js-uitls/helpers seguindo o exemplo abaixo

import { secondsToMs } from "@voolture-tech/js-utils/helpers"

const seconds = 3 // Escolhido 3 segundos para esse exemplo
console.log(secondsToMs(seconds))

O exemplo acima retornará 3000 que será do tipo Number. Veja mais em secondsToMs.

Usando um Utiliário (util)

Os utilitários (utils) são funcões mais objetivas e inveligentes, que são requisitadas diretamente pela raiz da biblioteca @voolture-tech, veja o exemplo abaixo:

import { delay } from "@voolture-tech/js-utils"

const start = Date.now()
console.log(`iniciado em ${start}`)

const seconds = 4 // Foi escolhido 4 segundos de espera
delay(seconds).then(() => {
  const end = Date.now()
  console.log(`finalizado em ${end}. Tempo de espera de ${end - start}`)
})

O exemplo acima aguardará o tempo de 4 segundos para exercer o log dos tempos de início e fim do comando. Saiba mais sobre o delay.

_ Os recursos utiliários (utils), em sua grande maioria, consomem recursos auxiliadores (helpers) internamente ao funcionamento da biblioteca, mas nunca o contrário. _

_ Os recursos utilitários (utils) e auxiliadores (helpers) consomem internamente os recursos RegExp ao funcionamento da biblioteca, mas nunca o contrário _

Recursos RegExp

Veja a documentação e lista de RegExp disponíveis clicando aqui.

Recursos auxiliadores (helpers)

| Recurso | Objetivo | Entrada | Saída | | -------------------------------------------------- | ---------------------------------------------- | ----------------- | ------ | | msToSeconds | Converter milessegundos para segundos | (ms: Number) | Number | | secondsToMs | Converter segundos para milessegundos | (seconds: Number) | Number |

Recursos utilitários (utils)

| Recurso | Objetivo | Entrada | Saída | | -------------------------------------------------- | ---------------------------------------------- | ------------------------------------ | ------------------- | | delay | Aguardar um determinado tempo para continuar | (seconds: Number) | Promise void | | getFileSizeByBytes | converte bytes para uma string legível | (bytes: number) | string | | switcher | Seleciona uma opção a partir de uma lista | (list: object, selected: keyof list) | list item (unknown) |

Suporte

Esta biblioteca no momento está em fase de desenvolvimento, algumas correções, melhorias e novos recursos serão implementados até a versão 1.0. Para quaisquer eventuais problemas com os recursos ou compatibilidade aqui encontrado, crie uma issue que responderei para a solução/solicitação da mesma.

Patrocinadores

Em breve teremos algumas formas disponíveis para você nos ajudar a manter esse projeto

Mantenedores

Esse projeto existe somente pelas pessoas que para aqui contribuem.

Licença de uso

js-utils utiliza a licença MIT.