Feat/type record log (#36)

* Feat/typo RecordLog * 3.0.4
open-spaced-repetition · Oct 22, 2023 · f76d2a1 · f76d2a1
1 parent dc1be52
commit f76d2a1
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 4 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ts-fsrs",
-  "version": "3.0.3",
+  "version": "3.0.4",
   "description": "ts-fsrs is a TypeScript package used to implement the Free Spaced Repetition Scheduler (FSRS) algorithm. It helps developers apply FSRS to their flashcard applications, thereby improving the user learning experience.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

diff --git a/src/fsrs/default.ts b/src/fsrs/default.ts
@@ -30,7 +30,7 @@ export const default_w = envParams.FSRS_W || [
 ];
 export const default_enable_fuzz = envParams.FSRS_ENABLE_FUZZ || false;
 
-export const FSRSVersion: string = "3.0.3";
+export const FSRSVersion: string = "3.0.4";
 
 export const generatorParameters = (props?: Partial<FSRSParameters>) => {
   return {

diff --git a/src/fsrs/models.ts b/src/fsrs/models.ts
@@ -24,6 +24,10 @@ export interface ReviewLog {
   review: Date;
 }
 
+export type RecordLog = {
+  [key in Rating]: { card: Card; log: ReviewLog };
+};
+
 export interface Card {
   due: Date;
   stability: number; // 稳定性

diff --git a/src/fsrs/scheduler.ts b/src/fsrs/scheduler.ts
@@ -1,4 +1,4 @@
-import { Card, Rating, State } from "./models";
+import { Card, Rating, RecordLog, State } from "./models";
 import { date_scheduler } from "./help";
 
 export class SchedulingCard {
@@ -62,7 +62,7 @@ export class SchedulingCard {
     return this;
   }
 
-  record_log(card: Card, now: Date) {
+  record_log(card: Card, now: Date): RecordLog {
     return {
       [Rating.Again]: {
         card: this.again,