@edsonrcoosta/json-database-lib
v1.0.5
Published
Biblioteca para manipulação de um banco de dados JSON
Maintainers
Readme
# Json Database Library
Biblioteca para manipulação de dados JSON simulando uma base de dados. Oferece um CRUD completo e é ideal para projetos pequenos ou ambientes de teste.
## Instalação
Instale o pacote via npm:
```bash
npm install json-database-libConfiguração
Defina o caminho do arquivo JSON e o nome da base no seu .env:
DATABASE_PATH=src/data/database.jsonUso
Importação
Primeiro, importe a classe principal JsonDatabase para começar a usá-la.
import JsonDatabase from 'json-database-lib';Inicialização
Inicialize a classe com a configuração do caminho do banco de dados:
const db = new JsonDatabase();Exemplo Completo de Uso
Inserir um Registro
Para inserir um item em uma tabela:
const newItem = { name: 'Produto 1', price: 100 };
const item = await db.insertItem('produtos', newItem);
console.log('Item inserido:', item);Obter Todos os Itens
Para obter todos os registros de uma tabela específica:
const produtos = await db.getAllItems('produtos');
console.log('Todos os produtos:', produtos);Buscar por ID
Para buscar um item específico usando seu ID:
const produto = await db.getItemById('produtos', 1);
console.log('Produto encontrado:', produto);Buscar por Campo Específico
Para buscar um item usando um campo específico:
const produto = await db.getItemByField('produtos', 'name', 'Produto 1');
console.log('Produto encontrado pelo nome:', produto);Atualizar um Registro
Para atualizar um item específico por ID:
const updatedItem = await db.updateItem('produtos', 1, { price: 120 });
console.log('Item atualizado:', updatedItem);Deletar um Registro
Para deletar um item específico por ID:
const isDeleted = await db.deleteItem('produtos', 1);
console.log('Item deletado:', isDeleted);Tratamento de Erros
A biblioteca possui tratamento de erros interno. Caso o arquivo JSON não exista ou ocorra um problema na leitura/escrita, uma mensagem de erro será exibida e a operação não será realizada.
Lembre-se de:
Verificar o Nome do Pacote: Certifique-se de que o nome no
package.jsonesteja correto comojson-database-lib.Atualizar o README: Salve as alterações no README.md após fazer a correção.
Publicar Novamente: Depois de garantir que tudo está correto, você pode tentar publicar novamente com:
npm publish
Contribuição
Se você encontrar algum problema ou tiver sugestões de melhorias, sinta-se à vontade para abrir um issue ou enviar um pull request.
### Ajustes Feitos:
1. **Correção de Formatação**: Ajustei a formatação geral para garantir que o markdown fique consistente e legível.
2. **Fechamento do Bloco de Códigos**: Assegurei que todos os blocos de código estejam corretamente fechados.
3. **Clareza na Documentação**: Mantive a clareza e a estrutura lógica para facilitar o entendimento por parte dos usuários.
Agora, seu README está pronto para ser utilizado! Certifique-se de revisá-lo antes de publicar.