From 3000176ac8b4b9695369af391c497b77239c6750 Mon Sep 17 00:00:00 2001 From: ishiko732 Date: Mon, 21 Oct 2024 13:25:41 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20open-spa?= =?UTF-8?q?ced-repetition/ts-fsrs@2adce32b668cd51fb7782d6d881eecaf839f388b?= =?UTF-8?q?=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/FSRS.html | 44 ++++++++++++------------ classes/FSRSAlgorithm.html | 32 ++++++++--------- classes/TypeConvert.html | 4 +-- enums/Rating.html | 4 +-- enums/State.html | 4 +-- functions/clamp.html | 2 +- functions/createEmptyCard.html | 2 +- functions/date_diff.html | 2 +- functions/date_scheduler.html | 2 +- functions/fixDate.html | 2 +- functions/fixRating.html | 2 +- functions/fixState.html | 2 +- functions/formatDate.html | 2 +- functions/fsrs-1.html | 2 +- functions/generatorParameters.html | 2 +- functions/get_fuzz_range.html | 2 +- functions/show_diff_message.html | 2 +- interfaces/Card.html | 4 +-- interfaces/CardInput.html | 4 +-- interfaces/FSRSParameters.html | 4 +-- interfaces/IPreview.html | 4 +-- interfaces/IScheduler.html | 4 +-- interfaces/ReviewLog.html | 4 +-- interfaces/ReviewLogInput.html | 4 +-- types/DateInput.html | 2 +- types/Grade.html | 2 +- types/IReschedule.html | 2 +- types/RatingType.html | 2 +- types/RecordLog.html | 2 +- types/RecordLogItem.html | 2 +- types/RescheduleOptions.html | 2 +- types/StateType.html | 2 +- types/double.html | 2 +- types/int.html | 2 +- types/unit.html | 2 +- variables/DECAY.html | 2 +- variables/FACTOR.html | 2 +- variables/FSRSVersion.html | 2 +- variables/Grades.html | 2 +- variables/default_enable_fuzz.html | 2 +- variables/default_enable_short_term.html | 2 +- variables/default_maximum_interval.html | 2 +- variables/default_request_retention.html | 2 +- variables/default_w.html | 2 +- 44 files changed, 90 insertions(+), 90 deletions(-) diff --git a/classes/FSRS.html b/classes/FSRS.html index 1a291b7..51095e5 100644 --- a/classes/FSRS.html +++ b/classes/FSRS.html @@ -2,7 +2,7 @@ window.__typeDocPluginKatexOptions=undefined; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

Class FSRS

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

Constructors

Properties

_seed?: string
intervalModifier: number

Accessors

  • get interval_modifier(): number
  • Returns number

  • get parameters(): FSRSParameters
  • Get the parameters of the algorithm.

    -

    Returns FSRSParameters

  • set parameters(params): void
  • Set the parameters of the algorithm.

    +

Constructors

Properties

_seed?: string
intervalModifier: number

Accessors

  • get interval_modifier(): number
  • Returns number

  • set seed(seed): void
  • Parameters

    • seed: string

    Returns void

Methods

  • If fuzzing is disabled or ivl is less than 2.5, it returns the original interval.

    +

Returns void

  • set seed(seed): void
  • Parameters

    • seed: string

    Returns void

Methods

  • If fuzzing is disabled or ivl is less than 2.5, it returns the original interval.

    Parameters

    • ivl: number

      The interval to be fuzzed.

    • elapsed_days: number

      t days since the last review

    Returns int

    • The fuzzed interval.
    -
  • Parameters

  • The formula used is : $$\min \lbrace \max \lbrace D_0,1 \rbrace,10\rbrace$$

    Parameters

    • difficulty: number

      $$D \in [1,10]$$

      -

    Returns number

  • Type Parameters

    Parameters

    • card: Card | CardInput

      Card to be processed

    • now: DateInput

      Current time or scheduled time

    • reset_count: boolean = false

      Should the review count information(reps,lapses) be reset. (Optional)

    • OptionalafterHandler: ((recordLogItem: RecordLogItem) => R)

      Convert the result to another type. (Optional)

      @@ -54,33 +54,33 @@
      interface RepeatRecordLog {
      card: CardUnChecked; //see method: createEmptyCard
      log: RevLogUnchecked; //see method: fsrs.repeat()
      }

      function forgetAfterHandler(recordLogItem: RecordLogItem): RepeatRecordLog {
      return {
      card: {
      ...(recordLogItem.card as Card & { cid: string }),
      due: recordLogItem.card.due.getTime(),
      state: State[recordLogItem.card.state] as StateType,
      last_review: recordLogItem.card.last_review
      ? recordLogItem.card.last_review!.getTime()
      : null,
      },
      log: {
      ...recordLogItem.log,
      cid: (recordLogItem.card as Card & { cid: string }).cid,
      due: recordLogItem.log.due.getTime(),
      review: recordLogItem.log.review.getTime(),
      state: State[recordLogItem.log.state] as StateType,
      rating: Rating[recordLogItem.log.rating] as RatingType,
      },
      };
      }
      const now = new Date();
      const f = fsrs();
      const emptyCardFormAfterHandler = createEmptyCard(now, cardAfterHandler); //see method: createEmptyCard
      const repeatFormAfterHandler = f.repeat(emptyCardFormAfterHandler, now, repeatAfterHandler); //see method: fsrs.repeat()
      const { card } = repeatFormAfterHandler[Rating.Hard];
      const forgetFromAfterHandler = f.forget(card, date_scheduler(now, 1, true), false, forgetAfterHandler);
      -
  • The formula used is : +

  • The formula used is : $$R(t,S) = (1 + \text{FACTOR} \times \frac{t}{9 \cdot S})^{\text{DECAY}}$$

    Parameters

    • elapsed_days: number

      t days since the last review

    • stability: number

      Stability (interval when R=90%)

    Returns number

    r Retrievability (probability of recall)

    -
  • Get the retrievability of the card

    Type Parameters

    • T extends boolean

    Parameters

    • card: Card | CardInput

      Card to be processed

    • Optionalnow: DateInput

      Current time or scheduled time

    • format: T = ...

      default:true , Convert the result to another type. (Optional)

    Returns T extends true
        ? string
        : number

    The retrievability of the card,if format is true, the result is a string, otherwise it is a number

    -
  • The formula used is : +

  • The formula used is : $$D_0(G) = w_4 - e^{(G-1) \cdot w_5} + 1 $$ $$D_0 = \min \lbrace \max \lbrace D_0(G),1 \rbrace,10 \rbrace$$ where the $$D_0(1)=w_4$$ when the first rating is good.

    Parameters

    • g: Grade

      Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]

    Returns number

    Difficulty $$D \in [1,10]$$

    -
  • The formula used is : $$ S_0(G) = w_{G-1}$$ $$S_0 = \max \lbrace S_0,0.1\rbrace $$

    Parameters

    • g: Grade

      Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]

    Returns number

    Stability (interval when R=90%)

    -
  • The formula used is : $$w_7 \cdot \text{init} +(1 - w_7) \cdot \text{current}$$

    Parameters

    • init: number

      $$w_2 : D_0(3) = w_2 + (R-2) \cdot w_3= w_2$$

    • current: number

      $$D - w_6 \cdot (R - 2)$$

    Returns number

    difficulty

    -
  • Display the collection of cards and logs for the card scheduled at the current time, after applying a specific grade rating.

    +
  • Display the collection of cards and logs for the card scheduled at the current time, after applying a specific grade rating.

    Type Parameters

    Parameters

    • card: Card | CardInput

      Card to be processed

    • now: DateInput

      Current time or scheduled time

    • grade: Grade

      Rating of the review (Again, Hard, Good, Easy)

      @@ -91,33 +91,33 @@
      interface RevLogUnchecked
      extends Omit<ReviewLog, "due" | "review" | "state" | "rating"> {
      cid: string;
      due: Date | number;
      state: StateType;
      review: Date | number;
      rating: RatingType;
      }

      interface NextRecordLog {
      card: CardUnChecked; //see method: createEmptyCard
      log: RevLogUnchecked;
      }

      function nextAfterHandler(recordLogItem: RecordLogItem) {
      const recordItem = {
      card: {
      ...(recordLogItem.card as Card & { cid: string }),
      due: recordLogItem.card.due.getTime(),
      state: State[recordLogItem.card.state] as StateType,
      last_review: recordLogItem.card.last_review
      ? recordLogItem.card.last_review!.getTime()
      : null,
      },
      log: {
      ...recordLogItem.log,
      cid: (recordLogItem.card as Card & { cid: string }).cid,
      due: recordLogItem.log.due.getTime(),
      review: recordLogItem.log.review.getTime(),
      state: State[recordLogItem.log.state] as StateType,
      rating: Rating[recordLogItem.log.rating] as RatingType,
      },
      };
      return recordItem
      }
      const card: Card = createEmptyCard(new Date(), cardAfterHandler); //see method: createEmptyCard
      const f = fsrs();
      const recordLogItem = f.repeat(card, new Date(), Rating.Again, nextAfterHandler);
      -
  • The formula used is : +

  • The formula used is : $$\text{next}_d = D - w_6 \cdot (g - 3)$$ $$D^\prime(D,R) = w_7 \cdot D_0(4) +(1 - w_7) \cdot \text{next}_d$$

    Parameters

    • d: number

      Difficulty $$D \in [1,10]$$

    • g: Grade

      Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]

    Returns number

    $$\text{next}_D$$

    -
  • The formula used is : $$S^\prime_f(D,S,R) = w_{11}\cdot D^{-w_{12}}\cdot ((S+1)^{w_{13}}-1) \cdot e^{w_{14}\cdot(1-R)}$$

    Parameters

    • d: number

      Difficulty D \in [1,10]

    • s: number

      Stability (interval when R=90%)

    • r: number

      Retrievability (probability of recall)

    Returns number

    S^\prime_f new stability after forgetting

    -
  • The formula used is : $$S^\prime_r(D,S,R,G) = S\cdot(e^{w_8}\cdot (11-D)\cdot S^{-w_9}\cdot(e^{w_{10}\cdot(1-R)}-1)\cdot w_{15}(\text{if} G=2) \cdot w_{16}(\text{if} G=4)+1)$$

    Parameters

    • d: number

      Difficulty D \in [1,10]

    • s: number

      Stability (interval when R=90%)

    • r: number

      Retrievability (probability of recall)

    • g: Grade

      Grade (Rating[0.again,1.hard,2.good,3.easy])

    Returns number

    S^\prime_r new stability after recall

    -
  • The formula used is : $$S^\prime_s(S,G) = S \cdot e^{w_{17} \cdot (G-3+w_{18})}$$

    Parameters

    • s: number

      Stability (interval when R=90%)

    • g: Grade

      Grade (Rating[0.again,1.hard,2.good,3.easy])

      -

    Returns number

  • Display the collection of cards and logs for the four scenarios after scheduling the card at the current time.

    +

Returns number

+
diff --git a/classes/FSRSAlgorithm.html b/classes/FSRSAlgorithm.html index b18adb9..cdcb7ec 100644 --- a/classes/FSRSAlgorithm.html +++ b/classes/FSRSAlgorithm.html @@ -2,7 +2,7 @@ window.__typeDocPluginKatexOptions=undefined; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

Class FSRSAlgorithm

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

_seed?: string
intervalModifier: number

Accessors

Constructors

Properties

_seed?: string
intervalModifier: number

Accessors

  • set seed(seed): void
  • Parameters

    • seed: string

    Returns void

Methods

  • If fuzzing is disabled or ivl is less than 2.5, it returns the original interval.

    +

Returns void

  • set seed(seed): void
  • Parameters

    • seed: string

    Returns void

Methods

  • If fuzzing is disabled or ivl is less than 2.5, it returns the original interval.

    Parameters

    • ivl: number

      The interval to be fuzzed.

    • elapsed_days: number

      t days since the last review

    Returns int

    • The fuzzed interval.
    -
  • Parameters

    • request_retention: number

      0<request_retention<=1,Requested retention rate

      +
  • The formula used is : +

  • The formula used is : $$\min \lbrace \max \lbrace D_0,1 \rbrace,10\rbrace$$

    Parameters

    • difficulty: number

      $$D \in [1,10]$$

      -

    Returns number

  • The formula used is : +

Returns number

  • The formula used is : $$R(t,S) = (1 + \text{FACTOR} \times \frac{t}{9 \cdot S})^{\text{DECAY}}$$

    Parameters

    • elapsed_days: number

      t days since the last review

    • stability: number

      Stability (interval when R=90%)

    Returns number

    r Retrievability (probability of recall)

    -
  • The formula used is : $$D_0(G) = w_4 - e^{(G-1) \cdot w_5} + 1 $$ $$D_0 = \min \lbrace \max \lbrace D_0(G),1 \rbrace,10 \rbrace$$ where the $$D_0(1)=w_4$$ when the first rating is good.

    Parameters

    • g: Grade

      Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]

    Returns number

    Difficulty $$D \in [1,10]$$

    -
  • The formula used is : $$ S_0(G) = w_{G-1}$$ $$S_0 = \max \lbrace S_0,0.1\rbrace $$

    Parameters

    • g: Grade

      Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]

    Returns number

    Stability (interval when R=90%)

    -
  • The formula used is : +

  • The formula used is : $$w_7 \cdot \text{init} +(1 - w_7) \cdot \text{current}$$

    Parameters

    • init: number

      $$w_2 : D_0(3) = w_2 + (R-2) \cdot w_3= w_2$$

    • current: number

      $$D - w_6 \cdot (R - 2)$$

    Returns number

    difficulty

    -
  • The formula used is : $$\text{next}_d = D - w_6 \cdot (g - 3)$$ $$D^\prime(D,R) = w_7 \cdot D_0(4) +(1 - w_7) \cdot \text{next}_d$$

    Parameters

    • d: number

      Difficulty $$D \in [1,10]$$

    • g: Grade

      Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]

    Returns number

    $$\text{next}_D$$

    -
  • The formula used is : +

  • The formula used is : $$S^\prime_f(D,S,R) = w_{11}\cdot D^{-w_{12}}\cdot ((S+1)^{w_{13}}-1) \cdot e^{w_{14}\cdot(1-R)}$$

    Parameters

    • d: number

      Difficulty D \in [1,10]

    • s: number

      Stability (interval when R=90%)

    • r: number

      Retrievability (probability of recall)

    Returns number

    S^\prime_f new stability after forgetting

    -
  • Parameters

  • The formula used is : +

  • The formula used is : $$S^\prime_r(D,S,R,G) = S\cdot(e^{w_8}\cdot (11-D)\cdot S^{-w_9}\cdot(e^{w_{10}\cdot(1-R)}-1)\cdot w_{15}(\text{if} G=2) \cdot w_{16}(\text{if} G=4)+1)$$

    Parameters

    • d: number

      Difficulty D \in [1,10]

    • s: number

      Stability (interval when R=90%)

    • r: number

      Retrievability (probability of recall)

    • g: Grade

      Grade (Rating[0.again,1.hard,2.good,3.easy])

    Returns number

    S^\prime_r new stability after recall

    -
  • The formula used is : +

  • The formula used is : $$S^\prime_s(S,G) = S \cdot e^{w_{17} \cdot (G-3+w_{18})}$$

    Parameters

    • s: number

      Stability (interval when R=90%)

    • g: Grade

      Grade (Rating[0.again,1.hard,2.good,3.easy])

      -

    Returns number

+

Returns number

diff --git a/classes/TypeConvert.html b/classes/TypeConvert.html index 5c29501..9bcd92e 100644 --- a/classes/TypeConvert.html +++ b/classes/TypeConvert.html @@ -1,10 +1,10 @@ TypeConvert | TS-FSRS

Class TypeConvert

Constructors

constructor +

Class TypeConvert

Constructors

Methods

  • Parameters

    • value: unknown

    Returns Date

+

Constructors

Methods

  • Parameters

    • value: unknown

    Returns Date

diff --git a/enums/Rating.html b/enums/Rating.html index 0b3ea08..2bf8818 100644 --- a/enums/Rating.html +++ b/enums/Rating.html @@ -1,9 +1,9 @@ Rating | TS-FSRS

Enumeration Rating

Enumeration Members

Again +

Enumeration Rating

Enumeration Members

Enumeration Members

Again: 1
Easy: 4
Good: 3
Hard: 2
Manual: 0
+

Enumeration Members

Again: 1
Easy: 4
Good: 3
Hard: 2
Manual: 0
diff --git a/enums/State.html b/enums/State.html index 021f0e4..50c0e95 100644 --- a/enums/State.html +++ b/enums/State.html @@ -1,8 +1,8 @@ State | TS-FSRS

Enumeration State

Enumeration Members

Learning +

Enumeration State

Enumeration Members

Enumeration Members

Learning: 1
New: 0
Relearning: 3
Review: 2
+

Enumeration Members

Learning: 1
New: 0
Relearning: 3
Review: 2
diff --git a/functions/clamp.html b/functions/clamp.html index 9cb1de1..76fc5f4 100644 --- a/functions/clamp.html +++ b/functions/clamp.html @@ -1,4 +1,4 @@ clamp | TS-FSRS

Function clamp

  • Parameters

    • value: number
    • min: number
    • max: number

    Returns number

+

Function clamp

  • Parameters

    • value: number
    • min: number
    • max: number

    Returns number

diff --git a/functions/createEmptyCard.html b/functions/createEmptyCard.html index a0d5d30..3fd4439 100644 --- a/functions/createEmptyCard.html +++ b/functions/createEmptyCard.html @@ -10,4 +10,4 @@
interface CardUnChecked
extends Omit<Card, "due" | "last_review" | "state"> {
cid: string;
due: Date | number;
last_review: Date | null | number;
state: StateType;
}

function cardAfterHandler(card: Card) {
return {
...card,
cid: "test001",
state: State[card.state],
last_review: card.last_review ?? null,
} as CardUnChecked;
}

const card: CardUnChecked = createEmptyCard(new Date(), cardAfterHandler);
-
+
diff --git a/functions/date_diff.html b/functions/date_diff.html index f4fdfe2..0f82729 100644 --- a/functions/date_diff.html +++ b/functions/date_diff.html @@ -1,4 +1,4 @@ date_diff | TS-FSRS

Function date_diff

+

Function date_diff

diff --git a/functions/date_scheduler.html b/functions/date_scheduler.html index 40a86c5..e2d94cd 100644 --- a/functions/date_scheduler.html +++ b/functions/date_scheduler.html @@ -6,4 +6,4 @@
  • t: number

    时间偏移量,当 isDay 为 true 时表示天数,为 false 时表示分钟

  • OptionalisDay: boolean

    (可选)是否按天数单位进行偏移,默认为 false,表示按分钟单位计算偏移

  • Returns Date

    偏移后的日期和时间对象

    -
    +
    diff --git a/functions/fixDate.html b/functions/fixDate.html index 7de3cbf..d0eec73 100644 --- a/functions/fixDate.html +++ b/functions/fixDate.html @@ -2,4 +2,4 @@ window.__typeDocPluginKatexOptions=undefined; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function fixDate

    • Parameters

      • value: unknown

      Returns Date

      Use TypeConvert.time instead

      -
    +
    diff --git a/functions/fixRating.html b/functions/fixRating.html index 033adff..bfb20c6 100644 --- a/functions/fixRating.html +++ b/functions/fixRating.html @@ -2,4 +2,4 @@ window.__typeDocPluginKatexOptions=undefined; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function fixRating

    • Parameters

      • value: unknown

      Returns Rating

      Use TypeConvert.rating instead

      -
    +
    diff --git a/functions/fixState.html b/functions/fixState.html index cdabb56..d990087 100644 --- a/functions/fixState.html +++ b/functions/fixState.html @@ -2,4 +2,4 @@ window.__typeDocPluginKatexOptions=undefined; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function fixState

    • Parameters

      • value: unknown

      Returns State

      Use TypeConvert.state instead

      -
    +
    diff --git a/functions/formatDate.html b/functions/formatDate.html index 93ea88f..b2cac8d 100644 --- a/functions/formatDate.html +++ b/functions/formatDate.html @@ -1,4 +1,4 @@ formatDate | TS-FSRS

    Function formatDate

    +

    Function formatDate

    diff --git a/functions/fsrs-1.html b/functions/fsrs-1.html index bf89add..6555b7c 100644 --- a/functions/fsrs-1.html +++ b/functions/fsrs-1.html @@ -12,4 +12,4 @@

    Returns FSRS

    diff --git a/functions/generatorParameters.html b/functions/generatorParameters.html index 41a8813..c1c7d3a 100644 --- a/functions/generatorParameters.html +++ b/functions/generatorParameters.html @@ -1,4 +1,4 @@ generatorParameters | TS-FSRS

    Function generatorParameters

    +

    Function generatorParameters

    diff --git a/functions/get_fuzz_range.html b/functions/get_fuzz_range.html index cf88def..8aab286 100644 --- a/functions/get_fuzz_range.html +++ b/functions/get_fuzz_range.html @@ -1,4 +1,4 @@ get_fuzz_range | TS-FSRS

    Function get_fuzz_range

    • Parameters

      • interval: number
      • elapsed_days: number
      • maximum_interval: number

      Returns {
          max_ivl: number;
          min_ivl: number;
      }

      • max_ivl: number
      • min_ivl: number
    +

    Function get_fuzz_range

    • Parameters

      • interval: number
      • elapsed_days: number
      • maximum_interval: number

      Returns {
          max_ivl: number;
          min_ivl: number;
      }

      • max_ivl: number
      • min_ivl: number
    diff --git a/functions/show_diff_message.html b/functions/show_diff_message.html index fce28fa..025e7bf 100644 --- a/functions/show_diff_message.html +++ b/functions/show_diff_message.html @@ -1,4 +1,4 @@ show_diff_message | TS-FSRS

    Function show_diff_message

    • Parameters

      • due: DateInput
      • last_review: DateInput
      • Optionalunit: boolean
      • timeUnit: string[] = TIMEUNITFORMAT

      Returns string

    +

    Function show_diff_message

    • Parameters

      • due: DateInput
      • last_review: DateInput
      • Optionalunit: boolean
      • timeUnit: string[] = TIMEUNITFORMAT

      Returns string

    diff --git a/interfaces/Card.html b/interfaces/Card.html index 02df5f7..7cfb0f6 100644 --- a/interfaces/Card.html +++ b/interfaces/Card.html @@ -1,7 +1,7 @@ Card | TS-FSRS

    Interface Card

    interface Card {
        difficulty: number;
        due: Date;
        elapsed_days: number;
        lapses: number;
        last_review?: Date;
        reps: number;
        scheduled_days: number;
        stability: number;
        state: State;
    }

    Properties

    difficulty +

    Interface Card

    interface Card {
        difficulty: number;
        due: Date;
        elapsed_days: number;
        lapses: number;
        last_review?: Date;
        reps: number;
        scheduled_days: number;
        stability: number;
        state: State;
    }

    Properties

    difficulty: number
    due: Date
    elapsed_days: number
    lapses: number
    last_review?: Date
    reps: number
    scheduled_days: number
    stability: number
    state: State
    +

    Properties

    difficulty: number
    due: Date
    elapsed_days: number
    lapses: number
    last_review?: Date
    reps: number
    scheduled_days: number
    stability: number
    state: State
    diff --git a/interfaces/CardInput.html b/interfaces/CardInput.html index c664d54..1762c02 100644 --- a/interfaces/CardInput.html +++ b/interfaces/CardInput.html @@ -1,7 +1,7 @@ CardInput | TS-FSRS

    Interface CardInput

    interface CardInput {
        difficulty: number;
        due: DateInput;
        elapsed_days: number;
        lapses: number;
        last_review?: null | DateInput;
        reps: number;
        scheduled_days: number;
        stability: number;
        state: StateType | State;
    }

    Hierarchy

    • Omit<Card, "state" | "due" | "last_review">
      • CardInput

    Properties

    difficulty +

    Interface CardInput

    interface CardInput {
        difficulty: number;
        due: DateInput;
        elapsed_days: number;
        lapses: number;
        last_review?: null | DateInput;
        reps: number;
        scheduled_days: number;
        stability: number;
        state: StateType | State;
    }

    Hierarchy

    • Omit<Card, "state" | "due" | "last_review">
      • CardInput

    Properties

    difficulty: number
    elapsed_days: number
    lapses: number
    last_review?: null | DateInput
    reps: number
    scheduled_days: number
    stability: number
    state: StateType | State
    +

    Properties

    difficulty: number
    elapsed_days: number
    lapses: number
    last_review?: null | DateInput
    reps: number
    scheduled_days: number
    stability: number
    state: StateType | State
    diff --git a/interfaces/FSRSParameters.html b/interfaces/FSRSParameters.html index b403cbf..b75980d 100644 --- a/interfaces/FSRSParameters.html +++ b/interfaces/FSRSParameters.html @@ -1,9 +1,9 @@ FSRSParameters | TS-FSRS

    Interface FSRSParameters

    interface FSRSParameters {
        enable_fuzz: boolean;
        enable_short_term: boolean;
        maximum_interval: number;
        request_retention: number;
        w: number[];
    }

    Properties

    enable_fuzz +

    Interface FSRSParameters

    interface FSRSParameters {
        enable_fuzz: boolean;
        enable_short_term: boolean;
        maximum_interval: number;
        request_retention: number;
        w: number[];
    }

    Properties

    enable_fuzz: boolean
    enable_short_term: boolean
    maximum_interval: number
    request_retention: number
    w: number[]
    +

    Properties

    enable_fuzz: boolean
    enable_short_term: boolean
    maximum_interval: number
    request_retention: number
    w: number[]
    diff --git a/interfaces/IPreview.html b/interfaces/IPreview.html index e3c0e55..036cc9c 100644 --- a/interfaces/IPreview.html +++ b/interfaces/IPreview.html @@ -1,9 +1,9 @@ IPreview | TS-FSRS

    Interface IPreview

    interface IPreview {
        1: RecordLogItem;
        2: RecordLogItem;
        3: RecordLogItem;
        4: RecordLogItem;
        [iterator](): IterableIterator<RecordLogItem>;
    }

    Hierarchy (view full)

    Properties

    1 +

    Interface IPreview

    interface IPreview {
        1: RecordLogItem;
        2: RecordLogItem;
        3: RecordLogItem;
        4: RecordLogItem;
        [iterator](): IterableIterator<RecordLogItem>;
    }

    Hierarchy (view full)

    Properties

    1 2 3 4

    Methods

    Properties

    Methods

    +

    Properties

    Methods

    diff --git a/interfaces/IScheduler.html b/interfaces/IScheduler.html index ce55c2d..11b42eb 100644 --- a/interfaces/IScheduler.html +++ b/interfaces/IScheduler.html @@ -1,6 +1,6 @@ IScheduler | TS-FSRS

    Interface IScheduler

    interface IScheduler {
        preview(): IPreview;
        review(state: Grade): RecordLogItem;
    }

    Methods

    preview +

    Interface IScheduler

    interface IScheduler {
        preview(): IPreview;
        review(state: Grade): RecordLogItem;
    }

    Methods

    Methods

    +

    Methods

    diff --git a/interfaces/ReviewLog.html b/interfaces/ReviewLog.html index 63d1621..ef6e82b 100644 --- a/interfaces/ReviewLog.html +++ b/interfaces/ReviewLog.html @@ -1,7 +1,7 @@ ReviewLog | TS-FSRS

    Interface ReviewLog

    interface ReviewLog {
        difficulty: number;
        due: Date;
        elapsed_days: number;
        last_elapsed_days: number;
        rating: Rating;
        review: Date;
        scheduled_days: number;
        stability: number;
        state: State;
    }

    Properties

    difficulty +

    Interface ReviewLog

    interface ReviewLog {
        difficulty: number;
        due: Date;
        elapsed_days: number;
        last_elapsed_days: number;
        rating: Rating;
        review: Date;
        scheduled_days: number;
        stability: number;
        state: State;
    }

    Properties

    difficulty: number
    due: Date
    elapsed_days: number
    last_elapsed_days: number
    rating: Rating
    review: Date
    scheduled_days: number
    stability: number
    state: State
    +

    Properties

    difficulty: number
    due: Date
    elapsed_days: number
    last_elapsed_days: number
    rating: Rating
    review: Date
    scheduled_days: number
    stability: number
    state: State
    diff --git a/interfaces/ReviewLogInput.html b/interfaces/ReviewLogInput.html index 0ac9b47..b9b8ae9 100644 --- a/interfaces/ReviewLogInput.html +++ b/interfaces/ReviewLogInput.html @@ -1,7 +1,7 @@ ReviewLogInput | TS-FSRS

    Interface ReviewLogInput

    interface ReviewLogInput {
        difficulty: number;
        due: DateInput;
        elapsed_days: number;
        last_elapsed_days: number;
        rating: RatingType | Rating;
        review: DateInput;
        scheduled_days: number;
        stability: number;
        state: StateType | State;
    }

    Hierarchy

    • Omit<ReviewLog,
          | "rating"
          | "state"
          | "due"
          | "review">
      • ReviewLogInput

    Properties

    difficulty +

    Interface ReviewLogInput

    interface ReviewLogInput {
        difficulty: number;
        due: DateInput;
        elapsed_days: number;
        last_elapsed_days: number;
        rating: RatingType | Rating;
        review: DateInput;
        scheduled_days: number;
        stability: number;
        state: StateType | State;
    }

    Hierarchy

    • Omit<ReviewLog,
          | "rating"
          | "state"
          | "due"
          | "review">
      • ReviewLogInput

    Properties

    difficulty: number
    elapsed_days: number
    last_elapsed_days: number
    rating: RatingType | Rating
    review: DateInput
    scheduled_days: number
    stability: number
    state: StateType | State
    +

    Properties

    difficulty: number
    elapsed_days: number
    last_elapsed_days: number
    rating: RatingType | Rating
    review: DateInput
    scheduled_days: number
    stability: number
    state: StateType | State
    diff --git a/types/DateInput.html b/types/DateInput.html index 07c9d50..02757db 100644 --- a/types/DateInput.html +++ b/types/DateInput.html @@ -1,4 +1,4 @@ DateInput | TS-FSRS

    Type Alias DateInput

    DateInput: Date | number | string
    +

    Type Alias DateInput

    DateInput: Date | number | string
    diff --git a/types/Grade.html b/types/Grade.html index b58b9c9..d516875 100644 --- a/types/Grade.html +++ b/types/Grade.html @@ -1,4 +1,4 @@ Grade | TS-FSRS

    Type Alias Grade

    Grade: ExcludeManual<Rating>
    +

    Type Alias Grade

    Grade: ExcludeManual<Rating>
    diff --git a/types/IReschedule.html b/types/IReschedule.html index d1f8620..5406eb6 100644 --- a/types/IReschedule.html +++ b/types/IReschedule.html @@ -1,4 +1,4 @@ IReschedule | TS-FSRS

    Type Alias IReschedule<T>

    IReschedule<T>: {
        collections: T[];
        reschedule_item: T | null;
    }

    Type Parameters

    +

    Type Alias IReschedule<T>

    IReschedule<T>: {
        collections: T[];
        reschedule_item: T | null;
    }

    Type Parameters

    diff --git a/types/RatingType.html b/types/RatingType.html index 4538914..3b96495 100644 --- a/types/RatingType.html +++ b/types/RatingType.html @@ -1,4 +1,4 @@ RatingType | TS-FSRS

    Type Alias RatingType

    RatingType:
        | "Manual"
        | "Again"
        | "Hard"
        | "Good"
        | "Easy"
    +

    Type Alias RatingType

    RatingType:
        | "Manual"
        | "Again"
        | "Hard"
        | "Good"
        | "Easy"
    diff --git a/types/RecordLog.html b/types/RecordLog.html index 8c66428..ab4b239 100644 --- a/types/RecordLog.html +++ b/types/RecordLog.html @@ -1,4 +1,4 @@ RecordLog | TS-FSRS

    Type Alias RecordLog

    RecordLog: {
        [key in Grade]: RecordLogItem
    }
    +

    Type Alias RecordLog

    RecordLog: {
        [key in Grade]: RecordLogItem
    }
    diff --git a/types/RecordLogItem.html b/types/RecordLogItem.html index cea8e8d..727e790 100644 --- a/types/RecordLogItem.html +++ b/types/RecordLogItem.html @@ -1,4 +1,4 @@ RecordLogItem | TS-FSRS

    Type Alias RecordLogItem

    RecordLogItem: {
        card: Card;
        log: ReviewLog;
    }
    +

    Type Alias RecordLogItem

    RecordLogItem: {
        card: Card;
        log: ReviewLog;
    }
    diff --git a/types/RescheduleOptions.html b/types/RescheduleOptions.html index 499020b..04550f7 100644 --- a/types/RescheduleOptions.html +++ b/types/RescheduleOptions.html @@ -14,4 +14,4 @@

    Returns number

    A negative number if a should be ordered before b, a positive number if a should be ordered after b, or 0 if they have the same order.

  • skipManual: boolean

    Indicating whether to skip manual steps.

  • update_memory_state: boolean

    Indicating whether to update the FSRS memory state.

    -
  • +
    diff --git a/types/StateType.html b/types/StateType.html index 2c46727..48549ae 100644 --- a/types/StateType.html +++ b/types/StateType.html @@ -1,4 +1,4 @@ StateType | TS-FSRS

    Type Alias StateType

    StateType:
        | "New"
        | "Learning"
        | "Review"
        | "Relearning"
    +

    Type Alias StateType

    StateType:
        | "New"
        | "Learning"
        | "Review"
        | "Relearning"
    diff --git a/types/double.html b/types/double.html index cf785c4..15d146d 100644 --- a/types/double.html +++ b/types/double.html @@ -1,4 +1,4 @@ double | TS-FSRS

    Type Alias double

    double: number & {
        __double__: void;
    }
    +

    Type Alias double

    double: number & {
        __double__: void;
    }
    diff --git a/types/int.html b/types/int.html index e9e6970..37cdbf4 100644 --- a/types/int.html +++ b/types/int.html @@ -1,4 +1,4 @@ int | TS-FSRS

    Type Alias int

    int: number & {
        __int__: void;
    }
    +

    Type Alias int

    int: number & {
        __int__: void;
    }
    diff --git a/types/unit.html b/types/unit.html index 120e073..6920ba5 100644 --- a/types/unit.html +++ b/types/unit.html @@ -1,4 +1,4 @@ unit | TS-FSRS

    Type Alias unit

    unit: "days" | "minutes"
    +

    Type Alias unit

    unit: "days" | "minutes"
    diff --git a/variables/DECAY.html b/variables/DECAY.html index 22d097b..b088e45 100644 --- a/variables/DECAY.html +++ b/variables/DECAY.html @@ -4,4 +4,4 @@

    Variable DECAYConst

    DECAY: number = -0.5
    DECAY = -0.5
     
    -
    +
    diff --git a/variables/FACTOR.html b/variables/FACTOR.html index ccc25e2..9408185 100644 --- a/variables/FACTOR.html +++ b/variables/FACTOR.html @@ -6,4 +6,4 @@
    FACTOR = 19 / 81
     
    -
    +
    diff --git a/variables/FSRSVersion.html b/variables/FSRSVersion.html index cb25f3c..125ec0f 100644 --- a/variables/FSRSVersion.html +++ b/variables/FSRSVersion.html @@ -1,4 +1,4 @@ FSRSVersion | TS-FSRS

    Variable FSRSVersionConst

    FSRSVersion: string = 'v4.4.1 using FSRS V5.0'
    +

    Variable FSRSVersionConst

    FSRSVersion: string = 'v4.4.2 using FSRS V5.0'
    diff --git a/variables/Grades.html b/variables/Grades.html index f85e6e9..0dbb241 100644 --- a/variables/Grades.html +++ b/variables/Grades.html @@ -1,4 +1,4 @@ Grades | TS-FSRS

    Variable GradesConst

    Grades: Readonly<Grade[]> = ...
    +

    Variable GradesConst

    Grades: Readonly<Grade[]> = ...
    diff --git a/variables/default_enable_fuzz.html b/variables/default_enable_fuzz.html index 77ede90..0200217 100644 --- a/variables/default_enable_fuzz.html +++ b/variables/default_enable_fuzz.html @@ -1,4 +1,4 @@ default_enable_fuzz | TS-FSRS

    Variable default_enable_fuzzConst

    default_enable_fuzz: false = false
    +

    Variable default_enable_fuzzConst

    default_enable_fuzz: false = false
    diff --git a/variables/default_enable_short_term.html b/variables/default_enable_short_term.html index 1148cb1..4d87803 100644 --- a/variables/default_enable_short_term.html +++ b/variables/default_enable_short_term.html @@ -1,4 +1,4 @@ default_enable_short_term | TS-FSRS

    Variable default_enable_short_termConst

    default_enable_short_term: true = true
    +

    Variable default_enable_short_termConst

    default_enable_short_term: true = true
    diff --git a/variables/default_maximum_interval.html b/variables/default_maximum_interval.html index 92b42f8..c466fac 100644 --- a/variables/default_maximum_interval.html +++ b/variables/default_maximum_interval.html @@ -1,4 +1,4 @@ default_maximum_interval | TS-FSRS

    Variable default_maximum_intervalConst

    default_maximum_interval: 36500 = 36500
    +

    Variable default_maximum_intervalConst

    default_maximum_interval: 36500 = 36500
    diff --git a/variables/default_request_retention.html b/variables/default_request_retention.html index accd8fb..49b6f79 100644 --- a/variables/default_request_retention.html +++ b/variables/default_request_retention.html @@ -1,4 +1,4 @@ default_request_retention | TS-FSRS

    Variable default_request_retentionConst

    default_request_retention: 0.9 = 0.9
    +

    Variable default_request_retentionConst

    default_request_retention: 0.9 = 0.9
    diff --git a/variables/default_w.html b/variables/default_w.html index e841dbb..40c9dff 100644 --- a/variables/default_w.html +++ b/variables/default_w.html @@ -1,4 +1,4 @@ default_w | TS-FSRS

    Variable default_wConst

    default_w: number[] = ...
    +

    Variable default_wConst

    default_w: number[] = ...