review_scheduler

package

v0.0.0-...-5e43dd1 Latest Latest Go to latest Published: Jan 10, 2023 License: AGPL-3.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Defines the Review struct for storing rows from the Review table.

Auto-tuning stuff (of spacing algorithm parameters).

This section is empty.

This section is empty.

func BulkSaveReviews[T database.Querier](q T, reviews []Result, now time.Time) error

Saves reviews in bulk.

func ScheduleReview[T database.Querier](q T, due time.Time, count int) ([]string, error)

Returns items due for review, no more than count. Pass a negative count if you want to get all due items.

func ScheduleReviewNow[T database.Querier](q T, count int) ([]string, error)

Same as Schedule, but with some default args.

func ScheduleReviewNowWith[T database.Querier](q T, count int, pred func(item string) bool) ([]string, error)

Same as ScheduleReviewNowWith, but takes a predicate argument. Only items that satisfy the predicate are included in the result.

func UpdateReview[T database.Querier](q T, item string, correct bool) error

func UpdateReviewAt[T database.Querier](q T, item string, correct bool, now time.Time) error

Updates review status of item.

func UpdateReviewAtTx(tx *sql.Tx, result Result, now time.Time) error

Same as `UpdateReviewAt`, but explicitly takes an `*sql.Tx`.

type Result struct {
	Word    string `json:"word"`
	Correct bool   `json:"correct"`
}

Review results

type Review struct {
	Interval time.Duration // Interval between now and due date
	Reviewed time.Time
}

func (r Review) Correct() bool

func (r Review) Due() time.Time