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