data.ef v1.0.8

data.ef, um simples banco de dados

data.ef é um banco de dados que suporta JSON(Javascript Object Notation)

Instalação

npm i data.ef
//---------------------
const { Database: {JSON} } = require("data.ef")
const db = new JSON({path: 'data.json', api: false})

Sim, se você está pensando que é possível criar multiplas databases.

Métodos

Métodos são funções, que executão uma ação referente a database, como, setar algo, deletar algo, buscar algo, etc...

Abaixo, será exibido uns métodos, óbvio, não são todos, mas o que você mais usará.

set

O método set adiciona um valor dentro da db, se esse valor já existir, ele simplesmente dá replace nele, com o novo valor.

Exemplo para a compreenção:

db.set({key:"Belzinhu", value: "Dev da data.ef"})

get//getByKey

O método get, busca um valor usando uma chave de valor dentro da db, e o retorna, sem limitações de valor, caso ele não exista, retornará null/nada.

Exemplo para a compreenção:

db.get({key: "Belzinhu", object: true})
//com o getByKey será o mesmo resultado.
db.getByKey({key: "Belzinhu", object: true})

Caso usemos o object: true, ele retorna a chave de acesso até o valor da db, e o valor.

getByValue

Semelhante ao método get, a única mudança, e que ele não usa uma chave de acesso, e sim o próprio valor.

Exemplo para a compreenção:

db.getByValue({key: "Dev da data.ef", object: true})

delete

Deleta um valor do banco de dados, por uma chave de acesso.

Exemplo para a compreenção:

db.delete({key: 'Belzinhu'})

all

Retorna todos os valores da db em uma array.

Exemplo para a compreenção:

db.all()

clear

Deleta todos os valores da db.

Exemplo para a compreenção:

db.clear()

destroy

Deleta o arquivo da db.

Exemplo para a compreenção:

db.destroy()

has

Retorna verdadeiro, caso a db tenha a key passado e false, caso não tiver.

Exemplo para a compreenção:

db.has({key:  'Belzinhu'})

push

Adiciona um valor ao final de uma array da db.

Exemplo para a compreenção:

db.push({key:  'Belzinhu', value: "a"}) 

unpush

Retira o último elemento de uma array na db.

Exemplo para a compreenção:

db.unpush({key: 'Belzinhu'}) 

shift

Retira o primeiro elemento de uma array.

Exemplo para a compreenção:

db.shift({key: 'Belzinhu'})

unshift

Adicionado um valor na primeira posição de um array.

Exemplo para a compreenção:

db.unshift({key: 'Belzinhu'})

size

Retorna a quantidade de valores na db

Exemplo para a compreenção:

db.size()

random

Retorna um valor aleatório de x a y(o padrão sempre será 100 e 1), e o seta dentro do banco de dados.

Exemplo para a compreenção:

db.random({key: `Belzinhu`, min: 1, max: 100})

math

Operação aritimética.

Exemplo para a compreenção:

db.math({
key: 'Belzinhu',
value: 10,
operator: '+'
})

add

Adiciona um valor na db.

Exemplo para a compreenção:

db.add({key: 'belzinhu', value: 10})

sub

Subtraí um valor da db.

Exemplo para a compreenção:

db.sub({key: 'belzinhu', value: 10})

double

Dobra um valor da db.

Exemplo para a compreenção:

db.double({key: 'belzinhu'})

triple

Triplica um valor na db.

Exemplo para a compreenção:

db.triple({key: 'belzinhu'})

quickdbImport

Importa todos os dados do quick.db.

Exemplo para a compreenção:

const data = require("quick.db")

db.quickdbImport(data)

copy

Envia toda a database pura.

Exemplo para a compreenção:

db.copy()

copb

Esse método, é um tanto quanto peculiar, ele divide a chave por /, e as seta em um object.

Exemplo para a compreenção:

db.copb("Guild/Users/Belzinhu/Vida", "100")
//Como ficará no json:

{
    "Guild": {
        "Users": {
            "Belzinhu": {
                "Vida": "100"
            }
        }
    }
}

api mode

O modo de api é declarado na criação de uma db.

const db = new JSON({path: 'data.json', api: true})

Usando isso, ele envia o link da api no console.

e é adicionado mais um método, o seeApi.

que apenas retorna a api

Exemplo para a compreenção:

db.seeApi()

Eventos

A data.ef disponibiliza eventos, quando algo ocorre referente a db, o evento é ativado.

para podermos detectar o evento, usemos

db.once("nome do evento", callback)

Eventos

elementGet - Quando algo é buscado

elementUpdate - Quando algo é modificado / adicionado

elementDelete - Quando algo é deletado

Novidades

1: Agora o db.size() retorna 0, caso não haja nada na dbb 2: Novo método db.copb()

Suporte

Para ter suporte sobre a db, dar sugestões ou o feedback, entre no nosso Discord.