json-enmap

    1.0.6 • Public • Published

    Denky Database

    Um simples banco de dados em JSON com o foco em performance e simplicidade.

    Inspirado no quick.db e no Enmap.

    Eu tive essa ideia quando o meu bot Denky ainda usava Enmap pois eu não tinha alternativas leves ou gratuitas.

    Ideal para bots do Discord ou projetos que precisem guardar dados facilmente em key-value.


    Instalação e suporte

    Instale a database com npm install denky-database

    Obtenha ajuda em meu servidor do Discord: clique aqui


    Exemplo básico

    const DatabaseManager = require('denky-database')
    
    //Essa será a varíavel que você usará para manipular a Database.
    const Database = new DatabaseManager('./banco.json')
    
    //Define a chave 'pessoas bonitas' para uma lista com Veric e BONEE
    Database.set('pessoas bonitas', ['Veric', 'BONEE'])
    
    //Adiciona o valor Toledo a chave 'pessoas bonitas' (apenas arrays/listas)
    Database.push('pessoas bonitas', 'Toledo')
    
    //Define a chave 'pessoas bonitas' para google.com
    Database.set('website', 'google.com')
    
    //Retorna o valor contido na chave website
    Database.get('website')
    
    //Excluí a chave website
    Database.delete('website')

    Documentação

    Interrogação (?) signfica que uma opção é opcional e já possui um valor atribuído por padrão.

    Opções sem interrogação retornarão um erro dizendo que uma opção está faltando em tal metódo.

    • Database#set(chave, valor) | Cria ou altera uma chave com o valor específico

      Database.set('melhor bot', 'Denky')
      • Tipos:
        • Chave: string, number
        • Valor: any (*)
        • Resultado: undefined
    • Database#get(chave) | Retorna o valor da chave

      Database.get('melhor bot')
      • Tipos:
        • Chave: string | number
        • Resultado: undefined | any (*)
    • Database#delete(chave) | Exclui uma chave

      Database.delete('moedas')
      • Tipos:
        • Chave: string | number
        • Resultado: undefined
    • Database#exists(chave) | Verifica se uma chave existe

      Database.exists('moedas')
      • Tipos:
        • Chave: string | number
        • Resultado: boolean
    • Database#add(chave, quantia) | Adiciona um número para a chave (adição)

      Database.add('dinheiro', 1200)
      • Tipos:
        • Chave: string | number
        • Quantia: number
        • Resultado: undefined
    • Database#remove(chave, quantia) | Remove um número para a chave (subtração)

      Database.remove('dinheiro', 1200)
      • Tipos:
        • Chave: string | number
        • Quantia: number
        • Resultado: undefined
    • Database#push(chave, item) | Adiciona um item a uma array

      Database.push('amigos', 'Jookie')
      • Tipos:
        • Chave: string | number
        • Item: any
        • Resultado: undefined
    • Database#pull(chave, item) | Remove um item de uma array

      Database.pull('amigos', 'Darkness')
      • Tipos:
        • Chave: string | number
        • Item: any
        • Resultado: undefined
    • Database#includes(chave, item) | Verifica se uma array possui um item específico

      Database.includes('amigos', 'MrPowerGamerBR')
      • Tipos:
        • Chave: string | number
        • Item: any
        • Resultado: boolean
    • Database#ping | Informa o tempo em miliseggundos para escrever e remover um item

      Database.ping
      • Tipos:
        • Resultado: number
    • Database#deleteAll() | Apaga todos os itens do banco de dados

      Database.deleteAll()
      • Tipos:
        • Resultado: undefined
    • Database#storage | Retorna o objeto da database

      Database.storage
      • Tipos:
        • Resultado: object
    • Database#all(tipo?) | Retorna todos os itens da database

      Database.all('all') //Retorna todas as entradas da database
      Database.all('keys') //Retorna todas as chaves da database
      Database.all('values') //Retorna todas os valores da database
      • Tipos:
        • Resultado: object

    Install

    npm i json-enmap

    DownloadsWeekly Downloads

    2

    Version

    1.0.6

    License

    MIT

    Unpacked Size

    9.48 kB

    Total Files

    4

    Last publish

    Collaborators

    • veric