srs

Documentation

Index

• type ReviewConfidence
• type SRS
  • func NewSRS(deckDir string) *SRS
  • func (s *SRS) CheckOrCreateCard(cardID string, deck *storage.Deck) *SRSCard
  • func (s *SRS) GetReviewCards(numCards int) []storage.Flashcard
  • func (s *SRS) LoadCardsFromMarkdown(deckDir string) error
  • func (s *SRS) LoadSRSFromFile() error
  • func (s *SRS) SaveSRSToFile() error
  • func (s *SRS) UpdateSRSData(deck *storage.Deck, cardID string, outcome int)
• type SRSCard

Types

type ReviewConfidence

type ReviewConfidence int

const (
	EasyReviewConfidence ReviewConfidence = iota
	MediumReviewConfidence
	HardReviewConfidence
)

type SRS

type SRS struct {
	Cards []*SRSCard
	// contains filtered or unexported fields
}

func NewSRS

func NewSRS(deckDir string) *SRS

func (*SRS) CheckOrCreateCard

func (s *SRS) CheckOrCreateCard(cardID string, deck *storage.Deck) *SRSCard

func (*SRS) GetReviewCards

func (s *SRS) GetReviewCards(numCards int) []storage.Flashcard

func (*SRS) LoadCardsFromMarkdown

func (s *SRS) LoadCardsFromMarkdown(deckDir string) error

func (*SRS) LoadSRSFromFile

func (s *SRS) LoadSRSFromFile() error

func (*SRS) SaveSRSToFile

func (s *SRS) SaveSRSToFile() error

func (*SRS) UpdateSRSData

func (s *SRS) UpdateSRSData(deck *storage.Deck, cardID string, outcome int)

type SRSCard

type SRSCard struct {
	Card           *storage.Flashcard
	ReviewInterval int       `json:"reviewInterval"`
	LastReviewed   time.Time `json:"lastReviewed"`
}