chore: Add return type annotations to generatorParameters and fsrs fu…

…nctions
open-spaced-repetition · Nov 3, 2023 · e212271 · e212271
1 parent 9d3c71a
commit e212271
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/src/fsrs/default.ts b/src/fsrs/default.ts
@@ -32,7 +32,7 @@ export const default_enable_fuzz = envParams.FSRS_ENABLE_FUZZ || false;
 
 export const FSRSVersion: string = "3.0.4";
 
-export const generatorParameters = (props?: Partial<FSRSParameters>) => {
+export const generatorParameters = (props?: Partial<FSRSParameters>): FSRSParameters => {
   return {
     request_retention: props?.request_retention || default_request_retention,
     maximum_interval: props?.maximum_interval || default_maximum_interval,
@@ -54,6 +54,6 @@ export const createEmptyCard = (now?: Date): Card => {
   };
 };
 
-export const fsrs = (params?: Partial<FSRSParameters>) => {
+export const fsrs = (params?: Partial<FSRSParameters>): FSRS => {
   return new FSRS(params || {});
 };
diff --git a/src/fsrs/fsrs.ts b/src/fsrs/fsrs.ts
@@ -1,6 +1,6 @@
 import { SchedulingCard } from "./index";
 import { fixDate, fixState } from "./help";
-import { FSRSParameters, Card, State, CardInput, DateInput } from "./models";
+import { FSRSParameters, Card, State, CardInput, DateInput, RecordLog } from "./models";
 import type { int } from "./type";
 import { FSRSAlgorithm } from "./algorithm";
 
@@ -20,7 +20,7 @@ export class FSRS extends FSRSAlgorithm {
     return { card, now };
   }
 
-  repeat = (card: CardInput, now: DateInput) => {
+  repeat = (card: CardInput, now: DateInput): RecordLog => {
     const process = this.preProcess(card, now);
     card = process.card;
     now = process.now;

diff --git a/src/fsrs/index.ts b/src/fsrs/index.ts
@@ -22,6 +22,8 @@ export type {
   FSRSParameters,
   Card,
   ReviewLog,
+  RecordLog,
+  RecordLogItem,
   StateType,
   RatingType,
   CardInput,