ligthjsondb
v1.0.2
Published
This is a package that adds a simple local json based database to your project.
Downloads
14
Readme
LigthJsonDB
LigthJsonDB é um pacote Node.js para a criação de um banco de dados local baseado em JSON. Ele permite realizar operações básicas de CRUD (Create, Read, Update, Delete) em um formato de banco de dados simples e eficiente, ideal para pequenos projetos ou aplicações que necessitam de uma solução de armazenamento de dados rápida e sem a necessidade de um banco de dados completo.
Recursos
- Operações CRUD (Create, Read, Update, Delete) simples e diretas.
- Armazenamento de dados em formato JSON.
- Fácil de integrar e usar em projetos Node.js.
Instalação
npm install ligthjsondb
Uso Básico
Após a instalação, você pode usar o LigthJsonDB da seguinte maneira:
Importando o Pacote
const LigthJsonDB = require('ligthjsondb');
Inicializando o Banco de Dados
Voce pode determinar um caminho personalizado para a pasta database da seguinte forma:
const db = new LigthJsonDB({
databasePath: 'caminho/personalizado/para/o/database'
});
db.init(['clients']);
Caso nao seja definido o caminho para a pasta database, a mesma sera criada na raiz do projeto.
Adicionando Dados
// Adicionando um novo cliente
await db.add('clients', { nome: 'Cristyan', email: '[email protected]' });
Listando Dados
// Listando todos os clientes
const clients = await db.list('clients');
Atualizando Dados
// Atualizando um cliente
await db.update('clients', clientId, { email: '[email protected]' });
Removendo Dados
// Removendo um cliente
await db.remove('clients', clientId);
Exemplo de Uso Completo
Veja abaixo um exemplo completo de como usar o LigthJsonDB, de uma outra maneira:
const LigthJsonDB = require('ligthjsondb');
const db = new LigthJsonDB();
async function main() {
await db.init(['clients']);
// Adicionando um novo cliente
await db.add('clients', {
nome: 'Cristyan',
email: '[email protected]'
}).then(client => {
console.log('Cliente adicionado:', client);
});
// Listando todos os clientes
await db.list('clients').then(clients => {
console.log('Todos os clientes:', clients)
});
// Atualizando um cliente
await db.update('clients', 1, {
email: '[email protected]'
}).then(updatedClient => {
console.log('Cliente atualizado:', updatedClient);
});
// Removendo um cliente
await db.remove('clients', 1).then(clientsAfterDeletion => {
console.log('Clientes apos delecao:', clientsAfterDeletion);
});
}
main().catch(console.error);
Contribuição
Contribuições para o projeto são bem-vindas. Para contribuir, por favor, crie um fork do repositório, faça suas alterações e envie um pull request.
Importante
Esse README oferece uma visão geral do seu projeto, incluindo como instalar, usar e contribuir para ele. Certifique-se de substituir `ligthjsondb` pelo nome real do seu pacote no npm, caso seja diferente.