Riferimento rapido

Cheat Sheet Modella Models

Guida rapida a Modella: framework minimale di modelli in JavaScript, definizione attributi, validazioni, eventi e plugin.

· Pubblicato

[!NOTE] Progetto archiviato: Modella è uno storico framework minimale per Node.js e browser. Per progetti moderni, si raccomanda l uso di Zod o Prisma.

Modella è una libreria di modellazione dati essenziale progettata per essere estesa tramite plugin.

Definizione del modello

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

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

// Regola di validazione personalizzata
User.validate((user) => {
  if (!user.name()) {
    user.error('name', 'Name is required');
  }
});

Istanze e proprietà del modello

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

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

// Predicati di stato
user.has('name');          // -> true
user.isNew();              // -> true (not yet saved)
user.isValid();            // Runs sync validators -> true/false

Eventi del ciclo di vita

// Eventi di persistenza
user.on('save', () => console.log('Saved'));
user.on('create', () => console.log('Created'));
user.on('remove', () => console.log('Removed'));

// Hook asincroni
user.on('saving', (instance, done) => {
  done();
});

// Eventi di modifica degli attributi
user.on('change', () => console.log('Attributes modified'));
user.on('change email', () => console.log('Email changed'));

Architettura dei plugin

Un plugin Modella è una funzione di ordine superiore che estende il modello:

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());

Riferimenti

Argomenti correlati