fsrs 1.0.0 fsrs: ^1.0.0 copied to clipboard
Dart Package for FSRS
About The Project #
dart-fsrs is a Dart Package implements Free Spaced Repetition Scheduler algorithm. It helps developers apply FSRS in their flashcard apps.
Getting Started #
dart pub add fsrs
Usage #
Create a card and review it at a given time:
import 'package:fsrs/fsrs.dart';
var f = FSRS();
var card = Card();
var now = DateTime(2022, 11, 29, 12, 30, 0, 0);
var schedulingCards = f.repeat(card, now);
printSchedulingCards(schedulingCards);
There are four ratings:
Rating.Again; // forget; incorrect response
Rating.Hard; // recall; correct response recalled with serious difficulty
Rating.Good; // recall; correct response after a hesitation
Rating.Easy; // recall; perfect response
Get the new state of card for each rating:
var cardAgain = schedulingCards[Rating.Again]!.card;
var cardHard = schedulingCards[Rating.Hard]!.card;
var cardGood = schedulingCards[Rating.Good]!.card;
var cardEasy = schedulingCards[Rating.Easy]!.card;
Get the scheduled days for each rating:
cardAgain.scheduledDays;
cardHard.scheduledDays;
cardGood.scheduledDays;
cardEasy.scheduledDays;
Update the card after rating Good
:
card = schedulingCards[Rating.Good]!.card;
Get the review log after rating Good
:
var reviewLog = schedulingCards[Rating.Good]!.reviewLog;
Get the due date for card:
due = card.due
There are four states:
State.New; // Never been studied
State.Learning; // Been studied for the first time recently
State.Review; // Graduate from learning state
State.Relearning; // Forgotten in review state
License #
Distributed under the MIT License. See LICENSE
for more information.
More Info: #
Port from git@github.com:open-spaced-repetition/py-fsrs.git commit: 1b4cbe4