`ModelInstance` için doküman oluşturulmalı - Githubissues

anchovycation / metronom

Easy to use Redis ORM based on node-redis with TypeScript support

https://anchovycation.github.io/metronom/

GNU General Public License v3.0

7 stars 3 forks source link

`ModelInstance` için doküman oluşturulmalı #30

Closed saracalihan closed 2 years ago

saracalihan commented 2 years ago

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
- class ModelInstance
- interface DataInfo
- kayıtla ilgili redis key'i gibi sistemsel verilerin tutulduğu yer
- interface ModelFields
- 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

saracalihan commented 2 years ago

@beyzaerkan senin için yararlı olacağını düşündüğüm bir iş. Sana da uygunsa ilgilenebilir misin?

beyzaerkan commented 2 years ago

@saracalihan evet