Type Alias RescheduleOptions<T>

RescheduleOptions<T>: {
    first_card?: CardInput;
    now: DateInput;
    recordLogHandler: ((recordLog: RecordLogItem) => T);
    reviewsOrderBy: ((a: FSRSHistory, b: FSRSHistory) => number);
    skipManual: boolean;
    update_memory_state: boolean;
}

Options for rescheduling.

Type Parameters

  • T = RecordLogItem

    The type of the result returned by the recordLogHandler function.

Type declaration

  • Optionalfirst_card?: CardInput

    The input for the first card.

  • now: DateInput

    The current date and time.

  • recordLogHandler: ((recordLog: RecordLogItem) => T)

    A function that handles recording the log.

      • (recordLog): T
      • Parameters

        Returns T

        The result of recording the log.

  • reviewsOrderBy: ((a: FSRSHistory, b: FSRSHistory) => number)

    A function that defines the order of reviews.

      • (a, b): number
      • Parameters

        Returns number

        A negative number if a should be ordered before b, a positive number if a should be ordered after b, or 0 if they have the same order.

  • skipManual: boolean

    Indicating whether to skip manual steps.

  • update_memory_state: boolean

    Indicating whether to update the FSRS memory state.