Шпаргалка по моделям Modella

[!NOTE] Архивный проект: Modella — исторический минималистичный фреймворк моделей для Node.js и браузера. Для современных проектов рекомендуются Zod или Prisma.

Modella — легковесная библиотека моделирования данных, спроектированная для расширения через плагины.

Определение модели

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

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

// Пользовательское правило валидации
User.validate((user) => {
  if (!user.name()) {
    user.error('name', 'Name is required');
  }
});

---

Экземпляры модели и свойства

// Создание экземпляра
const user = new User({ name: 'Alice', email: '[email protected]' });

// Геттеры и сеттеры
user.name();               // -> "Alice"
user.name('Bob');          // Sets name to "Bob"
user.set({ name: 'Charlie' });

// Предикаты состояния
user.has('name');          // -> true
user.isNew();              // -> true (not yet saved)
user.isValid();            // Runs sync validators -> true/false

---

События жизненного цикла

// События сохранения/удаления
user.on('save', () => console.log('Saved'));
user.on('create', () => console.log('Created'));
user.on('remove', () => console.log('Removed'));

// Асинхронные хуки
user.on('saving', (instance, done) => {
  done();
});

// События изменения атрибутов
user.on('change', () => console.log('Attributes modified'));
user.on('change email', () => console.log('Email changed'));

---

Архитектура плагинов

Плагин для Modella — это функция высшего порядка, декорирующая модель:

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

---

Ссылки и документация

• Репозиторий Modella на GitHub