ts-fsrs 3.0.5 → 3.0.6

package/README.md

@@ -21,7 +21,7 @@ cp .env.local.example .env.local
 # Example
 
 ```typescript
-import {createEmptyCard, formatDate, fsrs, generatorParameters, Rating} from 'ts-fsrs';
+import {createEmptyCard, formatDate, fsrs, generatorParameters, Rating, Grades} from 'ts-fsrs';
 
 const params = generatorParameters({ enable_fuzz: true });
 const f = fsrs(params);
@@ -30,28 +30,25 @@ const now = new Date('2022-2-2 10:00:00');// new Date();
 const scheduling_cards = f.repeat(card, now);
 
 // console.log(scheduling_cards);
-Object.keys(Rating)
-    .filter(key => !isNaN(Number(key)))
-    .map(key => Number(key) as Rating) // [Rating.Again, Rating.Hard, Rating.Good, Rating.Easy]
-    .forEach(grade => {
-        const { log, card } = scheduling_cards[grade];
-        console.group(`${Rating[grade]}`);
-        console.table({
-            [`card_${Rating[grade]}`]: {
-                ...card,
-                due: formatDate(card.due),
-                last_review: formatDate(card.last_review as Date),
-            },
-        });
-        console.table({
-            [`log_${Rating[grade]}`]: {
-                ...log,
-                review: formatDate(log.review),
-            },
-        });
-        console.groupEnd();
-        console.log('----------------------------------------------------------------');
+Grades.forEach(grade => { // [Rating.Again, Rating.Hard, Rating.Good, Rating.Easy]
+    const { log, card } = scheduling_cards[grade];
+    console.group(`${Rating[grade]}`);
+    console.table({
+        [`card_${Rating[grade]}`]: {
+            ...card,
+            due: formatDate(card.due),
+            last_review: formatDate(card.last_review as Date),
+        },
     });
+    console.table({
+        [`log_${Rating[grade]}`]: {
+            ...log,
+            review: formatDate(log.review),
+        },
+    });
+    console.groupEnd();
+    console.log('----------------------------------------------------------------');
+});
 ```
 
 > More examples refer to the [Example](https://github.com/ishiko732/ts-fsrs/blob/master/example/index.ts)

package/dist/default.js

@@ -29,7 +29,7 @@ exports.default_w = exports.envParams.FSRS_W || [
     0.34, 1.26, 0.29, 2.61,
 ];
 exports.default_enable_fuzz = exports.envParams.FSRS_ENABLE_FUZZ || false;
-exports.FSRSVersion = "3.0.5";
+exports.FSRSVersion = "3.0.6";
 const generatorParameters = (props) => {
     return {
         request_retention: props?.request_retention || exports.default_request_retention,

package/dist/help.d.ts

@@ -22,3 +22,4 @@ export declare function show_diff_message(due: Date, last_review: Date, unit?: b
 export declare function fixDate(value: unknown): Date;
 export declare function fixState(value: unknown): State;
 export declare function fixRating(value: unknown): Rating;
+export declare const Grades: Rating[];

package/dist/help.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fixRating = exports.fixState = exports.fixDate = exports.show_diff_message = exports.formatDate = exports.date_diff = exports.date_scheduler = void 0;
+exports.Grades = exports.fixRating = exports.fixState = exports.fixDate = exports.show_diff_message = exports.formatDate = exports.date_diff = exports.date_scheduler = void 0;
 const models_1 = require("./models");
 Date.prototype.scheduler = function (t, isDay) {
     return date_scheduler(this, t, isDay);
@@ -123,3 +123,4 @@ function fixRating(value) {
     throw new Error(`Invalid rating:[${value}]`);
 }
 exports.fixRating = fixRating;
+exports.Grades = [models_1.Rating.Again, models_1.Rating.Hard, models_1.Rating.Good, models_1.Rating.Easy];

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { SchedulingCard } from "./scheduler";
 export { default_request_retention, default_maximum_interval, default_w, default_enable_fuzz, FSRSVersion, generatorParameters, createEmptyCard, fsrs, envParams } from "./default";
-export { date_scheduler, date_diff, formatDate, show_diff_message, } from "./help";
+export { date_scheduler, date_diff, formatDate, show_diff_message, Grades } from "./help";
 export type { int, double } from "./type";
 export type { FSRSParameters, Card, ReviewLog, RecordLog, RecordLogItem, StateType, RatingType, CardInput, DateInput } from "./models";
 export { State, Rating } from "./models";

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FSRS = exports.Rating = exports.State = exports.show_diff_message = exports.formatDate = exports.date_diff = exports.date_scheduler = exports.envParams = exports.fsrs = exports.createEmptyCard = exports.generatorParameters = exports.FSRSVersion = exports.default_enable_fuzz = exports.default_w = exports.default_maximum_interval = exports.default_request_retention = exports.SchedulingCard = void 0;
+exports.FSRS = exports.Rating = exports.State = exports.Grades = exports.show_diff_message = exports.formatDate = exports.date_diff = exports.date_scheduler = exports.envParams = exports.fsrs = exports.createEmptyCard = exports.generatorParameters = exports.FSRSVersion = exports.default_enable_fuzz = exports.default_w = exports.default_maximum_interval = exports.default_request_retention = exports.SchedulingCard = void 0;
 var scheduler_1 = require("./scheduler");
 Object.defineProperty(exports, "SchedulingCard", { enumerable: true, get: function () { return scheduler_1.SchedulingCard; } });
 var default_1 = require("./default");
@@ -18,6 +18,7 @@ Object.defineProperty(exports, "date_scheduler", { enumerable: true, get: functi
 Object.defineProperty(exports, "date_diff", { enumerable: true, get: function () { return help_1.date_diff; } });
 Object.defineProperty(exports, "formatDate", { enumerable: true, get: function () { return help_1.formatDate; } });
 Object.defineProperty(exports, "show_diff_message", { enumerable: true, get: function () { return help_1.show_diff_message; } });
+Object.defineProperty(exports, "Grades", { enumerable: true, get: function () { return help_1.Grades; } });
 var models_1 = require("./models");
 Object.defineProperty(exports, "State", { enumerable: true, get: function () { return models_1.State; } });
 Object.defineProperty(exports, "Rating", { enumerable: true, get: function () { return models_1.Rating; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-fsrs",
-  "version": "3.0.5",
+  "version": "3.0.6",
   "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",