ใส่คลาสโมเดล @Table ที่เขียนด้วย sequelize-typescript แล้วจะได้ JSON ตัวอย่างในรูปเดียวกับผลของ toJSON() ของ instance รวมถึง attribute id, createdAt, updatedAt และ deletedAt ที่ Sequelize เพิ่มให้แม้ไม่ได้ประกาศไว้ในคลาส
ต่างจากหน้า JS ตรงที่ค่าในหน้านี้มาจากไทป์ TypeScript ของแต่ละพร็อพเพอร์ตี ไม่ใช่อาร์กิวเมนต์ DataType @Column(DataType.DECIMAL) ที่ประกาศเป็น amount: string จะให้ผลเป็นสตริง
@Table ลงในช่อง Sequelize (TS) เพิ่มโมเดลที่สัมพันธ์กัน (ผ่าน @HasMany และอื่น ๆ) เพื่อให้ได้ค่าแบบซ้อนผลลัพธ์@Table อย่าง timestamps หรือ paranoid เพื่อดูทันทีว่าฟิลด์วันที่เปลี่ยนไปอย่างไร@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;
}{
"id": 0,
"number": "",
"amount": "",
"status": "draft",
"customerId": 0,
"createdAt": "1970-01-01T00:00:00.000Z",
"updatedAt": "1970-01-01T00:00:00.000Z",
"deletedAt": null
}คลาสไม่มี primary key จึงมีการเพิ่ม id ไว้เป็นตัวแรก และ paranoid: true เพิ่ม deletedAt: null status ใช้ literal ตัวแรกของ union คือ "draft" และ amount เป็นสตริงว่างเพราะประกาศเป็น string
@PrimaryKey, @Column({ primaryKey: true }) หรือพร็อพเพอร์ตี id จะแทรก id: 0 ไว้บนสุด ทั้งในรากและในโมเดลที่สัมพันธ์กัน@Table ตั้ง timestamps: false จะต่อท้าย createdAt และ updatedAt การเปลี่ยนชื่ออย่าง createdAt: "created_on", updatedAt: false และ paranoid: true (deletedAt: null) ถูกนำมาใช้แยกตามโมเดลPost[] จาก @HasMany กลายเป็นอาร์เรย์ ส่วน @BelongsTo และ @HasOne กลายเป็นออบเจ็กต์ซ้อน"draft" | "sent" ใช้ค่าแรก และทุกอย่างที่สืบทอดผ่าน extends Model ถูกข้ามDataType.JSON ที่มีไทป์เป็นออบเจ็กต์ เช่น { theme: string } จะถูกเติมค่าตามรูปร่างนั้นสำหรับ endpoint ที่ทำ res.json(await Invoice.findByPk(id)) ผลลัพธ์ให้ตัวอย่าง response ที่คีย์ตรงกับของจริง รวมถึง attribute ที่เพิ่มอัตโนมัติ
การเปิด paranoid เพิ่ม deletedAt ให้ทุก response เทียบผลลัพธ์ตอนเปิดและปิด option เพื่อบอกผู้ใช้ API ได้ชัดเจนว่าจะมีอะไรเปลี่ยน
id และ timestamp ของตัวเองตาม option ใน @Table ของมัน แต่ foreign key ที่ Sequelize เพิ่มให้โดยปริยาย (เช่น invoiceId บนเป้าหมายของ @HasMany ที่ไม่มีคอลัมน์ @ForeignKey) จะไม่ถูกสร้างขึ้นมาเองallowNull และการเปลี่ยนชื่อคอลัมน์ผ่าน @Column({ field: ... }) ถูกข้าม เพราะคีย์ JSON คือชื่อพร็อพเพอร์ตี @Default("x") และ defaultValue แบบ literal ใน @Column({...}) ถูกใช้เป็นค่าตัวอย่างunderscored: true เปลี่ยนแค่ชื่อคอลัมน์ในฐานข้อมูล toJSON() ยังใช้ชื่อ attribute ดังนั้น createdAt ในผลลัพธ์จึงถูกต้อง@Column(DataType.INTEGER) count; ที่ไม่มี annotation) จะเป็น nullnumber หรือ string?กับ MySQL และ PostgreSQL Sequelize คืนค่า DECIMAL เป็นสตริงโดยค่าเริ่มต้น การกำหนดไทป์เป็น amount: string ทำให้ไทป์ตรงกับความจริง และตัวอย่างที่นี่ก็จะแสดงเป็นสตริงด้วย
declare หรือ CreationOptional ได้ไหม?ได้ declare id: CreationOptional<number> ถูกอ่านเป็น number และการแกะแบบเดียวกันใช้กับ NonAttribute<...> และ ForeignKey<...> ส่วน helper type อื่นนอกจากนี้อย่าง InferAttributes ไม่ถูกขยาย
sequelize.define ที่เขียนด้วย JavaScript ไหม?ไม่ หน้านี้อ่านคลาสและไทป์ของ TypeScript สำหรับโมเดลแบบ define และ Model.init ให้ใช้หน้า Sequelize (JS) to JSON ซึ่งอ่าน DataTypes แทน