@desco/front-to-sequelize

Allows Sequelize JS to interpret information passed through the frontend

Usage no npm install needed!

<script type="module">
  import descoFrontToSequelize from 'https://cdn.skypack.dev/@desco/front-to-sequelize';
</script>

README

@desco/front-to-sequelize

Pacote que permite interpretar no [SequelizeJS](https://sequelize.org/) informações passadas pelo frontend via QueryString.

Licença MIT Versão 1.0.0

🚀 Pronto para uso! 🚀

Veja outros projetos NPM aqui.

Veja outros projetos aqui.


📋 Tabela de conteúdos


⚙️ Instalação

npm install --save @desco/front-to-sequelize

Note que será necessário ter o NPM instalado para o comando funcionar.


📦 Importação

const frontToSequelize = require("@desco/front-to-sequelize");

📚 Como Usar

No frontend, envie para o backend uma querystring com as informações que deseja que o SequelizeJS receba.

Essa querystring deverá estar no mesmo formato da documentação do SequelizeJS, com algumas diferenças que serão listadas abaixo:

  • Operadores - Quando precisar utilizar algum operador, utilize o prefixo Op. seguido do nome do operador desejado. Por exemplo: Op.or;
  • Funções - Quando precisar utilizar alguma função, utilize o prefixo Fn. seguido do nome da função desejada com os parâmetros entre parênteses. Por exemplo: Fn.max(p1, p2, p3, ...., p50);
  • Colunas - Quando precisar selecionar alguma coluna, utilize Col() contendo nos parênteses o nome da coluna desejada. Por exemplo: Col(name);

No backend, receba e trate a querystring com o frontToSequelize para em seguida utilizar no SequelizeJS, por exemplo:

const params = frontToSequelize(queryString);

ModelSequelize.findAndCountAll(params).then((result) => {
  console.log(result);
});

Autor

Rafael A. R. Dias Email eu@diasrafael.com.br Linkedin @diasrafael Facebook @eudiasrafael GitHub Overview @descodifica GitHub NPM @desco-npm NPM @desco