Documentation

Rating : int
in package

The four FSRS review grades.

Values match Anki's revlog.ease so a review can be exported to an .apkg without translation (issue #228).

Table of Contents

Cases

Again  = 1
Easy  = 4
Good  = 3
Hard  = 2

Methods

fromBinary()  : self
Map LWT's legacy binary answer onto a grade.
isRecall()  : bool
Whether this grade counts as a successful recall.
legacyStatusChange()  : int
Legacy status nudge for this grade (+1 / -1).

Cases

Methods

fromBinary()

Map LWT's legacy binary answer onto a grade.

public static fromBinary(bool $correct) : self

The old review UI only distinguished "I knew it" from "I didn't", which is exactly Again/Good. Hard and Easy carry information the binary UI never collected, so they are only ever produced by the graded endpoint.

Parameters
$correct : bool

Whether the user recalled the term

Return values
self

isRecall()

Whether this grade counts as a successful recall.

public isRecall() : bool
Return values
bool

legacyStatusChange()

Legacy status nudge for this grade (+1 / -1).

public legacyStatusChange() : int

Phase 2a keeps WoStatus moving exactly as it did before, so the reading view is unchanged whether a review arrives through the binary or the graded endpoint.

Return values
int
On this page

Search results