Referência rápida

Guia Rápido de Modelos com Modella

Guia de referência para Modella: framework minimalista de modelos em JavaScript, definições de atributos, validações e plugins.

· Publicado

[!NOTE] Projeto Arquivado: Modella é um framework histórico de modelos para Node.js e navegadores. Para projetos modernos, recomenda-se Zod ou Prisma.

O Modella é uma biblioteca enxuta de modelagem de dados projetada para ser estendida via plugins.

Definição do Modelo

const Modella = require('modella');
const validators = require('modella-validators');

const User = Modella('User')
  .attr('id')
  .attr('name')
  .attr('email', { required: true })
  .use(validators);

// Regra de validação customizada
User.validate((user) => {
  if (!user.name()) {
    user.error('name', 'Name is required');
  }
});

Instâncias do Modelo e Propriedades

// Instanciação
const user = new User({ name: 'Alice', email: '[email protected]' });

// Getters e Setters
user.name();               // -> "Alice"
user.name('Bob');          // Sets name to "Bob"
user.set({ name: 'Charlie' });

// Predicados de estado
user.has('name');          // -> true
user.isNew();              // -> true (not yet saved)
user.isValid();            // Runs sync validators -> true/false

Eventos de Ciclo de Vida

// Eventos de persistência
user.on('save', () => console.log('Saved'));
user.on('create', () => console.log('Created'));
user.on('remove', () => console.log('Removed'));

// Hooks assíncronos
user.on('saving', (instance, done) => {
  done();
});

// Eventos de alteração de atributos
user.on('change', () => console.log('Attributes modified'));
user.on('change email', () => console.log('Email changed'));

Arquitetura de Plugins

Um plugin do Modella é uma função de ordem superior que decora o modelo:

const TimestampsPlugin = () => {
  return (Model) => {
    Model
      .attr('createdAt')
      .attr('updatedAt');

    Model.on('saving', (record, done) => {
      const now = new Date();
      if (record.isNew()) record.createdAt(now);
      record.updatedAt(now);
      done();
    });

    return Model;
  };
};

User.use(TimestampsPlugin());

Referências

Temas relacionados