mongeasyjs
v1.2.8
Published
<table align="center"> <tr> <td> <a href="https://github.com/its-vitor/mongeasy"> <img src="https://github.com/its-vitor/mongeasy/assets/146399948/fd2a722a-74cd-4b2e-b265-f5f69cd29ff4" width="600"> </a> </td> <td> <
Downloads
3
Readme
Sobre
O Mongeasy
é uma biblioteca projetada para simplificar o uso do Mongoose. Com uma interface mais amigável, foi desenvolvida para pequenos e médios serviços que buscam maneiras mais simples e práticas de interagir com o banco de dados MongoDB. O Mongeasy
agiliza o processo de interação com o banco de dados ao oferecer uma abordagem intuitiva que resume operações complexas em apenas uma chamada de função.
- Objetivo: Simplificar o trabalho dos desenvolvedores em ter que produzir diversas funções para otimizarem seus códigos e torna-los mais práticos, visto que
Mongeasy
trata-se de um grande template de tudo que é possível se fazer com o MongoDB.
Dependências
mongoose ^7.6.3
bcrypt ^5.1.1
jsonwebtoken ^9.0.2
Utilização
Primeiro, instale o pacote mongeasy utilizando o npm.
npm install mongeasyjs
em seguida, você pode instanciar a classe Mongeasy e estabelecer uma conexão atráves do url do seu MongoDB
import { Mongeasy } from "mongeasyjs"
const url = ""
Mongeasy.startConnection(url)
Abaixo, alguns exemplos de utilização das funções do mongeasy
import {
Mongeasy,
SchemaManager,
FieldBuilder
} from "mongeasyjs"
Mongeasy.startConnection('linkDoMongo')
.then(console.log("Connect!"))
.catch((error) => console.error(error));
/**
* Na utilização de cada função, é necessário adicionar
* ou um modelo, ou o nome da coleção que deseja trabalhar.
* Você pode adicionar buscando pela coleção através
* de seu nome, no parâmetro "collection", ou com model.
*/
Mongeasy.insertOne({ collection: 'test', document: { test: 'olá' } })
/**
* Para fazer interações com o banco de dados com um model
* -, é necessário, antes, criar um Schema. Utilize a classe
* builder "SchemaBuilder" para criar um schema.
*/
const userSchema = new SchemaBuilder()
/**
* A classe "FieldBuilder" é responsável pela construção
* das "configurações" de cada atributo/elemento do seu
* Schema. O método Insert pede primeiro o nome do atributo
* e em seguida as suas opções de configuração.
*/
.insert('test', new FieldBuilder().setType('String').build());
const userModel = SchemaManager.createModel({
name: "Test", // Nome do modelo
collection: "TestCollection" // Nome da coleção
}, userSchema)
/**
* Insere um documento a uma coleção.
* Desse modo, não é necessário buscar pelo model pela
* sua string, sendo feito diretamente pelo método de
* SchemaManager.
*/
Mongeasy.insertOne({ model: userModel, document: { test: 'olá' }})