Ubah model Sequelize (TS) menjadi JSON!

Masukkan model Sequelize (TS) untuk membuat contoh JSON! Mendukung Sequelize, sequelize-typescript. Berguna untuk dokumentasi API dan body request uji (mock request body).
Sequelize (TS)
Hasil
 

Ubah model Sequelize (TS) menjadi JSON!

Masukkan class model @Table yang ditulis dengan sequelize-typescript dan alat ini membangun contoh JSON dengan bentuk seperti output toJSON() sebuah instance. Termasuk atribut id, createdAt, updatedAt dan deletedAt yang ditambahkan Sequelize meskipun tidak dideklarasikan di class.

Berbeda dengan halaman JS, nilai di sini diambil dari tipe TypeScript setiap properti, bukan dari argumen DataType. @Column(DataType.DECIMAL) yang dideklarasikan sebagai amount: string menghasilkan string.

Cara menggunakan

  1. Tempel file berisi class @Table ke kolom Sequelize (TS). Tambahkan model yang berasosiasi (lewat @HasMany dan sejenisnya) untuk mendapatkan nilai bersarang.
  2. Periksa kolom Hasil untuk melihat JSON beserta atribut yang ditambahkan otomatis.
  3. Ubah opsi @Table seperti timestamps atau paranoid untuk langsung melihat bagaimana field tanggal berubah.

Contoh

Input (sequelize-typescript)
@Table({ tableName: "invoices", paranoid: true })
export class Invoice extends Model {
  @Column(DataType.STRING(20))
  number: string;

  @Column(DataType.DECIMAL(10, 2))
  amount: string;

  @Column(DataType.ENUM("draft", "sent", "paid"))
  status: "draft" | "sent" | "paid";

  @ForeignKey(() => Customer)
  @Column
  customerId: number;
}
Output (JSON)
{
  "id": 0,
  "number": "",
  "amount": "",
  "status": "draft",
  "customerId": 0,
  "createdAt": "1970-01-01T00:00:00.000Z",
  "updatedAt": "1970-01-01T00:00:00.000Z",
  "deletedAt": null
}

Class ini tidak punya primary key, jadi id ditambahkan paling depan, dan paranoid: true menambahkan deletedAt: null. status mengambil literal pertama dari union-nya, "draft", dan amount berupa string kosong karena dideklarasikan sebagai string.

Fitur yang didukung

  • Tanpa @PrimaryKey, @Column({ primaryKey: true }) atau properti id, id: 0 disisipkan di paling atas, baik untuk root maupun model yang berasosiasi.
  • Kecuali @Table mengatur timestamps: false, createdAt dan updatedAt ditambahkan; penggantian nama seperti createdAt: "created_on", updatedAt: false dan paranoid: true (deletedAt: null) dihormati per model.
  • Post[] dari @HasMany menjadi array; @BelongsTo dan @HasOne menjadi objek bersarang.
  • Literal union seperti "draft" | "sent" memakai nilai pertama, dan semua yang diwarisi lewat extends Model diabaikan.
  • Kolom DataType.JSON yang bertipe objek, misalnya { theme: string }, diisi sesuai bentuk itu.

Kasus penggunaan

Mendokumentasikan handler Express

Untuk endpoint yang melakukan res.json(await Invoice.findByPk(id)), output memberikan contoh respons yang key-nya sesuai kenyataan, termasuk atribut yang ditambahkan otomatis.

Sebelum dan sesudah mengaktifkan soft delete

Mengaktifkan paranoid menambahkan deletedAt ke setiap respons. Bandingkan output dengan opsi itu aktif dan nonaktif untuk memberi tahu konsumen API dengan tepat apa yang akan berubah.

Catatan dan batasan

  • Model berasosiasi yang bersarang di dalam root mendapat id dan timestamp sendiri dari opsi @Table miliknya, tetapi foreign key yang ditambahkan Sequelize secara implisit (seperti invoiceId pada target @HasMany tanpa kolom @ForeignKey) tidak dikarang.
  • allowNull dan penggantian nama kolom lewat @Column({ field: ... }) diabaikan, karena key JSON adalah nama properti. @Default("x") dan defaultValue berupa literal di @Column({...}) dipakai sebagai nilai contoh.
  • underscored: true hanya mengubah nama kolom database; toJSON() tetap memakai nama atribut, jadi createdAt di output sudah benar.
  • Nilai diambil dari tipe TypeScript, jadi properti yang tipenya hanya ada di decorator (@Column(DataType.INTEGER) count; tanpa anotasi) menjadi null.

FAQ

Sebaiknya kolom DECIMAL bertipe number atau string?

Dengan MySQL dan PostgreSQL, Sequelize secara default mengembalikan nilai DECIMAL sebagai string. Memberi tipe amount: string menjaga tipenya jujur, dan contoh di sini juga akan menampilkan string.

Bisakah saya memakai field declare atau CreationOptional?

Bisa. declare id: CreationOptional<number> dibaca sebagai number, dan pembukaan yang sama berlaku untuk NonAttribute<...> dan ForeignKey<...>. Helper type di luar itu, seperti InferAttributes, tidak dijabarkan.

Apakah halaman ini menangani model sequelize.define yang ditulis dalam JavaScript?

Tidak. Halaman ini membaca class dan tipe TypeScript. Gunakan halaman Sequelize (JS) ke JSON untuk model define dan Model.init, yang membaca DataTypes.