The Database class is the main interface for interacting with Helper.db. It provides methods for storing, retrieving, and managing data in your application.

const db = new Database(name, options);

• name (string): Nome do banco de dados
• options (object): Opções de configuração

const { Database } = require('helper.db');

// Basic database
const db = new Database('myapp.db');

// Database with options
const dbWithOptions = new Database('myapp.db', {
  autoSave: true,
  saveInterval: 5000,
  encryption: true
});

Define um valor para uma chave específica.

db.set('user.name', 'Maria');
db.set('config.theme', 'dark');
db.set('users', [
  { id: 1, name: 'João' },
  { id: 2, name: 'Ana' }
]);

Parameters:

• key (string): A chave para armazenar o valor
• value (any): O valor a ser armazenado

Returns: Database instance (for chaining)

Recupera o valor de uma chave.

const name = db.get('user.name');
const user = db.get('user'); // Retorna objeto completo
const theme = db.get('config.theme', 'light'); // Com valor padrão

Parameters:

• key (string): A chave para recuperar o valor
• defaultValue (any, optional): Valor padrão se a chave não existir

Returns: O valor armazenado ou defaultValue

Remove uma chave do banco de dados.

db.delete('user.name');
db.delete('user'); // Remove objeto completo

Parameters:

• key (string): A chave a ser removida

Returns: boolean - true se a chave existia e foi removida

Verifica se uma chave existe.

if (db.has('user.name')) {
  console.log('User has a name');
}

if (db.has('user.profile.avatar')) {
  console.log('User has an avatar');
}

Parameters:

• key (string): A chave para verificar

Returns: boolean - true se a chave existe

Retorna todos os dados do banco.

const allData = db.all();
console.log(allData);

Returns: Object contendo todos os dados

Remove todos os dados do banco.

db.clear();
console.log('Database cleared');

Returns: Database instance

Retorna o número de chaves no nível raiz.

const keyCount = db.size();
console.log(`Database has ${keyCount} keys`);

Returns: number - quantidade de chaves

Cria um backup do banco de dados.

await db.backup('backup-2024-01-01.db');

Restaura o banco de dados de um backup.

await db.restore('backup-2024-01-01.db');

Exporta os dados em diferentes formatos.

const jsonData = db.export('json');
const csvData = db.export('csv');