Type Alias RescheduleOptions<T>

Options for rescheduling.

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

Type Parameters

T = RecordLogItem
The type of the result returned by the recordLogHandler function.

Index

Properties

first_card? now recordLogHandler reviewsOrderBy skipManual update_memory_state

Properties

`Optional`first_card

first_card?: CardInput

The input for the first card.

now

The current date and time.

recordLogHandler

recordLogHandler: (recordLog: RecordLogItem) => T

A function that handles recording the log.

Type declaration

- (recordLog: RecordLogItem): T
- Parameters
  - recordLog: RecordLogItem
    The log to be recorded.
  Returns T
  The result of recording the log.

reviewsOrderBy

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

A function that defines the order of reviews.

Type declaration

- (a: FSRSHistory, b: FSRSHistory): number
- Parameters
  - a: FSRSHistory
    The first FSRSHistory object.
  - b: FSRSHistory
    The second FSRSHistory object.
  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

skipManual: boolean

Indicating whether to skip manual steps.

update_memory_state

update_memory_state: boolean

Indicating whether to update the FSRS memory state.