ts-fsrs 5.2.0 → 5.2.2

package/dist/index.d.ts

@@ -124,75 +124,12 @@ interface FSRSState {
     difficulty: number;
 }
 
-declare const clipParameters: (parameters: number[], numRelearningSteps: number) => number[];
-/**
- * @returns The input if the parameters are valid, throws if they are invalid
- * @example
- * try {
- *   generatorParameters({
- *     w: checkParameters([0.40255])
- *   });
- * } catch (e: any) {
- *   alert(e);
- * }
- */
-declare const checkParameters: (parameters: number[] | readonly number[]) => number[] | readonly number[];
-declare const migrateParameters: (parameters?: number[] | readonly number[]) => number[];
-declare const generatorParameters: (props?: Partial<FSRSParameters>) => FSRSParameters;
-/**
- * Create an empty card
- * @param now Current time
- * @param afterHandler Convert the result to another type. (Optional)
- * @example
- * ```typescript
- * const card: Card = createEmptyCard(new Date());
- * ```
- * @example
- * ```typescript
- * 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);
- * ```
- */
-declare function createEmptyCard<R = Card>(now?: DateInput, afterHandler?: (card: Card) => R): R;
-
-declare const default_request_retention = 0.9;
-declare const default_maximum_interval = 36500;
-declare const default_enable_fuzz = false;
-declare const default_enable_short_term = true;
-declare const default_learning_steps: readonly StepUnit[];
-declare const default_relearning_steps: readonly StepUnit[];
-declare const FSRSVersion: string;
-declare const S_MIN = 0.001;
-declare const S_MAX = 36500;
-declare const INIT_S_MAX = 100;
-declare const FSRS5_DEFAULT_DECAY = 0.5;
-declare const FSRS6_DEFAULT_DECAY = 0.1542;
-declare const default_w: readonly number[];
-declare const W17_W18_Ceiling = 2;
-declare const CLAMP_PARAMETERS: (w17_w18_ceiling: number) => number[][];
-
 type unit = 'days' | 'minutes';
 type int = number & {
-    __int__: void;
+    __int__: undefined;
 };
 type double = number & {
-    __double__: void;
+    __double__: undefined;
 };
 interface IPreview extends RecordLog {
     [Symbol.iterator](): IterableIterator<RecordLogItem>;
@@ -244,65 +181,6 @@ type IReschedule<T = RecordLogItem> = {
     reschedule_item: T | null;
 };
 
-declare global {
-    export interface Date {
-        /**
-         * @deprecated This method will be removed in version 6.0.0.
-         *
-         */
-        scheduler(t: int, isDay?: boolean): Date;
-        /**
-         * @deprecated This method will be removed in version 6.0.0.
-         *
-         */
-        diff(pre: Date, unit: unit): int;
-        /**
-         * @deprecated This method will be removed in version 6.0.0.
-         *
-         */
-        format(): string;
-        /**
-         * @deprecated This method will be removed in version 6.0.0.
-         *
-         */
-        dueFormat(last_review: Date, unit?: boolean, timeUnit?: string[]): string;
-    }
-}
-/**
- * 计算日期和时间的偏移，并返回一个新的日期对象。
- * @param now 当前日期和时间
- * @param t 时间偏移量，当 isDay 为 true 时表示天数，为 false 时表示分钟
- * @param isDay （可选）是否按天数单位进行偏移，默认为 false，表示按分钟单位计算偏移
- * @returns 偏移后的日期和时间对象
- */
-declare function date_scheduler(now: DateInput, t: number, isDay?: boolean): Date;
-declare function date_diff(now: DateInput, pre: DateInput, unit: unit): number;
-declare function formatDate(dateInput: DateInput): string;
-declare function show_diff_message(due: DateInput, last_review: DateInput, unit?: boolean, timeUnit?: string[]): string;
-/**
- *
- * @deprecated Use TypeConvert.time instead
- * @deprecated This function will be removed in version 6.0.0.
- */
-declare function fixDate(value: unknown): Date;
-/**
- * @deprecated Use TypeConvert.state instead
- * @deprecated This function will be removed in version 6.0.0.
- */
-declare function fixState(value: unknown): State;
-/**
- * @deprecated Use TypeConvert.rating instead
- * @deprecated This function will be removed in version 6.0.0.
- */
-declare function fixRating(value: unknown): Rating;
-declare const Grades: Readonly<Grade[]>;
-declare function get_fuzz_range(interval: number, elapsed_days: number, maximum_interval: number): {
-    min_ivl: number;
-    max_ivl: number;
-};
-declare function clamp(value: number, min: number, max: number): number;
-declare function dateDiffInDays(last: Date, cur: Date): number;
-
 /**
  * $$\text{decay} = -w_{20}$$
  *
@@ -315,6 +193,7 @@ declare const computeDecayFactor: (decayOrParams: number | number[] | readonly n
 /**
  * The formula used is :
  * $$R(t,S) = (1 + \text{FACTOR} \times \frac{t}{9 \cdot S})^{\text{DECAY}}$$
+ * @param {number} decay - The decay factor, decay should be greater than or equal to 0.1 and less than or equal to 0.8.
  * @param {number} elapsed_days t days since the last review
  * @param {number} stability Stability (interval when R=90%)
  * @return {number} r Retrievability (probability of recall)
@@ -451,6 +330,29 @@ declare class FSRSAlgorithm {
     next_state(memory_state: FSRSState | null, t: number, g: number): FSRSState;
 }
 
+declare enum StrategyMode {
+    SCHEDULER = "Scheduler",
+    LEARNING_STEPS = "LearningSteps",
+    SEED = "Seed"
+}
+type TSeedStrategy = (this: AbstractScheduler) => string;
+type TSchedulerStrategy<T extends CardInput | Card = CardInput | Card> = new (card: T, now: DateInput, algorithm: FSRSAlgorithm, strategies: Map<StrategyMode, TStrategyHandler>) => IScheduler;
+/**
+ * When enable_short_term = false, the learning steps strategy will not take effect.
+ */
+type TLearningStepsStrategy = (params: FSRSParameters, state: State, cur_step: number) => {
+    [K in Grade]?: {
+        scheduled_minutes: number;
+        next_step: number;
+    };
+};
+type StrategyMap = {
+    [StrategyMode.SCHEDULER]: TSchedulerStrategy;
+    [StrategyMode.SEED]: TSeedStrategy;
+    [StrategyMode.LEARNING_STEPS]: TLearningStepsStrategy;
+};
+type TStrategyHandler<E = StrategyMode> = E extends StrategyMode ? StrategyMap[E] : never;
+
 declare abstract class AbstractScheduler implements IScheduler {
     protected last: Card;
     protected current: Card;
@@ -471,28 +373,76 @@ declare abstract class AbstractScheduler implements IScheduler {
     protected buildLog(rating: Grade): ReviewLog;
 }
 
-declare enum StrategyMode {
-    SCHEDULER = "Scheduler",
-    LEARNING_STEPS = "LearningSteps",
-    SEED = "Seed"
+declare const default_request_retention = 0.9;
+declare const default_maximum_interval = 36500;
+declare const default_enable_fuzz = false;
+declare const default_enable_short_term = true;
+declare const default_learning_steps: readonly StepUnit[];
+declare const default_relearning_steps: readonly StepUnit[];
+declare const FSRSVersion: string;
+declare const S_MIN = 0.001;
+declare const S_MAX = 36500;
+declare const INIT_S_MAX = 100;
+declare const FSRS5_DEFAULT_DECAY = 0.5;
+declare const FSRS6_DEFAULT_DECAY = 0.1542;
+declare const default_w: readonly number[];
+declare const W17_W18_Ceiling = 2;
+declare const CLAMP_PARAMETERS: (w17_w18_ceiling: number, enable_short_term?: boolean) => number[][];
+
+declare class TypeConvert {
+    static card<T extends Card | CardInput>(card: T): Card;
+    static rating(value: unknown): Rating;
+    static state(value: unknown): State;
+    static time(value: unknown): Date;
+    static review_log(log: ReviewLogInput | ReviewLog): ReviewLog;
 }
-type TSeedStrategy = (this: AbstractScheduler) => string;
-type TSchedulerStrategy<T extends CardInput | Card = CardInput | Card> = new (card: T, now: DateInput, algorithm: FSRSAlgorithm, strategies: Map<StrategyMode, TStrategyHandler>) => IScheduler;
+
+declare const clipParameters: (parameters: number[], numRelearningSteps: number, enableShortTerm?: boolean) => number[];
 /**
- * When enable_short_term = false, the learning steps strategy will not take effect.
+ * @returns The input if the parameters are valid, throws if they are invalid
+ * @example
+ * try {
+ *   generatorParameters({
+ *     w: checkParameters([0.40255])
+ *   });
+ * } catch (e: any) {
+ *   alert(e);
+ * }
  */
-type TLearningStepsStrategy = (params: FSRSParameters, state: State, cur_step: number) => {
-    [K in Grade]?: {
-        scheduled_minutes: number;
-        next_step: number;
-    };
-};
-type StrategyMap = {
-    [StrategyMode.SCHEDULER]: TSchedulerStrategy;
-    [StrategyMode.SEED]: TSeedStrategy;
-    [StrategyMode.LEARNING_STEPS]: TLearningStepsStrategy;
-};
-type TStrategyHandler<E = StrategyMode> = E extends StrategyMode ? StrategyMap[E] : never;
+declare const checkParameters: (parameters: number[] | readonly number[]) => readonly number[] | number[];
+declare const migrateParameters: (parameters?: number[] | readonly number[], numRelearningSteps?: number, enableShortTerm?: boolean) => number[];
+declare const generatorParameters: (props?: Partial<FSRSParameters>) => FSRSParameters;
+/**
+ * Create an empty card
+ * @param now Current time
+ * @param afterHandler Convert the result to another type. (Optional)
+ * @example
+ * ```typescript
+ * const card: Card = createEmptyCard(new Date());
+ * ```
+ * @example
+ * ```typescript
+ * 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);
+ * ```
+ */
+declare function createEmptyCard<R = Card>(now?: DateInput, afterHandler?: (card: Card) => R): R;
 
 type RequireOnly<A, K extends keyof A> = {
     [P in K]-?: A[P];
@@ -553,13 +503,67 @@ declare class FSRS extends FSRSAlgorithm implements IFSRS {
  */
 declare const fsrs: (params?: Partial<FSRSParameters>) => FSRS;
 
-declare class TypeConvert {
-    static card<T extends Card | CardInput>(card: T): Card;
-    static rating(value: unknown): Rating;
-    static state(value: unknown): State;
-    static time(value: unknown): Date;
-    static review_log(log: ReviewLogInput | ReviewLog): ReviewLog;
+declare global {
+    export interface Date {
+        /**
+         * @deprecated This method will be removed in version 6.0.0.
+         *
+         */
+        scheduler(t: int, isDay?: boolean): Date;
+        /**
+         * @deprecated This method will be removed in version 6.0.0.
+         *
+         */
+        diff(pre: Date, unit: unit): int;
+        /**
+         * @deprecated This method will be removed in version 6.0.0.
+         *
+         */
+        format(): string;
+        /**
+         * @deprecated This method will be removed in version 6.0.0.
+         *
+         */
+        dueFormat(last_review: Date, unit?: boolean, timeUnit?: string[]): string;
+    }
 }
+/**
+ * 计算日期和时间的偏移，并返回一个新的日期对象。
+ * @param now 当前日期和时间
+ * @param t 时间偏移量，当 isDay 为 true 时表示天数，为 false 时表示分钟
+ * @param isDay （可选）是否按天数单位进行偏移，默认为 false，表示按分钟单位计算偏移
+ * @returns 偏移后的日期和时间对象
+ */
+declare function date_scheduler(now: DateInput, t: number, isDay?: boolean): Date;
+declare function date_diff(now: DateInput, pre: DateInput, unit: unit): number;
+declare function formatDate(dateInput: DateInput): string;
+declare function show_diff_message(due: DateInput, last_review: DateInput, unit?: boolean, timeUnit?: string[]): string;
+/**
+ *
+ * @deprecated Use TypeConvert.time instead
+ * @deprecated This function will be removed in version 6.0.0.
+ */
+declare function fixDate(value: unknown): Date;
+/**
+ * @deprecated Use TypeConvert.state instead
+ * @deprecated This function will be removed in version 6.0.0.
+ */
+declare function fixState(value: unknown): State;
+/**
+ * @deprecated Use TypeConvert.rating instead
+ * @deprecated This function will be removed in version 6.0.0.
+ */
+declare function fixRating(value: unknown): Rating;
+declare const Grades: Readonly<Grade[]>;
+declare function get_fuzz_range(interval: number, elapsed_days: number, maximum_interval: number): {
+    min_ivl: number;
+    max_ivl: number;
+};
+declare function clamp(value: number, min: number, max: number): number;
+declare function dateDiffInDays(last: Date, cur: Date): number;
+
+declare const ConvertStepUnitToMinutes: (step: StepUnit) => number;
+declare const BasicLearningStepsStrategy: TLearningStepsStrategy;
 
 declare function DefaultInitSeedStrategy(this: AbstractScheduler): string;
 /**
@@ -583,8 +587,5 @@ declare function DefaultInitSeedStrategy(this: AbstractScheduler): string;
  */
 declare function GenSeedStrategyWithCardId(card_id_field: string | number): TSeedStrategy;
 
-declare const ConvertStepUnitToMinutes: (step: StepUnit) => number;
-declare const BasicLearningStepsStrategy: TLearningStepsStrategy;
-
 export { AbstractScheduler, BasicLearningStepsStrategy, CLAMP_PARAMETERS, ConvertStepUnitToMinutes, DefaultInitSeedStrategy, FSRS, FSRS5_DEFAULT_DECAY, FSRS6_DEFAULT_DECAY, FSRSAlgorithm, FSRSVersion, GenSeedStrategyWithCardId, Grades, INIT_S_MAX, Rating, S_MAX, S_MIN, State, StrategyMode, TypeConvert, W17_W18_Ceiling, checkParameters, clamp, clipParameters, computeDecayFactor, createEmptyCard, dateDiffInDays, date_diff, date_scheduler, default_enable_fuzz, default_enable_short_term, default_learning_steps, default_maximum_interval, default_relearning_steps, default_request_retention, default_w, fixDate, fixRating, fixState, forgetting_curve, formatDate, fsrs, generatorParameters, get_fuzz_range, migrateParameters, show_diff_message };
 export type { Card, CardInput, DateInput, FSRSHistory, FSRSParameters, FSRSReview, FSRSState, Grade, GradeType, IFSRS, IPreview, IReschedule, IScheduler, RatingType, RecordLog, RecordLogItem, RescheduleOptions, ReviewLog, ReviewLogInput, StateType, StepUnit, Steps, TLearningStepsStrategy, TSchedulerStrategy, TSeedStrategy, TStrategyHandler, TimeUnit, double, int, unit };