Closed
Description
Model için yaptığımız gibi ModelInstance için de TSDocs daha kolay ve anlaşılır bir yazılım geliştirme süreci için doküman eklenmeli.
ModelInstance.ts içindeki fonksiyonlar, yapılar ve yaptıkları iş temelce şöyledir:
- Fonksiyonlar
constructor( data, model, dataInfo )- ModelInstance sınıfının kurucu fonksiyonudur.
- İçine ham veriyi, ait olduğu modeli, ve kardedilicek veri ile ilgili sistemsel bilgileri alır.
save()- Nesnenin şu anki halini Redis'e kaydeder.
getPureData()- Nesne içindeki tüm metronomla ilgili verileri temizleyerek onu ham haline geri getirir.
toJSON()- nesneyi stringfy eder
- Yapılar
classModelInstanceinterfaceDataInfo- kayıtla ilgili redis key'i gibi sistemsel verilerin tutulduğu yer
interfaceModelFields- Metronomun işleyişinde kullandığı ve kayıt yada modelle ilgili bilgilerin tutulduğu yer
Buradaki tüm alanlar dokümante edilmelidir ve ardından oluşan doküman'ın doğruluğu incelenmelidir.
Şurayı da inceleyebilirsiniz: #29