From 5adc76af4f4218e497eefd4c94ae1cd524af68d4 Mon Sep 17 00:00:00 2001 From: ishiko732 Date: Fri, 13 Sep 2024 05:04:09 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20open-spa?= =?UTF-8?q?ced-repetition/ts-fsrs@ba9fa37cfa51e31e222eed1249df8ae78b35f7c8?= =?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/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/RatingType.html | 2 +- types/RecordLog.html | 2 +- types/RecordLogItem.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 +- 41 files changed, 87 insertions(+), 87 deletions(-) diff --git a/classes/FSRS.html b/classes/FSRS.html index 38ace48..bc4ffda 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

See

https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-Algorithm#fsrs-45

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

_seed? intervalModifier param @@ -28,24 +28,24 @@ repeat reschedule rollback -

Constructors

constructor

Properties

Protected Optional_seed

_seed?: string

ProtectedintervalModifier

intervalModifier: number

Protectedparam

param: FSRSParameters

Accessors

interval_modifier

  • get interval_modifier(): number

  • Returns number

parameters

  • get parameters(): FSRSParameters

  • Get the parameters of the algorithm.

    -

    Returns FSRSParameters

  • set parameters(params): void

  • Set the parameters of the algorithm.

    +

Constructors

constructor

Properties

Protected Optional_seed

_seed?: string

ProtectedintervalModifier

intervalModifier: number

Protectedparam

param: FSRSParameters

Accessors

interval_modifier

  • get interval_modifier(): number

  • Returns number

parameters

seed

  • set seed(seed): void

  • Parameters

    • seed: string

    Returns void

Methods

apply_fuzz

  • apply_fuzz(ivl, elapsed_days, enable_fuzz?): int

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

    +

Returns void

seed

  • set seed(seed): void

  • Parameters

    • seed: string

    Returns void

Methods

apply_fuzz

  • apply_fuzz(ivl, elapsed_days, enable_fuzz?): int

  • 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

    • Optionalenable_fuzz: boolean

      This adds a small random delay to the new interval time to prevent cards from sticking together and always being reviewed on the same day.

    Returns int

    • The fuzzed interval.
    -

calculate_interval_modifier

  • calculate_interval_modifier(request_retention): number

  • Parameters

calculate_interval_modifier

constrain_difficulty

constrain_difficulty

  • constrain_difficulty(difficulty): number

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

    Parameters

    • difficulty: number

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

      -

    Returns number

forget

forget

  • forget<R>(card, now, reset_count?, afterHandler?): R

  • 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)

      @@ -55,33 +55,33 @@

      ThrowsExample

      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);
      -

forgetting_curve

  • forgetting_curve(elapsed_days, stability): number

  • The formula used is : +

forgetting_curve

  • forgetting_curve(elapsed_days, stability): 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)

    -

get_retrievability

get_retrievability

  • get_retrievability<T>(card, now?, format?): T extends true
        ? string
        : number

  • 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

    -

init_difficulty

  • init_difficulty(g): number

  • The formula used is : +

init_difficulty

  • init_difficulty(g): number

  • 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]$$

    -

init_stability

init_stability

  • init_stability(g): number

  • 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%)

    -

mean_reversion

mean_reversion

  • mean_reversion(init, current): number

  • 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

    -

next

  • next<R>(card, now, grade, afterHandler?): R

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

    +

next

  • next<R>(card, now, grade, afterHandler?): R

  • 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)

      @@ -92,34 +92,34 @@

      ExampleExample

      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);
      -

next_difficulty

  • next_difficulty(d, g): number

  • The formula used is : +

next_difficulty

  • next_difficulty(d, g): number

  • 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$$

    -

next_forget_stability

next_forget_stability

  • next_forget_stability(d, s, r): number

  • 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

    -

next_interval

next_interval

  • next_interval(s, elapsed_days, enable_fuzz?): int

  • Parameters

    • s: number

      Stability (interval when R=90%)

    • elapsed_days: number

      t days since the last review

    • enable_fuzz: boolean = ...

      This adds a small random delay to the new interval time to prevent cards from sticking together and always being reviewed on the same day.

    Returns int

    See

    The formula used is : FSRSAlgorithm.calculate_interval_modifier

    -

next_recall_stability

next_recall_stability

  • next_recall_stability(d, s, r, g): number

  • 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

    -

next_short_term_stability

next_short_term_stability

  • next_short_term_stability(s, g): number

  • 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

Protectedparams_handler_proxy

repeat

  • repeat<R>(card, now, afterHandler?): R

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

    +

Returns number

Protectedparams_handler_proxy

repeat

reschedule

reschedule

rollback

rollback

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/classes/FSRSAlgorithm.html b/classes/FSRSAlgorithm.html index da13eb2..7f8e144 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

See

https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-Algorithm#fsrs-45

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

_seed? intervalModifier param @@ -22,69 +22,69 @@ next_recall_stability next_short_term_stability params_handler_proxy -

Constructors

constructor

Properties

Protected Optional_seed

_seed?: string

ProtectedintervalModifier

intervalModifier: number

Protectedparam

param: FSRSParameters

Accessors

interval_modifier

parameters

Constructors

constructor

Properties

Protected Optional_seed

_seed?: string

ProtectedintervalModifier

intervalModifier: number

Protectedparam

param: FSRSParameters

Accessors

interval_modifier

parameters

seed

  • set seed(seed): void

  • Parameters

    • seed: string

    Returns void

Methods

apply_fuzz

  • apply_fuzz(ivl, elapsed_days, enable_fuzz?): int

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

    +

Returns void

seed

  • set seed(seed): void

  • Parameters

    • seed: string

    Returns void

Methods

apply_fuzz

  • apply_fuzz(ivl, elapsed_days, enable_fuzz?): int

  • 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

    • Optionalenable_fuzz: boolean

      This adds a small random delay to the new interval time to prevent cards from sticking together and always being reviewed on the same day.

    Returns int

    • The fuzzed interval.
    -

calculate_interval_modifier

  • calculate_interval_modifier(request_retention): number

  • Parameters

    • request_retention: number

      0<request_retention<=1,Requested retention rate

      +

calculate_interval_modifier

constrain_difficulty

  • constrain_difficulty(difficulty): number

  • The formula used is : +

constrain_difficulty

  • constrain_difficulty(difficulty): number

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

    Parameters

    • difficulty: number

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

      -

    Returns number

forgetting_curve

  • forgetting_curve(elapsed_days, stability): number

  • The formula used is : +

Returns number

forgetting_curve

  • forgetting_curve(elapsed_days, stability): 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)

    -

init_difficulty

init_difficulty

  • init_difficulty(g): number

  • 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]$$

    -

init_stability

init_stability

  • init_stability(g): number

  • 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%)

    -

mean_reversion

  • mean_reversion(init, current): number

  • The formula used is : +

mean_reversion

  • mean_reversion(init, current): number

  • 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

    -

next_difficulty

next_difficulty

  • next_difficulty(d, g): number

  • 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$$

    -

next_forget_stability

  • next_forget_stability(d, s, r): number

  • The formula used is : +

next_forget_stability

  • next_forget_stability(d, s, r): number

  • 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

    -

next_interval

  • next_interval(s, elapsed_days, enable_fuzz?): int

  • Parameters

next_interval

  • next_interval(s, elapsed_days, enable_fuzz?): int

  • Parameters

    • s: number

      Stability (interval when R=90%)

    • elapsed_days: number

      t days since the last review

    • enable_fuzz: boolean = ...

      This adds a small random delay to the new interval time to prevent cards from sticking together and always being reviewed on the same day.

    Returns int

    See

    The formula used is : FSRSAlgorithm.calculate_interval_modifier

    -

next_recall_stability

  • next_recall_stability(d, s, r, g): number

  • The formula used is : +

next_recall_stability

  • next_recall_stability(d, s, r, g): number

  • 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

    -

next_short_term_stability

  • next_short_term_stability(s, g): number

  • The formula used is : +

next_short_term_stability

  • next_short_term_stability(s, g): number

  • 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

Protectedparams_handler_proxy

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Returns number

Protectedparams_handler_proxy

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/classes/TypeConvert.html b/classes/TypeConvert.html index 6a893c6..cf7940f 100644 --- a/classes/TypeConvert.html +++ b/classes/TypeConvert.html @@ -1,10 +1,10 @@ TypeConvert | TS-FSRS

Class TypeConvert

Constructors

constructor +

Class TypeConvert

Constructors

constructor

Methods

card rating review_log state time -

Constructors

constructor

Methods

Staticcard

Staticrating

Staticreview_log

Staticstate

Statictime

  • time(value): Date

  • Parameters

    • value: unknown

    Returns Date

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

Staticcard

Staticrating

Staticreview_log

Staticstate

Statictime

  • time(value): Date

  • Parameters

    • value: unknown

    Returns Date

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/enums/Rating.html b/enums/Rating.html index 61bf7b7..2938d5f 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

Again Easy Good Hard Manual -

Enumeration Members

Again

Again: 1

Easy

Easy: 4

Good

Good: 3

Hard

Hard: 2

Manual

Manual: 0

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

Again

Again: 1

Easy

Easy: 4

Good

Good: 3

Hard

Hard: 2

Manual

Manual: 0

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/State.html b/enums/State.html index 8293586..a4c4046 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

Learning New Relearning Review -

Enumeration Members

Learning

Learning: 1

New

New: 0

Relearning

Relearning: 3

Review

Review: 2

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

Learning

Learning: 1

New

New: 0

Relearning

Relearning: 3

Review

Review: 2

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/functions/createEmptyCard.html b/functions/createEmptyCard.html index 16961a3..de7fced 100644 --- a/functions/createEmptyCard.html +++ b/functions/createEmptyCard.html @@ -10,4 +10,4 @@

Example

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);
-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/date_diff.html b/functions/date_diff.html index a8f0482..199ef8d 100644 --- a/functions/date_diff.html +++ b/functions/date_diff.html @@ -1,4 +1,4 @@ date_diff | TS-FSRS

Function date_diff

Settings

Member Visibility
+

Function date_diff

Settings

Member Visibility
diff --git a/functions/date_scheduler.html b/functions/date_scheduler.html index 14b9fab..a506e97 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

    偏移后的日期和时间对象

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/fixDate.html b/functions/fixDate.html index 4942967..35e43cf 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

    • fixDate(value): Date

    • Parameters

      • value: unknown

      Returns Date

      Deprecated

      Use TypeConvert.time instead

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/fixRating.html b/functions/fixRating.html index b12b8ba..04a0710 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

    • fixRating(value): Rating

    • Parameters

      • value: unknown

      Returns Rating

      Deprecated

      Use TypeConvert.rating instead

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/fixState.html b/functions/fixState.html index 536d05d..6e48aa2 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

    • fixState(value): State

    • Parameters

      • value: unknown

      Returns State

      Deprecated

      Use TypeConvert.state instead

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/formatDate.html b/functions/formatDate.html index d346708..1616f72 100644 --- a/functions/formatDate.html +++ b/functions/formatDate.html @@ -1,4 +1,4 @@ formatDate | TS-FSRS

    Function formatDate

    Settings

    Member Visibility
    +

    Function formatDate

    Settings

    Member Visibility
    diff --git a/functions/fsrs-1.html b/functions/fsrs-1.html index 80b6e27..8d68e73 100644 --- a/functions/fsrs-1.html +++ b/functions/fsrs-1.html @@ -12,4 +12,4 @@

    Example

    Settings

    Member Visibility
    +

    Returns FSRS

    Settings

    Member Visibility
    diff --git a/functions/generatorParameters.html b/functions/generatorParameters.html index 1e31f15..4b593e3 100644 --- a/functions/generatorParameters.html +++ b/functions/generatorParameters.html @@ -1,4 +1,4 @@ generatorParameters | TS-FSRS

    Function generatorParameters

    Settings

    Member Visibility
    +

    Function generatorParameters

    Settings

    Member Visibility
    diff --git a/functions/get_fuzz_range.html b/functions/get_fuzz_range.html index abe7474..42cf0ff 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

    • get_fuzz_range(interval, elapsed_days, maximum_interval): {
          max_ivl: number;
          min_ivl: number;
      }

    • Parameters

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

      Returns {
          max_ivl: number;
          min_ivl: number;
      }

      • max_ivl: number
      • min_ivl: number

    Settings

    Member Visibility
    +

    Function get_fuzz_range

    • get_fuzz_range(interval, elapsed_days, maximum_interval): {
          max_ivl: number;
          min_ivl: number;
      }

    • Parameters

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

      Returns {
          max_ivl: number;
          min_ivl: number;
      }

      • max_ivl: number
      • min_ivl: number

    Settings

    Member Visibility
    diff --git a/functions/show_diff_message.html b/functions/show_diff_message.html index f7e3bdd..fb3d7de 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

    • show_diff_message(due, last_review, unit?, timeUnit?): string

    • Parameters

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

      Returns string

    Settings

    Member Visibility
    +

    Function show_diff_message

    • show_diff_message(due, last_review, unit?, timeUnit?): string

    • Parameters

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

      Returns string

    Settings

    Member Visibility
    diff --git a/interfaces/Card.html b/interfaces/Card.html index ed2ab1d..ca3c0ed 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 due elapsed_days lapses @@ -10,4 +10,4 @@ scheduled_days stability state -

    Properties

    difficulty

    difficulty: number

    due

    due: Date

    elapsed_days

    elapsed_days: number

    lapses

    lapses: number

    Optionallast_review

    last_review?: Date

    reps

    reps: number

    scheduled_days

    scheduled_days: number

    stability

    stability: number

    state

    state: State

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    difficulty

    difficulty: number

    due

    due: Date

    elapsed_days

    elapsed_days: number

    lapses

    lapses: number

    Optionallast_review

    last_review?: Date

    reps

    reps: number

    scheduled_days

    scheduled_days: number

    stability

    stability: number

    state

    state: State

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CardInput.html b/interfaces/CardInput.html index 4705d19..4b17199 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 due elapsed_days lapses @@ -10,4 +10,4 @@ scheduled_days stability state -

    Properties

    difficulty

    difficulty: number

    due

    due: DateInput

    elapsed_days

    elapsed_days: number

    lapses

    lapses: number

    Optionallast_review

    last_review?: null | DateInput

    reps

    reps: number

    scheduled_days

    scheduled_days: number

    stability

    stability: number

    state

    state: StateType | State

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    difficulty

    difficulty: number

    due

    due: DateInput

    elapsed_days

    elapsed_days: number

    lapses

    lapses: number

    Optionallast_review

    last_review?: null | DateInput

    reps

    reps: number

    scheduled_days

    scheduled_days: number

    stability

    stability: number

    state

    state: StateType | State

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/FSRSParameters.html b/interfaces/FSRSParameters.html index ae52c05..7027f37 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 enable_short_term maximum_interval request_retention w -

    Properties

    enable_fuzz

    enable_fuzz: boolean

    enable_short_term

    enable_short_term: boolean

    maximum_interval

    maximum_interval: number

    request_retention

    request_retention: number

    w

    w: number[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    enable_fuzz

    enable_fuzz: boolean

    enable_short_term

    enable_short_term: boolean

    maximum_interval

    maximum_interval: number

    request_retention

    request_retention: number

    w

    w: number[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/IPreview.html b/interfaces/IPreview.html index c934a39..74402c8 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

    [iterator] -

    Properties

    1

    1: RecordLogItem

    2

    2: RecordLogItem

    3

    3: RecordLogItem

    4

    4: RecordLogItem

    Methods

    [iterator]

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Properties

    1

    1: RecordLogItem

    2

    2: RecordLogItem

    3

    3: RecordLogItem

    4

    4: RecordLogItem

    Methods

    [iterator]

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/interfaces/IScheduler.html b/interfaces/IScheduler.html index 16a99bf..27fdab4 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

    preview review -

    Methods

    preview

    review

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Methods

    preview

    review

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/interfaces/ReviewLog.html b/interfaces/ReviewLog.html index f95e7bf..742fd65 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 due elapsed_days last_elapsed_days @@ -10,4 +10,4 @@ scheduled_days stability state -

    Properties

    difficulty

    difficulty: number

    due

    due: Date

    elapsed_days

    elapsed_days: number

    last_elapsed_days

    last_elapsed_days: number

    rating

    rating: Rating

    review

    review: Date

    scheduled_days

    scheduled_days: number

    stability

    stability: number

    state

    state: State

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    difficulty

    difficulty: number

    due

    due: Date

    elapsed_days

    elapsed_days: number

    last_elapsed_days

    last_elapsed_days: number

    rating

    rating: Rating

    review

    review: Date

    scheduled_days

    scheduled_days: number

    stability

    stability: number

    state

    state: State

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ReviewLogInput.html b/interfaces/ReviewLogInput.html index 24cf849..5e442a2 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 due elapsed_days last_elapsed_days @@ -10,4 +10,4 @@ scheduled_days stability state -

    Properties

    difficulty

    difficulty: number

    due

    due: DateInput

    elapsed_days

    elapsed_days: number

    last_elapsed_days

    last_elapsed_days: number

    rating

    rating: RatingType | Rating

    review

    review: DateInput

    scheduled_days

    scheduled_days: number

    stability

    stability: number

    state

    state: StateType | State

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    difficulty

    difficulty: number

    due

    due: DateInput

    elapsed_days

    elapsed_days: number

    last_elapsed_days

    last_elapsed_days: number

    rating

    rating: RatingType | Rating

    review

    review: DateInput

    scheduled_days

    scheduled_days: number

    stability

    stability: number

    state

    state: StateType | State

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/types/DateInput.html b/types/DateInput.html index 0240b4f..574f54e 100644 --- a/types/DateInput.html +++ b/types/DateInput.html @@ -1,4 +1,4 @@ DateInput | TS-FSRS

    Type Alias DateInput

    DateInput: Date | number | string

    Settings

    Member Visibility
    +

    Type Alias DateInput

    DateInput: Date | number | string

    Settings

    Member Visibility
    diff --git a/types/Grade.html b/types/Grade.html index 61ca98c..2ffaaa6 100644 --- a/types/Grade.html +++ b/types/Grade.html @@ -1,4 +1,4 @@ Grade | TS-FSRS

    Type Alias Grade

    Grade: ExcludeManual<Rating>

    Settings

    Member Visibility
    +

    Type Alias Grade

    Grade: ExcludeManual<Rating>

    Settings

    Member Visibility
    diff --git a/types/RatingType.html b/types/RatingType.html index dda8332..62267e9 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"

    Settings

    Member Visibility
    +

    Type Alias RatingType

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

    Settings

    Member Visibility
    diff --git a/types/RecordLog.html b/types/RecordLog.html index ae032c8..ff98bd2 100644 --- a/types/RecordLog.html +++ b/types/RecordLog.html @@ -1,4 +1,4 @@ RecordLog | TS-FSRS

    Type Alias RecordLog

    RecordLog: {
        [key in Grade]: RecordLogItem
    }

    Settings

    Member Visibility
    +

    Type Alias RecordLog

    RecordLog: {
        [key in Grade]: RecordLogItem
    }

    Settings

    Member Visibility
    diff --git a/types/RecordLogItem.html b/types/RecordLogItem.html index 4b1b211..d44b68a 100644 --- a/types/RecordLogItem.html +++ b/types/RecordLogItem.html @@ -1,4 +1,4 @@ RecordLogItem | TS-FSRS

    Type Alias RecordLogItem

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

    Settings

    Member Visibility
    +

    Type Alias RecordLogItem

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

    Settings

    Member Visibility
    diff --git a/types/StateType.html b/types/StateType.html index 6d38ea2..770b826 100644 --- a/types/StateType.html +++ b/types/StateType.html @@ -1,4 +1,4 @@ StateType | TS-FSRS

    Type Alias StateType

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

    Settings

    Member Visibility
    +

    Type Alias StateType

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

    Settings

    Member Visibility
    diff --git a/types/double.html b/types/double.html index 37f9b32..9e9ad9b 100644 --- a/types/double.html +++ b/types/double.html @@ -1,4 +1,4 @@ double | TS-FSRS

    Type Alias double

    double: number & {
        __double__: void;
    }

    Settings

    Member Visibility
    +

    Type Alias double

    double: number & {
        __double__: void;
    }

    Settings

    Member Visibility
    diff --git a/types/int.html b/types/int.html index 0ff90ae..56decd1 100644 --- a/types/int.html +++ b/types/int.html @@ -1,4 +1,4 @@ int | TS-FSRS

    Type Alias int

    int: number & {
        __int__: void;
    }

    Settings

    Member Visibility
    +

    Type Alias int

    int: number & {
        __int__: void;
    }

    Settings

    Member Visibility
    diff --git a/types/unit.html b/types/unit.html index 1dad46e..5f360f4 100644 --- a/types/unit.html +++ b/types/unit.html @@ -1,4 +1,4 @@ unit | TS-FSRS

    Type Alias unit

    unit: "days" | "minutes"

    Settings

    Member Visibility
    +

    Type Alias unit

    unit: "days" | "minutes"

    Settings

    Member Visibility
    diff --git a/variables/DECAY.html b/variables/DECAY.html index ed077b9..94966f5 100644 --- a/variables/DECAY.html +++ b/variables/DECAY.html @@ -4,4 +4,4 @@

    Variable DECAYConst

    DECAY: number = -0.5

    Default

    DECAY = -0.5
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/FACTOR.html b/variables/FACTOR.html index 14ec1e3..061a288 100644 --- a/variables/FACTOR.html +++ b/variables/FACTOR.html @@ -6,4 +6,4 @@

    Default

    FACTOR = 19 / 81
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/FSRSVersion.html b/variables/FSRSVersion.html index 2e48d22..dc46e8e 100644 --- a/variables/FSRSVersion.html +++ b/variables/FSRSVersion.html @@ -1,4 +1,4 @@ FSRSVersion | TS-FSRS

    Variable FSRSVersionConst

    FSRSVersion: string = 'v4.3.0 using FSRS V5.0'

    Settings

    Member Visibility
    +

    Variable FSRSVersionConst

    FSRSVersion: string = 'v4.3.0 using FSRS V5.0'

    Settings

    Member Visibility
    diff --git a/variables/Grades.html b/variables/Grades.html index a93556f..436be4d 100644 --- a/variables/Grades.html +++ b/variables/Grades.html @@ -1,4 +1,4 @@ Grades | TS-FSRS

    Variable GradesConst

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

    Settings

    Member Visibility
    +

    Variable GradesConst

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

    Settings

    Member Visibility
    diff --git a/variables/default_enable_fuzz.html b/variables/default_enable_fuzz.html index a44ccad..3211981 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

    Settings

    Member Visibility
    +

    Variable default_enable_fuzzConst

    default_enable_fuzz: false = false

    Settings

    Member Visibility
    diff --git a/variables/default_enable_short_term.html b/variables/default_enable_short_term.html index b04928d..636f974 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

    Settings

    Member Visibility
    +

    Variable default_enable_short_termConst

    default_enable_short_term: true = true

    Settings

    Member Visibility
    diff --git a/variables/default_maximum_interval.html b/variables/default_maximum_interval.html index da03bd0..7f46837 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

    Settings

    Member Visibility
    +

    Variable default_maximum_intervalConst

    default_maximum_interval: 36500 = 36500

    Settings

    Member Visibility
    diff --git a/variables/default_request_retention.html b/variables/default_request_retention.html index d924315..d0eb985 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

    Settings

    Member Visibility
    +

    Variable default_request_retentionConst

    default_request_retention: 0.9 = 0.9

    Settings

    Member Visibility
    diff --git a/variables/default_w.html b/variables/default_w.html index ae75ff7..e65740a 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[] = ...

    Settings

    Member Visibility
    +

    Variable default_wConst

    default_w: number[] = ...

    Settings

    Member Visibility