fishdbjj
v0.0.5-beta
Published
um banco de dados simples em JSON.
Downloads
4
Readme
fishDB
um banco de dados simples em JSON.
Instalação
npm install fishdbjj
Uso
const fishDB = require("fishdbjj");
const db = new fishDB("./caminho/nome do banco de dados"); // Se não houver retornará o nome padrão (database).
db.adicionar("key","value"); // Salva uma chave e seu valor no banco de dados.
console.log(db.obter("key")); // Mostrará o valor da chave armazenada no banco de dados.
Funções
addChave(key, value)
- Descrição: Adiciona uma chave-valor ao nível superior do banco de dados, se a chave não existir.
- Parâmetros:
key
- Nome da chave.value
- Valor a ser associado à chave.
addGrupo(key)
- Descrição: Adiciona um grupo ao banco de dados, representado por um objeto vazio, se o grupo não existir.
- Parâmetros:
key
- Nome do grupo.
chaveAddGrupo(grupo, key, value)
- Descrição: Adiciona uma chave-valor a um grupo existente.
- Parâmetros:
grupo
- Nome do grupo.key
- Nome da chave.value
- Valor a ser associado à chave dentro do grupo.
cryptChave(key)
- Descrição: Criptografa o valor associado a uma chave no nível superior, aumentando o código Unicode dos caracteres.
- Parâmetros:
key
- Nome da chave a ser criptografada.
decryptChave(key)
- Descrição: Descriptografa o valor associado a uma chave no nível superior, diminuindo o código Unicode dos caracteres.
- Parâmetros:
key
- Nome da chave a ser descriptografada.
altChave(key, value)
- Descrição: Altera o valor associado a uma chave existente no nível superior.
- Parâmetros:
key
- Nome da chave.value
- Novo valor a ser associado à chave.
chaveAltGrupo(grupo, key, value)
- Descrição: Altera o valor associado a uma chave existente no grupo.
- Parâmetros:
grupo
- Nome do grupo.key
- Nome da chave.value
- Valor a ser alterado á chave dentro do grupo.
obterChave(key)
- Descrição: Obtém o valor associado a uma chave no nível superior.
- Parâmetros:
key
- Nome da chave.
obterGrupo(key)
- Descrição: Obtém o objeto de um grupo, se o grupo existir.
- Parâmetros:
key
- Nome do grupo.
chaveExiste(key)
- Descrição: Verifica se uma chave existe no banco de dados, retornando
true
oufalse
. - Parâmetros:
key
- Nome da chave.
grupoExiste(key)
- Descrição: Verifica se um grupo existe no banco de dados, retornando
true
oufalse
. - Parâmetros:
key
- Nome do grupo.
delChave(key)
- Descrição: Remove uma chave e seu valor associado do nível superior.
- Parâmetros:
key
- Nome da chave a ser removida.
delGrupo(key)
- Descrição: Remove um grupo e todos os seus dados associados, se o grupo existir.
- Parâmetros:
key
- Nome do grupo a ser removido.
chaveDelGrupo(grupo, key)
- Descrição: Remove uma chave e seu valor associado do grupo.
- Parâmetros:
grupo
- Nome do grupo.key
- Nome da chave.
resetar()
- Descrição: Exclui o arquivo JSON, removendo todos os dados do banco de dados.
- Parâmetros: Nenhum.
listar()
- Descrição: Lista todas as chaves e grupos no nível superior, excluindo as chaves de grupos.
- Parâmetros: Nenhum.
filChave(value)
- Descrição: Filtra chaves no nível superior que correspondem a um valor específico ou ao valor criptografado.
- Parâmetros:
value
- Valor a ser filtrado.