ts-fsrs 项目使用教程

ts-fsrs 项目使用教程

ts-fsrs ts-fsrs is a ES modules package based on TypeScript 项目地址: https://gitcode.com/gh_mirrors/ts/ts-fsrs

1. 项目介绍

ts-fsrs 是一个基于 TypeScript 的开源项目，支持 ES 模块、CommonJS 和 UMD 模块系统。它实现了 Free Spaced Repetition Scheduler (FSRS) 算法，帮助开发者将 FSRS 集成到他们的闪卡应用程序中，以增强用户的学习体验。

主要特点

• 多模块支持：支持 ES 模块、CommonJS 和 UMD 模块系统。
• FSRS 算法：实现了 Free Spaced Repetition Scheduler 算法，优化学习体验。
• 灵活配置：允许开发者自定义 SRS 参数，以适应不同的应用场景。

2. 项目快速启动

安装

首先，确保你已经安装了 Node.js 16.0.0 或更高版本。然后，使用以下命令安装 ts-fsrs：

npm install ts-fsrs

基本使用

以下是一个简单的示例，展示如何使用 ts-fsrs 创建一个空卡片并进行调度：

import { createEmptyCard, formatDate, fsrs, generatorParameters, Rating } from 'ts-fsrs';

// 生成参数
const params = generatorParameters({ enable_fuzz: true, enable_short_term: false });
const f = fsrs(params);

// 创建空卡片
const card = createEmptyCard(new Date('2022-2-1 10:00:00'));
const now = new Date('2022-2-2 10:00:00');

// 调度卡片
const scheduling_cards = f.repeat(card, now);

// 输出调度结果
for (const item of scheduling_cards) {
    const grade = item.log.rating;
    const [log, card] = item;
    console.group(`Rating[${grade}]`);
    console.table([{ card_due: formatDate(card.due), last_review: formatDate(card.last_review as Date) }]);
    console.table([{ log_review: formatDate(log.review) }]);
    console.groupEnd();
    console.log('----------------------------------------------------------------');
}

3. 应用案例和最佳实践

应用案例

ts-fsrs 可以广泛应用于各种需要间隔重复学习（Spaced Repetition Learning）的应用场景，例如：

• 语言学习应用：帮助用户高效记忆单词和语法。
• 医学教育应用：帮助医学生记忆复杂的医学知识。
• 编程学习应用：帮助程序员记忆编程语言的语法和常用库。

最佳实践

• 自定义参数：根据应用的具体需求，调整 generatorParameters 中的参数，以优化学习效果。
• 日志记录：使用 ReviewLog 记录每次复习的结果，便于后续分析和优化。
• 多用户支持：为每个用户创建独立的卡片集合，并根据用户的复习情况动态调整调度策略。

4. 典型生态项目

ts-fsrs 可以与其他开源项目结合使用，构建更强大的学习应用。以下是一些典型的生态项目：

• Anki：一个广泛使用的间隔重复学习软件，可以与 ts-fsrs 结合，提供更智能的卡片调度。
• Memrise：一个在线学习平台，支持多种语言学习，可以集成 ts-fsrs 以优化用户的学习体验。
• Quizlet：一个在线学习工具，支持创建和分享学习卡片，可以利用 ts-fsrs 提供更智能的学习计划。

通过结合这些生态项目，开发者可以构建出功能更强大、用户体验更优的学习应用。

ts-fsrs ts-fsrs is a ES modules package based on TypeScript 项目地址: https://gitcode.com/gh_mirrors/ts/ts-fsrs