typegoose-patterns
MX Space project TypeGoose model patterns. Apply when creating data models, defining schemas, or handling MongoDB operations.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
MX Space project TypeGoose model patterns. Apply when creating data models, defining schemas, or handling MongoDB operations.
How to use
Zainstaluj skill typegoose-patterns w swoim projekcie MX Space — będzie dostępny jako referencja wzorców podczas tworzenia nowych modeli danych.
Przy tworzeniu nowego modelu dziedzicz z odpowiedniej klasy bazowej: BaseModel dla modeli podstawowych, WriteBaseModel dla modeli zawierających treść (tytuł, tekst, obrazy), lub BaseCommentIndexModel jeśli model ma obsługiwać komentarze.
Zdefiniuj pola modelu za pomocą dekoratora @prop(), wskazując wymagane opcje: @prop({ required: true }) dla pól obowiązkowych, @prop({ unique: true }) dla pól unikalnych, @prop({ default: value }) dla wartości domyślnych, @prop({ trim: true }) dla automatycznego usunięcia białych znaków.
Dodaj indeksy na poziomie klasy za pomocą @index() — użyj @index({ fieldName: 1 }) dla indeksu rosnącego, @index({ fieldName: -1 }) dla malejącego, lub @index({ field: 'text' }) dla indeksu tekstowego, aby przyspieszyć zapytania.
Jeśli model ma referencje do innych kolekcji, użyj dekoratora @prop({ ref: () => OtherModel }) wraz z typem Ref
— opcjonalnie dodaj foreignField i localField do automatycznego populowania powiązanych dokumentów. Ustaw customName w @modelOptions() aby określić nazwę kolekcji MongoDB, jeśli różni się od domyślnej nazwy klasy.