Gib @Table-Modellklassen ein, die mit sequelize-typescript geschrieben sind, und das Tool baut Beispiel-JSON in der Form der toJSON()-Ausgabe einer Instanz. Dazu gehören die Attribute id, createdAt, updatedAt und deletedAt, die Sequelize ergänzt, auch wenn sie in der Klasse nicht deklariert sind.
Anders als auf der JS-Seite stammen die Werte hier aus dem TypeScript-Typ jeder Property statt aus dem DataType-Argument. Ein @Column(DataType.DECIMAL), deklariert als amount: string, ergibt einen String.
@Table-Klassen in das Feld Sequelize (TS) ein. Ergänze assoziierte Modelle (über @HasMany und Ähnliches), um verschachtelte Werte zu bekommen.Ergebnis das JSON mit den automatisch ergänzten Attributen.@Table-Optionen wie timestamps oder paranoid um und sieh sofort, wie sich die Datumsfelder ändern.@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
}Die Klasse hat keinen Primärschlüssel, daher wird id an den Anfang gesetzt, und paranoid: true ergänzt deletedAt: null. status nimmt das erste Literal seiner Union, "draft", und amount ist ein leerer String, weil es als string deklariert ist.
@PrimaryKey, @Column({ primaryKey: true }) oder eine Property id wird id: 0 ganz oben eingefügt, sowohl bei der Wurzel als auch bei assoziierten Modellen.@Table nicht timestamps: false setzt, werden createdAt und updatedAt angehängt; Umbenennungen wie createdAt: "created_on", updatedAt: false und paranoid: true (deletedAt: null) werden pro Modell beachtet.Post[] aus @HasMany wird zu einem Array; @BelongsTo und @HasOne werden zu verschachtelten Objekten."draft" | "sent" verwenden den ersten Wert, und alles, was über extends Model geerbt wird, wird ignoriert.DataType.JSON-Spalte, z. B. { theme: string }, wird in dieser Form befüllt.Für Endpoints, die res.json(await Invoice.findByPk(id)) ausführen, liefert die Ausgabe ein Antwortbeispiel, dessen Keys der Realität entsprechen, automatisch ergänzte Attribute inklusive.
Das Einschalten von paranoid fügt jeder Antwort deletedAt hinzu. Vergleiche die Ausgabe mit aktivierter und deaktivierter Option, um API-Nutzern genau zu sagen, was sich ändert.
id und ihre Timestamps aus ihren eigenen @Table-Optionen, aber Fremdschlüssel, die Sequelize implizit ergänzt (etwa invoiceId am Ziel eines @HasMany ohne @ForeignKey-Spalte), werden nicht erfunden.allowNull und Spaltenumbenennungen über @Column({ field: ... }) werden ignoriert, da die JSON-Keys die Property-Namen sind. @Default("x") und ein literales defaultValue in @Column({...}) dienen als Beispielwerte.underscored: true ändert nur die Spaltennamen in der Datenbank; toJSON() verwendet weiterhin Attributnamen, createdAt in der Ausgabe ist also korrekt.@Column(DataType.INTEGER) count; ohne Annotation), zu null.number oder string typisiert werden?Mit MySQL und PostgreSQL gibt Sequelize DECIMAL-Werte standardmäßig als Strings zurück. Mit amount: string bleibt der Typ ehrlich, und auch das Beispiel hier zeigt dann einen String.
declare-Felder oder CreationOptional verwenden?Ja. declare id: CreationOptional<number> wird als number gelesen, und dasselbe Auspacken gilt für NonAttribute<...> und ForeignKey<...>. Hilfstypen darüber hinaus wie InferAttributes werden nicht aufgelöst.
sequelize.define-Modelle in JavaScript?Nein. Diese Seite liest Klassen und TypeScript-Typen. Für define- und Model.init-Modelle nimm die Seite Sequelize (JS) zu JSON, die stattdessen DataTypes liest.