From 0056da9a88b2f8b62a96c99898e1759d38f5ee52 Mon Sep 17 00:00:00 2001 From: ishiko732 Date: Fri, 11 Oct 2024 15:20:03 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20open-spa?= =?UTF-8?q?ced-repetition/ts-fsrs@34e59a4cb0ee4d3e1518b4fe369c97595531114c?= =?UTF-8?q?=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- assets/navigation.js | 2 +- assets/search.js | 2 +- classes/FSRS.html | 58 +++++++++++++----------- classes/FSRSAlgorithm.html | 34 +++++++------- classes/TypeConvert.html | 4 +- enums/Rating.html | 4 +- enums/State.html | 4 +- functions/clamp.html | 2 +- functions/createEmptyCard.html | 2 +- functions/date_diff.html | 2 +- functions/date_scheduler.html | 2 +- functions/fixDate.html | 2 +- functions/fixRating.html | 2 +- functions/fixState.html | 2 +- functions/formatDate.html | 2 +- functions/fsrs-1.html | 2 +- functions/generatorParameters.html | 2 +- functions/get_fuzz_range.html | 2 +- functions/show_diff_message.html | 2 +- interfaces/Card.html | 4 +- interfaces/CardInput.html | 4 +- interfaces/FSRSParameters.html | 4 +- interfaces/IPreview.html | 4 +- interfaces/IScheduler.html | 4 +- interfaces/ReviewLog.html | 4 +- interfaces/ReviewLogInput.html | 4 +- modules.html | 2 + types/DateInput.html | 2 +- types/Grade.html | 2 +- types/IReschedule.html | 4 ++ types/RatingType.html | 2 +- types/RecordLog.html | 2 +- types/RecordLogItem.html | 2 +- types/RescheduleOptions.html | 17 +++++++ types/StateType.html | 2 +- types/double.html | 2 +- types/int.html | 2 +- types/unit.html | 2 +- variables/DECAY.html | 2 +- variables/FACTOR.html | 2 +- variables/FSRSVersion.html | 2 +- variables/Grades.html | 2 +- variables/default_enable_fuzz.html | 2 +- variables/default_enable_short_term.html | 2 +- variables/default_maximum_interval.html | 2 +- variables/default_request_retention.html | 2 +- variables/default_w.html | 2 +- 47 files changed, 122 insertions(+), 97 deletions(-) create mode 100644 types/IReschedule.html create mode 100644 types/RescheduleOptions.html diff --git a/assets/navigation.js b/assets/navigation.js index e647db5..afacdc4 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA42WXW+bMBSG/wvX2bJka7flLkraKdKkVaGaNE0TOoUDWMOG2Yd8dNp/n4AWsDGGq0h+z/NY/og5P/96hBfyNt4RiInEW3gFUOptPBQlV8tm9G1KPPMW3m8mIm/z6d+ipXwCQhOqB8eZe//od0iYgVKoltWozqzWJrXNklwySrkdb2OX5/Fa4C4XJ5Q0tPRCl2MHMupgJghlDCGqZRXo4Prm1gAPoihplK5Tl6Ja6ANI4EgoldWjl7hkhweJJ4Znq+Y1dAr8MMWozFDaFW3skhzrab7midXRprMU47url7hkeyA0PHQtUC3bwKDfff64uln3DF8kRGjS9eAU2fzhqnto4l0y6cAwl5G2ny+K12C24UDIRy1VOGWq3wLbctpgyhDl5VM2wJvRKZaJwRkyMXl6pWADrBqb4vZ3u+2PDjyBZPCUVfemCnT6fR+83+4evx1tZJO4UP/of0epWC6sfBc7JPXNVDa+SRxohDGUGQUoKiCIy+dnm8dSNl+q0lxSQCj5DHVXPGMCDhfGSx7Uz8QJMpffrJ2hl/inRFX9EgoaOaLR4hkTnF3Cs0MQZsCLDo5LEVZTqmUd6ODthz4oEQjveEFX/SvYU+glDlkEhEHE4timacMpgRp+ggyLsn+FNFXMLnutl+kcL5EJL5q2oT6OQmIIhJGnG82mSnPaeqtZVqPp0qSW3muGM5ccaHT5beraPtVvRnqwkurNygEmKFAC5dLW1HQeS5lTSvUbE0gQiXVReoVDpdL8XF/DgKNSYLcNigbCX/8BH1bgB2oLAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA42WXW+bMBSG/wvXWbNkbbflLkraKdKkVlBNmqoJuXAI1rBh9iEfnfbfJ0wC2BjDFZLf8zzIX3Be/3oIJ/RWnk+Q8r038wqCqbfygJdMzuvRmxRZ5s2835TH3urLv1lDBUgQTEgNDjOPgR+0SJQRKUHOq1GdWSxNap3tc0ExZXa8iV2el3MBm5wfQGDf0gldjg0RcQtTjiASEoGcV4EOLu/uDXDHixIHaZW6FNVEn4kgDBCEtHr0Epds9yzgQOFo1VxDpyCIUojLDIRd0cQuia9e8z3fWx1NOkkxvLp6iUu2JQiGB88FyHkTGPTHr58Xd8uO4ZsgMZi0Ghwjdz7Iy5qZfCcas9TXtjrNpqRNRh0Q5SLWduWiuAaTDTsENmipwnHTdeZPBdKcy77NKBgzqm+UbYGaYMwQ5+Vbf5Pq0TGW8t7Zonz0VJWc9rBqbIzbPmzWP1vwQAQlb1l1nqtApz91wcf15uXJt5F14kIDP/gBQtKcW/k2dkjUjZE2vk4caAwJKTMMgVdAmJTv7zaPpWy6VKa5wBBBsAnqtnjCCxg5UVayUH2+DiRz+c3aCXoBf0qQ1ROB48AWDRZPeMHRJTw6BFFGWNHCSckjdZ3nKtDB+9suKIAgPLACz/rfuaPQSxyymCCEMU0Sm6YJxwSy/2s0LNL+d9RUCT1ttR6rdVwiE57V7YzajkJARBBiTzeazZ7mtPV8k6xGM6hJLT3hBGcuGMHB6Tepa/lkt0nqwFLIDwsHuAcOgmAubM1W67GUOaWovjGhIHxvnZRe4VDJND+qYxgykJLYbb2invDXfyQ/vP8CDAAA" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index c8bab81..24c3115 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA62d64/bOA7A/5WD52t2asrv+bbY3btb4F5oDwscBkXgTTytsXmd4/RxRf/3g2Q7JiXKppP51sYSKcs/kSJpa74FzfHzOXh6/hb8UR+2wZNK0lVwKPdV8BT8+d3bd/8qm3JftVVzDlbBpdkFT0F9aKvmpdxU5ze0xePHdr8LVsFmV57P1Tl4CoLvq0EwhCq+Sm6q/16qc7tuqrY6tPXxIBT+wHVE6lbBqWyqQ+sO3jOQffml3l/2a6P2U7mTjoPpd88wPkv1fr5TUXUof99V65fL//4nVUm7vILy88dj067bqtkvHALpuHAgmOufymbLqda/yxneXqpJIQ9dA36cZggewee2/L3e1e3XafG42XIl2/rlpd5cdnNaSLvlaqpdeTpX2/W2/MoakFGR1fKGadt8rLaXnUiZ03a5uqY6zSjpWywXbWZiRvi1zU18tTPoDk1uGbuxzp/qirVp+AZwQ5EivIbfmp5/O37gtFwvLvBIZVsfBMIerg35IY/jWjr7lp7pRzCrxmOdLCVTJkpyJ3475d7NjLGav6NJi2Xf2LzZmlU4Z7sslSIDNqvULIuFmrk+tz7TWSNqP1iZJZ1V7DcZ9vqbNhmcIhUWGSQK2Y7Nsdli29F+PRlN/e+TZsMr7de22vsk6muTUtMkiUbrtl7r/rPCHq7tfJOBh+aZ+Q3eDc1oeuwbC9Q99mPzce6ffUdp1/YmnfbDeqet6r/dub3+vuzRG1/AiBsvLJL3l6bc2qLMb9NSrK3tr4fTpfU5X3NR7hYn9wqjLMGGoRvV8r00UjK3oZ5UIdiYIFXS3cmkytmNPJ1AxkG25+0P9fmH+vCxauq22i6b1NktPp5b3mHeNQDJ5h8NwevB7hqELCzAT8Lv0e4ayFTAgNQ7UcNdSqdDCQK8E08sVcxuz73GiLZ41Y06nk3hbn1uHc9s2cWWUKZwbvMutIkyZYKdF8FTtv263TB6JnWhdRROtCymuM9OyoYi3vPfazGFj0geCNxvO2VDWhYa2c78defK3rn9XLYVNXXd7u36+6SBy+n+9CqjOlz2/d502kCOhvcfaCnb3R/+MbFyO82szL9VZXPARtcRjFoslv6W2h9H9ttpizMpeTc7ctJGpiG39v+W8O5H6fP6e3m4oLKDI+Lh2sBjcLshsLJ//FDWhwnRw/Xlkv+KY0ZX8F8no8QJuX85Hqfk9peXy/2lPH+dkNtfFspNUezcVGVb/bI/tV9JUeHlctjo6tT5jdViEototCfb6qW87HQI4iuUfSqbWldFzm+8bZcq8xbDXF1206WqPk/I/rxUGFfUcsWiVjcqYApXXjVjW6kyXbr6rWrO/ENGV6fzSCOcH6pD1ZTtsWFquCOgTCupgm3ZVuvB5TeMbNpgkVi9z/JJ1Nekwl6Ozb5sf8ZedZQ2XpSKO388fjb61/vqfC4/cFKdNuKx1l98A+2uLBBENxJE0vx+goqyvByRJXB2hMjWrL91Ux7YqaMNbk+YTkp8sH6bSaJara178L1XUB/W9afdPQN6HGXcMLCZ9Ou+/HL/+K4yXmV82K3uyv2Jc6b6d6k9NYnTM2NKuwtSMT//8tOP/2GkmN/Ftv3Hn/79z7ecWTcXpjeLKic+4sfdh2NTtx9HJ9R3e0OuTspMYBzb5ng4t81l0x4bgcQH2tz/FsY4TA+CJ+1vJBqHhk7IdmqObbWxQjaR7mHb8vfjtn6pK9GNM31ecUTrc1VtJcMYGt6nW6UKYnc+1vsbJgR3WsaDNQrpFDgzINIVxuM62pS7zWWn9xI33fl097vm4OTu1eaWxtD6jvkwcs7rj+Vhu6ua9ak5fvkq1u/2u5NNPLL6ULdrN184iaXV4455MbKYJOGcesHrByL95em0+0oDmwnVpPUdWg/Vl9YNAicU2x3u1b1sxt0u91gG497K+rBwEJ5+d4xkX5UHXYK0QsKJMTg97n0OTbUpd7tly8/X8d6xvBwbvYNcPham471jGYP7G8bj6XzHmLo71IHYenNpPlWSoTB9Fu7lrG0pq/TVNqHL9p53u7lX8m6+cTTVqSrbCc3XBsvvUTM2Ibm/vFyuXkNN1TZ19WmK+DFgdBov19kcd7vfy80fUzM1Nlkuv1sEE9KvDW4YezUkviafM2ok0iEMoaSR05+mql9TqkUR1A2B080D8gdQ0rhpieqb4idJ2HT7GGbu33f7Ik33xE7LQqbb738mcpoMmG6dC0F0MhuU3KV7ZpM6H5Lcqn0mMpkMSG7VOR+XzIUjd2kWzfVUMHLzipPGJMJQ5NZxCCKS2UDkricgikekYchdIxFFI9Ig5K6RiGORJSHIrSMSRSKCAGSBflyrOrMVTv3zD7DoRezLobbf5NE/LZJRH2wR9WGZhO3x8vvOfh+8+1H8Qviv//K/3zdcmxkUer7PddsVi9/PyntYD23X3r3tdXCePR3MawExN3PK1Lwy9WrKonll0aspi+eVxfcoI7y9c94HwErfiV4GoEH7BMBU3MNp5u1UNDhv1CbVdYsqnDPRH4f8dDx8qho3AEXX5PNEvuPxSXqY/IAHj8k3QfRlAK+emRevBZroW9deRdPvWwv0tPVeoKZvdfu8GVzW+LMn/9zhtks0SjNqLhWCxBpR+X4V1Idt9SV4+hYM27ynQD1Gj0WwCl7qarfVp0p0g1kFm+N+Xxl/uD1uLuaf7/tmv1Vaq27ctX4TBqvncBWnj0kG79+vnofO5oL5YZAx/mI6QrB6Bq4jOB2BdFTB6llxHZXTUZGOUbB6jriOkdMxIh3jYPUccx1jp2NMOibB6jnhOiZOx4R0TIPVc7qK8sewyEnH1OmYko5ZsHrOVlHymOQJ6Zg5HTPSMQ9WzznXMXc65qRjEayeC65j4XQsKACaBwi5ruDCAxY9Bh9gOzMAUYJAcwFqFcNjnEa0swsRUIpAswER29kFCShJoPmAeBXBYxHSJwsuTEBpAs0IJKxmFyigRIHmBFJ2wblQAaUKNCvAcgUuWEDJgtx/zy5cQOmCwgc0uHwBBUyFPqaVy5eifCnwYa1cvJRloJQXbMXYKIqXMnjl3ENWLl6K4qVi76pQLl6K4qUMXvw9u3gpipfSwCjWESgXL0XxUhoYxToD5eKlKF5KA6PYxaxcvBTFSxU+Q6tcvBTFK9LEKN6huHxFlK9II6NYpxK5gEUUsMi4QNaxRC5gkeUFNTKKNQQR4wgpYJFGRmVsZxewiAIWJV5DELmARRSwKPUZgsjlK6J8RZnXcEYuXxHlK/J6xsjFK6J4RV7nGLl4RRSv2O8eYxevmOIV+91j7OIVU7xiv3uMXbxiilfsd4+xi1dsbbQMXjm71WL2WhSvOPE6qdjFK6Z4xamXzdjlK6Z8xd5dV+ziFVO84txrdWOXr5jyFRc+NmOXr5jylYQ+NhMXr4TilYCXzcTFK6F4JcrLZuLilVC8Er97TFy8EopXYvAq2A25i1di7eX91ithtvMUr0QDE7HuMXHxSiheiSYmYt1j4vKVUL4SP1+Jy1dC+Uo0MhEbbCUuYAkFLA296zF1CUspYalmJmKda+oSllLCUs1MxDrX1CUspYSlJkxknWvqEpZSwlLNTMQ619QlLKWEpZqZiHWuqUtYakWMhjDWdKZM0EgJSw1h7MJIXcJSSliqmYlZtlOXsJQSlmpmYpbt1CUspYRlmpmYxTNzCcsoYZlmJmYJy1zCMkpYppmJWcIyl7CMEpZpZmKWsMwlLKOEZSYZwRKWuYRllLBMMxOzhGUuYRklLNPMxCxhmUtYZuUlNDMxS1jGpCYoYZlmJmEJy1zCMkpYpplJWMIyl7CMEpZrZhKWsNwlLKeE5ZqZhCUsdwnLKWG58oY1uUtYTgnLNTMJi2fuEpZTwnLNTMLimbuE5ZSw3KS8WDxzl7CcEpZrZhIWz9wlLKeE5ZqZhMUzdwnLreyXIYzFM2cSYJSw3ASRLJ65S1hOCSs0MylwIWjhElZQwgrNTMpCUriEFZSwQjOTsjv1wiWsoIQVmpk0Zju7hBWUsEIzk7LxWOESVlDCCs1MmrKdXcIKSlhhEqsZ29klrKCEFZqZlN17Fi5hBSWs0MykBdvZJaywcqwmCxaynZk0q51n1dBkwOYNQy7TaqVaQ81NxqdLQybZGlrZ1lCjk/EZ05DJt4ZWwjXU9GQsa901u7+Vcw01QBmfNw2ZrGtopV1DzVDGEtdds/tbmdfQpC5Y6Lprdn8r+Rqa8JLlrrtm97fyr6GGKWPR667Z/a0UbGiiTJa+7prd3+LPpO5znj8u0++k+sFrIoFN9lv8mQQ+v/SAy/fbCX+Tw8/ZTQBwKX8752/S+Dm7DwAu62+n/U0mP2e9OXCJfzvzb5L5OevQgcv928l/k8/P+dIBl/638/8mpZ+zbh24CoBdAjBpfd7LAVcFsMoAYFL7vKMDphIAVikATHqf93XAVAPAKgeAyfDz7g6YggBYFQEwSX7e4wFTEwCrKAAmz887PWDKAmDVBcCk+nm/B0xlAKzSAJhsP++9gCkOgFUdAJPw9/gvpj4AVoEATM7f47+YEgFYNQIweX+P/2LKBGDVCcCk/j3+i6kUgFUqAJP99/gvplgAVrUATAHA47+YegFYBQMwNQCP/2JKBmDVDMCUATz+i6kagFU2AFMJ8PgvpnAAVuUATDXA47+Y4gFY1QMwBQGP/2LqB2AVEKCrILCRCTA1BLCKCGAKAzkbnABTRwCrkACmNlCw8QkwpQSwaglgygMF/64GU00Aq5wApkJQ8P6TKSiAVVEAUyQoeP/J1BTAKiqAqRMUvP9kygpg1RXAlAoK3n8ylQWwSgtgqgUF7z+Z4gJY1QUwFYOC959MgQGsCgOYokHB88fUGMAqMoApHPApZGDqDGAVGqCrNPD8MrUGsIoNYOoHbJEWmGoDWOUG6OoN/DsETMEBrIoDdCUH/v0FpuYAVtEBTB0BQn79MXUHsAoP0FUeQn4BMrUHsIoPYOoJng00U34YfjNvjekXyKrtr93bY8/P+iXfb8G6f5usiIYX2L4Fetk9ffv+fXx97Onbd/QGmb6m1SgiIMYCYpGAiAhIsIBEJCAmAlIsIBUJGI4gGqUoNUpRedctVzJh3adeo6wUzUkRdb30nlIirOzOCByFRUhYKhsQ/gxoFJShO9QRfj+sXCRy8nMydOcZuvN0UCGjontTFslC9911UUUvMZHNpZZYd4eEogeNhhgJR9YdjzTKSNDYchmy/EdC6OngZRDG/Y1GwhvFr5OiGQT0NMJeJAxPPpEtle5AxUofqGg/oShHj0gmDZ01N8qJ0SPJZNNpH4WHhKFnk8merxbmclKMchKhnGpTkoeaoAnKM6EM5oxFdHdoEWfhLRLxoYpILvIDmQw6/ymWSGyICJFZmomTOBF56OGkyyb2MxkfWiFpIZPDLl80nt5IqX6dRf3/E+HT6r9BQqJD7N+EUi5EBF5f/ervRxX1pjWWTWJlDm5FzwFJTmUrl54LPYoCfJu9sVKqH13/f6Hd962dUYFsPU+uGGSvZTf+Utr2OUHU5LLV8VJ/2ZrvL5AUNHGZWMrwvQiSg0xLLsPspf7Sfw6CxKAllcmW1HDqwygkx3s6kLHpfuCI5BG4hm1EJPNZ3aml9rTHyLZnQkHme0k0KsB3OTjoSHi75+ZcjkcTIq+P7jUXPoBzc8Zf6o/CkCwhEufmfP0OGc0WWnyZbBd7PSiXH1mMFmAmC1zs41ARtMj95TIjwx25gh4tDotAZiA+mNO2kXHFO2CZxfrQ/UEjtItBMiLhLPXneKLZQVY+l6H+0d4qoqeVysbhnKKA/BleOOGwcJRs4dhHQyCxiPZiMBJKdsPm62P0/JFph0i2CqcjKzSBxRAeKNlKGgSzchH5hRrkytZ6ff3+E+1W8KOJZUupZjfyRYYlCZ9t/wk0kYPj3lg2Y8Nf50HbE5wo6WN6Yb6E+XMYSC5yI6qXmyyQ6z4BwJFk0m/zZNM3/mkGtHLRA02EYo5EgkJTF8nI2vd/hAENAwlJZVhdz0tGlgzNTS4zqVPhDc4ZyYRZB3Ug24N3PGEy7AWEYoeTq9GdIgeUy3g6UI4iZA2FuYLusDNkBfGiAdl8Owe6oDnCTjUcEmtCpDzHgiDpOZY+xEnCFJF1BA6SiqcgvBpYmUfwHKqCpGMbGQ4JN6GjnziaBGnAjizMBw2yHU1/HhryNmjFFEMiCmSTwW8DU/TUiuGhqQXDc84bRLJxVD/cOsiWJOcaMWCxLFJzwzTAj7y/4bi3F+mwFUpkg+ykO6lwZCSFBqgxfxXUtvvIgAh3UVc5tfnbrkgW8kLCfV5Tse4MEZjIwBsOh0R2DW8pQLbaur8ziJ4jljHkOaSzPZEaw/svobTxTER0ixgzEMLq7kXQClI9pHG/kpJhRcXSxzCe0oDTRviGE9nC70TZkrAHluLay3Gzx2itC6ti48ma6CngvZxwUPbfhEN3SPINXXfVxxJx/3+h5XBKXmjyimH3omQrg/kbLyjMRwRlsoXP+jGcie/vvDeWUf9/IYZOwgtIBbS/9V5mNDDfu+ZkmBrhFt8oc+wzUigsEHWnqeBVgxNiwvKGHsdmOEEHuTW8QxBmubvzvtDTwa4xklkbullFUzLf+/0qONWnalcfquDp+f337/8HmaBIkJeHAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8WdbY/bOJKA/8pB/dXTUVHv/W1uZm4nwO7OIlkscGgEhmKr08L47WQ76d4g/31BSrKqyKJUshu4T+lYYlWJfFhFVsn096DZfzsGD4/fgz/r3Tp4UEm6CHbltgoegv/5+OHjP8qm3FanqjkGi+DcbIKHoN6dquapXFXHd/SO++fTdhMsgtWmPB6rY/AQBD8WvWAIVXyR3FT/d66Op2VTnardqd7vhMLvuIZI3SI4lE21O7nGewzZli/19rxdGrVfy43UDqbdLWZ8k+r9dqOiald+3lTLp/O//y1VSZu8gfLj8745LU9Vs51pAmk40xDM9S9ls+ZU68/lDK/P1aiQu/YG3k5jgkfw8VR+rjf16XVcPL5tvpJ1/fRUr86bKS3kvvlqqk15OFbr5bp8ZR3IoMi684puWz1X6/NGpMy5d766pjpMKOnumC/a9MSE8Ms9V/F1mkC3v+Ua2413/lpXrE/DD4BvFCnCc/iDafnX/RdOy+XijIhUnuqdQNjd5Ube5MGuub1v6Rkfgkk1Hu9kKRlzUZIn8fsp92kmnNX0E416LPvBpt3WpMIp32WpFDmwSaVmWszUzLW5dkwnnag9sDJPOqnY7zLs+TfuMjhFKiwySBTyHat9s8a+4/R6MJq6z0fdhlfa+1O19UnU10alpkkSDd5tudTtJ4XdXe7zdQY2zdPzK7wamtB0390sUHff2ebj3N/7jtL23qt02oP1UXvVf7p9e/l83tCbWMCIGy7MkveXplzbosxn41Kspe373eF88gVfc1EeFkfXCoMswYKhtWr+WhopmVpQj6oQLEyQKunqZFTl5EKediATIE/H9U/18ad691w19alaz+vUySU+7ls+YN5kgGTxj0zwRrCbjJBtC/BI+CPaTYaMbRiQemfXcJPS8a0EAd7ZT8xVzC7Pvc6I3vGmC3Xcm8LV+tQ8nliyiz2hTOHU4l3oE2XKBCsvgqds+XW9Y/R06kzvKOxo2Z7iNj8pM0W85r/VYwqHSL4RuN13ykyatzWyg/nb9pW9cvu1PFXU1bWrt8vnow4up+vTi4xqd952a9NxBzk43r+jqWw3v/v7yMxtNbMy/1qVzQ47XUcwumO29A/U/ziyP4x7nFHJm0nLyT0yDbm1/reEtx9Kx+tv5e6Myg6OiLvLDR6H25rAyv75S1nvRkT31+dL/h3vGV3Bv4/uEkfk/mW/H5PbXZ4v97fy+Doit7sslJuivXNTlafqt+3h9EqKCk/n3UpXp47vrDtGsYgGf7KunsrzRm9BfIWyr2VT66rI8Z333rnKvMUwV5d961xV30Zkf5srjCtquWLRXVcqYApXXjXDvVJlunT1r6o58oOMro7nkQY4v1S7qilP+4ap4Q6AMndJFazLU7XsQ37DyKY3zBKr11k+ifqaVNjTvtmWp19xVB2kDRel4o7P+29G/3JbHY/lF06qc4/Y1vrFZ2h7ZYYgupAgkqbXE1SUFeWILEGwI0SezPxbNuWO7Tp6w/UJ01GJd9ZnE0lU627rGXzvFdS7Zf11c4tB94OMKwybSL9uy5fb7bvIeBP7cFjdlNsDF0z151J/ahKnR8aVthekYn797Zef/5eRYj4X+/aff/nnHx84t24ujC8WVU5ixM+bL/umPj0PQahr9o5cHZWZwGDbar87nprz6rRvBBLv6O3+tzAGMz0IHnS8kWjsb3S2bIdmf6pW1pZNpLtftvxtv66f6kr04EybN7RoeayqtcSM/sbbdKtUQez2x3J7RYfgRvN4sKyQdoHTAyJdYTzMo1W5WZ03ei1x1ZOPN7+pDw7uWm1qavR339AfRs5x+Vzu1puqWR6a/curWL/b7kY2sWX1rj4t3XzhKJZWixv6xchikoRT6gWvH4j0l4fD5pVubEZUk7tv0LqrXk7uJnBEsd3gVt3zetxtcotnMOGtrHczjfC0u8GSbVXudAnS2hKO2OC0uHUcmmpVbjbzpp+v4a22PO0bvYKcbwvT8FZbhs39FfZ4Gt9gU/uEeiO2XJ2br5XEFKbNzLWctSxllb7ZInTe2vPmMPdG0c1nR1MdqvI0ovlyw/xn1IyNSO4uz5er51BTnZq6+jpG/LBhdG6er7PZbzafy9WfYz013DJffjsJRqRfbrjC9qpPfI2OM7pJpEO4hZLunP5rrPo1plq0g7pi43S1Qf4NlHTfNEf1Vfsnybbpehsmnt/3+CJNt+yd5m2Zrn/+iZ3T6Ibp2r4Q7E4mNyU36Z5YpE5vSa7VPrEzGd2QXKtzel8ytR25SbOor8c2I1fPOOmeRLgVudYOwY5kciNy0wiI9iPSbchNloh2I9JNyE2WiPcic7Yg11ok2okINiAz9ONa1ZGtcOqPf4JZL2Kfd7X9Jo/+aJaMemeLqHfzJKz3588b+33w9kPxC+Hv/+F/v6+/NmEUGt/H+tQWiz9Nyrtb9vcuvWvbi3GeNR1MawExN1PK1LQy9WbKomll0Zspi6eVxbcoI7x9dN4HwEo/il4GoJv2EYCpuLvDxNupyDjvrk2q6zpV9leH+u3fHwfjq5yvxFjXb/8KESdw+mtEtpneV4m7L+P83qZM5mi/ZxoLzWFqyTd2hWNMp+InmG2V+1yj72Ef/2jWVfPfrzOttZr+f3YcNqXvtuiabiPP5HtN+c/6YL1CKbGSNLu6s4gl54N5N2lbbffN65J+ZUBiEt/+bWzb7b/NsqW9/210P9XN8bRkv2Q4ZgJpdrUltsN9/8HNyrXWoCu3Ollb1JR7xUZ5OnG132yqFRciPMruaYtJxRODOOQp9arO/parzwa31TV2oDqD/kLlL/vd16pxk7bomnxtQbD0SbobpRDb5FtU0BfovHomvqwk0ETdjlfRuHcR6DnVW4Ga7q7r+82EgCX+qrC/7/C9czRKq1AuFYJiFFH5aRHUu3X1Ejx8D/rUyEOg7qP7IlgET3W1WeuTmFpjFsFqv91WZg+53q/O5s9P3W3/qrRWfXN797swWDyGizi7j9WnT4vHvq353HzQixg+Me0gWDwC0w6cdkDaqWDxqJh2ymmnSLsoWDxGTLvIaReRdnGweIyZdrHTLibtkmDxmDDtEqddQtqlweIxXUT5fRFnpGHqNExJwyxYPGaLKL2Po5g0zJyGGWmYB4vHnGuYOw1z0rAIFo8F17BwGhZ07DUKEHJNweUGLHAMOcA2ZuCh9ICGAtQiVvcRWOC5BAFFCDQZELGNXYyAcgQaD4gXkbrPEjqy4LIEFCbQjEDCanaBAkoUaE4g5eaayxRQqECjAixW4HIFFCzI/Y/ssgUULih8PIOLF1C+VOhDWrl4KYqXAh/VyqVLWb5JeblWjH+idClDV86NsXLpUpQuFXsnhXLpUpQuZejin9mlS1G6lAZGcRFAuXQpSpfSvCguCigXLkXhUhoXpTi4lAuXonCpwudllQuXonBFmhfFhhIXrojCFWleFBdOIheuiMIVmcjHhZTIZSuygp+mRXEuIGLiH0Ur0rCojGvrkhVRsqLE6wEil6yIkhWlPg8QuWRFlKwo8zrMyEUromhF3ogYuWRFlKzIGxQjl6yIkhX7w2LsohVTtGJ/WIxdtmLKVuwPi7ELV0zhiv1hMXbpiq3llaEr5xZYzAqL0hUn3uAUu3TFlK449aIZu3jFFK/Yu9iKXbpiSlece71t7OIVU7ziwodm7OIVU7yS0Idm4tKVULoS8KKZuHQllK5EedFMXLoSSlfiD4uJS1dC6UoMXQW3DHfpSqwFvN93JcwintKVaF4iLiomLlwJhSvRvERcVExcuBIKV+KHK3HhSihcieYl4jZXiQtXQuFKQ+9cTF26UkpXqnmJuJCaunClFK5U4xJxITV12UopW6nZFHIhNXXRSilaqaYl4kJq6qKVUrRSDUvEhdTUJSu19oeGLM5hpswOkZKVGrK46ZC6ZKWUrFSzEnNEpy5YKQUr1azEHNGpC1ZKwco0KjEHZeZylVGuMo1KzHGVuVxllKtMoxJzXGUuVxnlKtOoxBxXmctVRrnKTMKB4ypzucooV5lGJea4ylyuMspVplGJOa4yl6vMSj1oVGKOq4xJPlCuMo1KwnGVuVxllKtMo5JwXGUuVxnlKteoJBxXuctVTrnKNSoJx1XucpVTrnLl3bfkLlg5BSvXrCQclLkLVk7ByjUrCQdl7oKVU7Byk83ioMxdsHIKVq5ZSTgocxesnIKVa1YSDsrcBSu30loGLA7KnElsUbBysz/koMxdsHIKVqFZSYHbXBYuWQUlq9CwpOxCvHDRKihahYYlZRfihYtWQdEqNC1pzDZ22SooW4XGJWW3W4ULV0HhKjQvaco2dukqKF2FyZdmbGMXr4LiVWhiUnZtWbh8FZSvQiOTFmxjF7DCSp2a7FbINmayp3b6VEOTAZsODLkEqpVBDTU3GZ8FDZkcamglUUONTsYnQkMmjRpaedRQ05OxrLXX7PZWKjXUAGV8OjRkkqmhlU0NNUMZS1x7zW5vJVRDk5lgoWuv2e2tpGpoto8sd+01u72VVw01TBmLXnvNbm+lVkOzi2Tpa6/Z7S3+TEY+5/njEvhOBh+8LhLYHL7Fn8nL81MPuDS+ncc3qfmci/3AJfLtTL5Jzudc+AculW/n8k16PueCOHDJfDubbzL0ORfHgcvn2wl9k6PP2WoAl9G3U/omS59z0Ry4nL6d1DeJej6+AZfXtxL7YJL1fIgDJrcPVnIfTMKej3LA5PfBSvCDydnzgQ6YFD9YOX4waXs+1gGT5QcrzQ8mc8+HO2AS/WBl+sEk7/mIB0yuH6xkP5gEPh+3gMn3g5XwB5PE90QuJucPVtIfTB7fE7mYtD9YeX8wuXxP5GJS/2Dl/sHk8z2Ri0n/g5X/B5PT90QupgQAVg0ATF7fE7mYMgBYdQAwuX1P5GJKAWDVAsDk9z2RiykHgFUPAJPi90QupiIAVkkATJrfE7mYqgBYZQEwmX5P5GIKA2BVBqAtDXAbEmBqA2AVB8Ak/HNuTwJMeQCs+gCYlH/BbUuAKRCAVSEAk/Qv2JcumBIBWDUCMGn/go2aTJEArCoBmMR/wUZNpkwAVp0ATO6/YKMmUykAq1QAJvtfsFGTqRWAVSwAk/8v2KjJVAvAKheAKQEUbNRkCgZgVQzAFAEKljqmZABWzQBMHYBPCgNTNgCrbgBt4YCllqkcgFU6AFMN4DMewBQPwKoeQFs+CFnsmfoBWAUEMDUBn36GPKuGAKYuACE7b5gyAlh1BDClAZ9+7u0Niz1THoCQnXhMNQGscgKYEgGE7MxjKgpglRSgrSmE7NRjigpgVRXAVAogZOceU1gAq7IAbWkh5F9gYfiziguQjvDH1BfAKjBA2vLHzl6mxgBWkQFM4QBCdvoydQawCg2Qtvyx84+pNYBVbABTQGBfdgCm3ABWvQFMDcHzChBTcgCr5gCmjuB5C4gpO4BVdwBTSwBgpz9TegCr9gCmngDATl+m/ABW/QEyfz4PmBJE/5l55VK/fVmt37evXj4+6m+VfQ+W3auYRdS//fk90OHu4fuPH8O7lw/ff6DXL/U1rUYRATEWEIsERERAggUkIgExEZBiAalIQP9K+iBFqUGKyttmuWr/1dGg+yPq/0i6P1KQKWzPHxj0pajfil6qkgkr24OrB2EREpYqmQz03fRBUIZ6QWfcOrNykcjRMw7Qk2foydNehYyc9lV0JAs9d9tEFf3AyFDSEuv25HoEAzIxElrWntk5yEiQbbnQFvylhUGSdvvDqAjHl/8WPBppPO3CuOu0SAYgefcbjQagkQ07kdBTlIUy2ebE8EqfGG6PdpSj4ZZNdHSY8iAnRv2ZyYbGPusZCUPjnMlY0cJc5opBTiKUU61KMqgJ6qA8E8pgDhFHT4ccgnAAR04NR3JR3Mlk0PmPaUdiQ0SIzGuNHDWPyEODk87r2G/EPjRD0kImh52+yJ7O4alunkXd/xPhaHVfskeiQxxPhVLORASeX93s76yKOjcdyzqxMr9MgMYBSRY6ePrDJ9irYgfY9WEX8OPu/4mMTN/cGRTI5vPojEH+WvbgT6XtnxNETS6bHfh7iLjvcPRIZCA/1S9r870rZBAag0xq0Ev/PTEkB3mpXEbsU/3SfQ0MiUGzMxM+VHdC2iAkx8tRkGHuHgaC5BFO+9VNJAt/7Qn/drfHKExkQkHmbBFkFeCn7GN9JHzcY3Msh2O80QICPWsuHIBjc8SnWg3CkCwhEsfmeDmzB/UWmseZbPF1+VEJ3rIYzZ5MtueyfzoAQYsiaS7zV9zxhGho8Y4OZL7mi/llGuSn8cJc5vy+tD/+iRZESEYk7KXuzHvUOyhg5DLUn+1VJxqtVGaHc+IYCo144oT9xFGyiWMfo4bEItqL3kko2QObk3rQ+KMoAZFsFo5v+FAHFv1OQ8lmUi+YlYvIL/qtupLN9fpyVgpa+OChiWVTqcZHWOIAiaNAKrSJ3V8UePMnXDb1Rw8ROXhrH8t6v/9VTPRgOF/UpS2EaSPmZ+iQXBSSVCc3mSHXHU0gS5Ru9SnrvuEn0ZAXQHAkQjF7IkGhrotkRGy7MzqQGUiIMPV0+Z0S5BVR3+Qy9zy268KpM5kw64A85MfwvAn7JFskFNv/Ygx6UhTMchlPO8pRhDxrInOo7SHDyKPiSQOy/nYOUkR9hAN02OcOhUh5juND0nMsvd++CbNg1tGTSCrugvDirGXRxXOYIZKOfWTY5xSFi4aRIwGRBhwUw7zXIFsdmfNkcHDAA5jI9j3dWcYo+qFZV/Q5NpB1KL8sTdHIF/3AK9kj8meFI9k4YdF3H8imNReqMaSxrAfdbSNgbLoHjjufk/ZLM2GisZXuVBWQoxU6sfa8LDt2ICckXNVd5Dz354lhAvGmMplpWHuYDTIOhUbhQrap2BiLkBYmFfqT4pGzxesckLmA9kfHUf9gGX1OSNpLI2lEvMAUSuNWlznmFoT024cRYRrwbBJucQZ5+4NTsSiwtxQmIpkVHJKiumkZd74j6X1ILOVkOB8HaQA8IsKEbCvKlkTW+/PkuKUANB7Ckmp3XNxeHxf3+ZWOLn5GYWVh+FkBRB1eUAuf0f5BbNz1WFrbXHWbw7j7v9AxOaVVNBZFv4RUMqyZH7hEeRsEZCZzdPqkPXcVr1+kQWMi7EtuXYILPl0ndoEr6v4vnCBOMhRIYb/rxU5m1M/Gbqk1VMOFvaKVObESKRTWIdsTtjBUOK4JC0DajlV/qhoeI+zEhEms9uBkNDzYs0Yye9iTELFdeCkt3IrSHQ3q5+nWnxbBoT5Um3pXBQ+Pn378+A/tHPFfNJUAAA=="; \ No newline at end of file diff --git a/classes/FSRS.html b/classes/FSRS.html index 90a9179..145c0d0 100644 --- a/classes/FSRS.html +++ b/classes/FSRS.html @@ -2,7 +2,7 @@ window.__typeDocPluginKatexOptions=undefined; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

Class FSRS

See

https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-Algorithm#fsrs-45

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

_seed? intervalModifier param @@ -28,24 +28,23 @@ repeat reschedule rollback -

Constructors

constructor

Properties

Protected Optional_seed

_seed?: string

ProtectedintervalModifier

intervalModifier: number

Protectedparam

param: FSRSParameters

Accessors

interval_modifier

  • get interval_modifier(): number

  • Returns number

parameters

  • get parameters(): FSRSParameters

  • Get the parameters of the algorithm.

    -

    Returns FSRSParameters

  • set parameters(params): void

  • Set the parameters of the algorithm.

    +

Constructors

constructor

Properties

Protected Optional_seed

_seed?: string

ProtectedintervalModifier

intervalModifier: number

Protectedparam

param: FSRSParameters

Accessors

interval_modifier

  • get interval_modifier(): number

  • Returns number

parameters

seed

  • set seed(seed): void

  • Parameters

    • seed: string

    Returns void

Methods

apply_fuzz

  • apply_fuzz(ivl, elapsed_days, enable_fuzz?): int

  • If fuzzing is disabled or ivl is less than 2.5, it returns the original interval.

    +

Returns void

seed

  • set seed(seed): void

  • Parameters

    • seed: string

    Returns void

Methods

apply_fuzz

  • apply_fuzz(ivl, elapsed_days): int

  • If fuzzing is disabled or ivl is less than 2.5, it returns the original interval.

    Parameters

    • ivl: number

      The interval to be fuzzed.

    • elapsed_days: number

      t days since the last review

      -
    • Optionalenable_fuzz: boolean

      This adds a small random delay to the new interval time to prevent cards from sticking together and always being reviewed on the same day.

    Returns int

    • The fuzzed interval.
    -

calculate_interval_modifier

  • calculate_interval_modifier(request_retention): number

  • Parameters

calculate_interval_modifier

constrain_difficulty

constrain_difficulty

  • constrain_difficulty(difficulty): number

  • The formula used is : $$\min \lbrace \max \lbrace D_0,1 \rbrace,10\rbrace$$

    Parameters

    • difficulty: number

      $$D \in [1,10]$$

      -

    Returns number

forget

forget

  • forget<R>(card, now, reset_count?, afterHandler?): R

  • Type Parameters

    Parameters

    • card: Card | CardInput

      Card to be processed

    • now: DateInput

      Current time or scheduled time

    • reset_count: boolean = false

      Should the review count information(reps,lapses) be reset. (Optional)

    • OptionalafterHandler: ((recordLogItem: RecordLogItem) => R)

      Convert the result to another type. (Optional)

      @@ -55,33 +54,33 @@

      ThrowsExample

      interface RepeatRecordLog {
        card: CardUnChecked; //see method: createEmptyCard
        log: RevLogUnchecked; //see method: fsrs.repeat()
      }

      function forgetAfterHandler(recordLogItem: RecordLogItem): RepeatRecordLog {
          return {
            card: {
              ...(recordLogItem.card as Card & { cid: string }),
              due: recordLogItem.card.due.getTime(),
              state: State[recordLogItem.card.state] as StateType,
              last_review: recordLogItem.card.last_review
                ? recordLogItem.card.last_review!.getTime()
                : null,
            },
            log: {
              ...recordLogItem.log,
              cid: (recordLogItem.card as Card & { cid: string }).cid,
              due: recordLogItem.log.due.getTime(),
              review: recordLogItem.log.review.getTime(),
              state: State[recordLogItem.log.state] as StateType,
              rating: Rating[recordLogItem.log.rating] as RatingType,
            },
          };
      }
      const now = new Date();
      const f = fsrs();
      const emptyCardFormAfterHandler = createEmptyCard(now, cardAfterHandler); //see method:  createEmptyCard
      const repeatFormAfterHandler = f.repeat(emptyCardFormAfterHandler, now, repeatAfterHandler); //see method: fsrs.repeat()
      const { card } = repeatFormAfterHandler[Rating.Hard];
      const forgetFromAfterHandler = f.forget(card, date_scheduler(now, 1, true), false, forgetAfterHandler);
      -

forgetting_curve

  • forgetting_curve(elapsed_days, stability): number

  • The formula used is : +

forgetting_curve

  • forgetting_curve(elapsed_days, stability): number

  • The formula used is : $$R(t,S) = (1 + \text{FACTOR} \times \frac{t}{9 \cdot S})^{\text{DECAY}}$$

    Parameters

    • elapsed_days: number

      t days since the last review

    • stability: number

      Stability (interval when R=90%)

    Returns number

    r Retrievability (probability of recall)

    -

get_retrievability

get_retrievability

  • get_retrievability<T>(card, now?, format?): T extends true
        ? string
        : number

  • Get the retrievability of the card

    Type Parameters

    • T extends boolean

    Parameters

    • card: Card | CardInput

      Card to be processed

    • Optionalnow: DateInput

      Current time or scheduled time

    • format: T = ...

      default:true , Convert the result to another type. (Optional)

    Returns T extends true
        ? string
        : number

    The retrievability of the card,if format is true, the result is a string, otherwise it is a number

    -

init_difficulty

  • init_difficulty(g): number

  • The formula used is : +

init_difficulty

  • init_difficulty(g): number

  • The formula used is : $$D_0(G) = w_4 - e^{(G-1) \cdot w_5} + 1 $$ $$D_0 = \min \lbrace \max \lbrace D_0(G),1 \rbrace,10 \rbrace$$ where the $$D_0(1)=w_4$$ when the first rating is good.

    Parameters

    • g: Grade

      Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]

    Returns number

    Difficulty $$D \in [1,10]$$

    -

init_stability

init_stability

  • init_stability(g): number

  • The formula used is : $$ S_0(G) = w_{G-1}$$ $$S_0 = \max \lbrace S_0,0.1\rbrace $$

    Parameters

    • g: Grade

      Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]

    Returns number

    Stability (interval when R=90%)

    -

mean_reversion

mean_reversion

  • mean_reversion(init, current): number

  • The formula used is : $$w_7 \cdot \text{init} +(1 - w_7) \cdot \text{current}$$

    Parameters

    • init: number

      $$w_2 : D_0(3) = w_2 + (R-2) \cdot w_3= w_2$$

    • current: number

      $$D - w_6 \cdot (R - 2)$$

    Returns number

    difficulty

    -

next

  • next<R>(card, now, grade, afterHandler?): R

  • Display the collection of cards and logs for the card scheduled at the current time, after applying a specific grade rating.

    +

next

  • next<R>(card, now, grade, afterHandler?): R

  • Display the collection of cards and logs for the card scheduled at the current time, after applying a specific grade rating.

    Type Parameters

    Parameters

    • card: Card | CardInput

      Card to be processed

    • now: DateInput

      Current time or scheduled time

    • grade: Grade

      Rating of the review (Again, Hard, Good, Easy)

      @@ -92,34 +91,33 @@

      ExampleExample

      interface RevLogUnchecked
        extends Omit<ReviewLog, "due" | "review" | "state" | "rating"> {
        cid: string;
        due: Date | number;
        state: StateType;
        review: Date | number;
        rating: RatingType;
      }

      interface NextRecordLog {
        card: CardUnChecked; //see method: createEmptyCard
        log: RevLogUnchecked;
      }

      function nextAfterHandler(recordLogItem: RecordLogItem) {
       const recordItem = {
         card: {
           ...(recordLogItem.card as Card & { cid: string }),
           due: recordLogItem.card.due.getTime(),
           state: State[recordLogItem.card.state] as StateType,
           last_review: recordLogItem.card.last_review
             ? recordLogItem.card.last_review!.getTime()
             : null,
         },
         log: {
           ...recordLogItem.log,
           cid: (recordLogItem.card as Card & { cid: string }).cid,
           due: recordLogItem.log.due.getTime(),
           review: recordLogItem.log.review.getTime(),
           state: State[recordLogItem.log.state] as StateType,
           rating: Rating[recordLogItem.log.rating] as RatingType,
         },
       };
       return recordItem
      }
      const card: Card = createEmptyCard(new Date(), cardAfterHandler); //see method:  createEmptyCard
      const f = fsrs();
      const recordLogItem = f.repeat(card, new Date(), Rating.Again, nextAfterHandler);
      -

next_difficulty

  • next_difficulty(d, g): number

  • The formula used is : +

next_difficulty

  • next_difficulty(d, g): number

  • The formula used is : $$\text{next}_d = D - w_6 \cdot (g - 3)$$ $$D^\prime(D,R) = w_7 \cdot D_0(4) +(1 - w_7) \cdot \text{next}_d$$

    Parameters

    • d: number

      Difficulty $$D \in [1,10]$$

    • g: Grade

      Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]

    Returns number

    $$\text{next}_D$$

    -

next_forget_stability

next_forget_stability

  • next_forget_stability(d, s, r): number

  • The formula used is : $$S^\prime_f(D,S,R) = w_{11}\cdot D^{-w_{12}}\cdot ((S+1)^{w_{13}}-1) \cdot e^{w_{14}\cdot(1-R)}$$

    Parameters

    • d: number

      Difficulty D \in [1,10]

    • s: number

      Stability (interval when R=90%)

    • r: number

      Retrievability (probability of recall)

    Returns number

    S^\prime_f new stability after forgetting

    -

next_interval

next_interval

  • next_interval(s, elapsed_days): int

  • Parameters

    • s: number

      Stability (interval when R=90%)

    • elapsed_days: number

      t days since the last review

      -
    • enable_fuzz: boolean = ...

      This adds a small random delay to the new interval time to prevent cards from sticking together and always being reviewed on the same day.

    Returns int

    See

    The formula used is : FSRSAlgorithm.calculate_interval_modifier

    -

next_recall_stability

next_recall_stability

  • next_recall_stability(d, s, r, g): number

  • The formula used is : $$S^\prime_r(D,S,R,G) = S\cdot(e^{w_8}\cdot (11-D)\cdot S^{-w_9}\cdot(e^{w_{10}\cdot(1-R)}-1)\cdot w_{15}(\text{if} G=2) \cdot w_{16}(\text{if} G=4)+1)$$

    Parameters

    • d: number

      Difficulty D \in [1,10]

    • s: number

      Stability (interval when R=90%)

    • r: number

      Retrievability (probability of recall)

    • g: Grade

      Grade (Rating[0.again,1.hard,2.good,3.easy])

    Returns number

    S^\prime_r new stability after recall

    -

next_short_term_stability

next_short_term_stability

  • next_short_term_stability(s, g): number

  • The formula used is : $$S^\prime_s(S,G) = S \cdot e^{w_{17} \cdot (G-3+w_{18})}$$

    Parameters

    • s: number

      Stability (interval when R=90%)

    • g: Grade

      Grade (Rating[0.again,1.hard,2.good,3.easy])

      -

    Returns number

Protectedparams_handler_proxy

repeat

  • repeat<R>(card, now, afterHandler?): R

  • Display the collection of cards and logs for the four scenarios after scheduling the card at the current time.

    +

Returns number

Protectedparams_handler_proxy

repeat

reschedule

reschedule

rollback

rollback

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/classes/FSRSAlgorithm.html b/classes/FSRSAlgorithm.html index d0923b0..1dcd863 100644 --- a/classes/FSRSAlgorithm.html +++ b/classes/FSRSAlgorithm.html @@ -2,7 +2,7 @@ window.__typeDocPluginKatexOptions=undefined; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

Class FSRSAlgorithm

See

https://github.com/open-spaced-repetition/fsrs4anki/wiki/The-Algorithm#fsrs-45

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

_seed? intervalModifier param @@ -22,69 +22,67 @@ next_recall_stability next_short_term_stability params_handler_proxy -

Constructors

constructor

Properties

Protected Optional_seed

_seed?: string

ProtectedintervalModifier

intervalModifier: number

Protectedparam

param: FSRSParameters

Accessors

interval_modifier

parameters

Constructors

constructor

Properties

Protected Optional_seed

_seed?: string

ProtectedintervalModifier

intervalModifier: number

Protectedparam

param: FSRSParameters

Accessors

interval_modifier

parameters

seed

  • set seed(seed): void

  • Parameters

    • seed: string

    Returns void

Methods

apply_fuzz

  • apply_fuzz(ivl, elapsed_days, enable_fuzz?): int

  • If fuzzing is disabled or ivl is less than 2.5, it returns the original interval.

    +

Returns void

seed

  • set seed(seed): void

  • Parameters

    • seed: string

    Returns void

Methods

apply_fuzz

  • apply_fuzz(ivl, elapsed_days): int

  • If fuzzing is disabled or ivl is less than 2.5, it returns the original interval.

    Parameters

    • ivl: number

      The interval to be fuzzed.

    • elapsed_days: number

      t days since the last review

      -
    • Optionalenable_fuzz: boolean

      This adds a small random delay to the new interval time to prevent cards from sticking together and always being reviewed on the same day.

    Returns int

    • The fuzzed interval.
    -

calculate_interval_modifier

  • calculate_interval_modifier(request_retention): number

  • Parameters

    • request_retention: number

      0<request_retention<=1,Requested retention rate

      +

calculate_interval_modifier

constrain_difficulty

  • constrain_difficulty(difficulty): number

  • The formula used is : +

constrain_difficulty

  • constrain_difficulty(difficulty): number

  • The formula used is : $$\min \lbrace \max \lbrace D_0,1 \rbrace,10\rbrace$$

    Parameters

    • difficulty: number

      $$D \in [1,10]$$

      -

    Returns number

forgetting_curve

  • forgetting_curve(elapsed_days, stability): number

  • The formula used is : +

Returns number

forgetting_curve

  • forgetting_curve(elapsed_days, stability): number

  • The formula used is : $$R(t,S) = (1 + \text{FACTOR} \times \frac{t}{9 \cdot S})^{\text{DECAY}}$$

    Parameters

    • elapsed_days: number

      t days since the last review

    • stability: number

      Stability (interval when R=90%)

    Returns number

    r Retrievability (probability of recall)

    -

init_difficulty

init_difficulty

  • init_difficulty(g): number

  • The formula used is : $$D_0(G) = w_4 - e^{(G-1) \cdot w_5} + 1 $$ $$D_0 = \min \lbrace \max \lbrace D_0(G),1 \rbrace,10 \rbrace$$ where the $$D_0(1)=w_4$$ when the first rating is good.

    Parameters

    • g: Grade

      Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]

    Returns number

    Difficulty $$D \in [1,10]$$

    -

init_stability

init_stability

  • init_stability(g): number

  • The formula used is : $$ S_0(G) = w_{G-1}$$ $$S_0 = \max \lbrace S_0,0.1\rbrace $$

    Parameters

    • g: Grade

      Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]

    Returns number

    Stability (interval when R=90%)

    -

mean_reversion

  • mean_reversion(init, current): number

  • The formula used is : +

mean_reversion

  • mean_reversion(init, current): number

  • The formula used is : $$w_7 \cdot \text{init} +(1 - w_7) \cdot \text{current}$$

    Parameters

    • init: number

      $$w_2 : D_0(3) = w_2 + (R-2) \cdot w_3= w_2$$

    • current: number

      $$D - w_6 \cdot (R - 2)$$

    Returns number

    difficulty

    -

next_difficulty

next_difficulty

  • next_difficulty(d, g): number

  • The formula used is : $$\text{next}_d = D - w_6 \cdot (g - 3)$$ $$D^\prime(D,R) = w_7 \cdot D_0(4) +(1 - w_7) \cdot \text{next}_d$$

    Parameters

    • d: number

      Difficulty $$D \in [1,10]$$

    • g: Grade

      Grade (rating at Anki) [1.again,2.hard,3.good,4.easy]

    Returns number

    $$\text{next}_D$$

    -

next_forget_stability

  • next_forget_stability(d, s, r): number

  • The formula used is : +

next_forget_stability

  • next_forget_stability(d, s, r): number

  • The formula used is : $$S^\prime_f(D,S,R) = w_{11}\cdot D^{-w_{12}}\cdot ((S+1)^{w_{13}}-1) \cdot e^{w_{14}\cdot(1-R)}$$

    Parameters

    • d: number

      Difficulty D \in [1,10]

    • s: number

      Stability (interval when R=90%)

    • r: number

      Retrievability (probability of recall)

    Returns number

    S^\prime_f new stability after forgetting

    -

next_interval

  • next_interval(s, elapsed_days, enable_fuzz?): int

  • Parameters

next_interval

  • next_interval(s, elapsed_days): int

  • Parameters

    • s: number

      Stability (interval when R=90%)

    • elapsed_days: number

      t days since the last review

      -
    • enable_fuzz: boolean = ...

      This adds a small random delay to the new interval time to prevent cards from sticking together and always being reviewed on the same day.

    Returns int

    See

    The formula used is : FSRSAlgorithm.calculate_interval_modifier

    -

next_recall_stability

  • next_recall_stability(d, s, r, g): number

  • The formula used is : +

next_recall_stability

  • next_recall_stability(d, s, r, g): number

  • The formula used is : $$S^\prime_r(D,S,R,G) = S\cdot(e^{w_8}\cdot (11-D)\cdot S^{-w_9}\cdot(e^{w_{10}\cdot(1-R)}-1)\cdot w_{15}(\text{if} G=2) \cdot w_{16}(\text{if} G=4)+1)$$

    Parameters

    • d: number

      Difficulty D \in [1,10]

    • s: number

      Stability (interval when R=90%)

    • r: number

      Retrievability (probability of recall)

    • g: Grade

      Grade (Rating[0.again,1.hard,2.good,3.easy])

    Returns number

    S^\prime_r new stability after recall

    -

next_short_term_stability

  • next_short_term_stability(s, g): number

  • The formula used is : +

next_short_term_stability

  • next_short_term_stability(s, g): number

  • The formula used is : $$S^\prime_s(S,G) = S \cdot e^{w_{17} \cdot (G-3+w_{18})}$$

    Parameters

    • s: number

      Stability (interval when R=90%)

    • g: Grade

      Grade (Rating[0.again,1.hard,2.good,3.easy])

      -

    Returns number

Protectedparams_handler_proxy

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Returns number

Protectedparams_handler_proxy

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/classes/TypeConvert.html b/classes/TypeConvert.html index 33f7426..a1fd4e8 100644 --- a/classes/TypeConvert.html +++ b/classes/TypeConvert.html @@ -1,10 +1,10 @@ TypeConvert | TS-FSRS

Class TypeConvert

Constructors

constructor +

Class TypeConvert

Constructors

constructor

Methods

card rating review_log state time -

Constructors

constructor

Methods

Staticcard

Staticrating

Staticreview_log

Staticstate

Statictime

  • time(value): Date

  • Parameters

    • value: unknown

    Returns Date

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

Staticcard

Staticrating

Staticreview_log

Staticstate

Statictime

  • time(value): Date

  • Parameters

    • value: unknown

    Returns Date

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/enums/Rating.html b/enums/Rating.html index e956e22..312563d 100644 --- a/enums/Rating.html +++ b/enums/Rating.html @@ -1,9 +1,9 @@ Rating | TS-FSRS

Enumeration Rating

Enumeration Members

Again +

Enumeration Rating

Enumeration Members

Again Easy Good Hard Manual -

Enumeration Members

Again

Again: 1

Easy

Easy: 4

Good

Good: 3

Hard

Hard: 2

Manual

Manual: 0

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

Again

Again: 1

Easy

Easy: 4

Good

Good: 3

Hard

Hard: 2

Manual

Manual: 0

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/State.html b/enums/State.html index 7ec3394..53a0a27 100644 --- a/enums/State.html +++ b/enums/State.html @@ -1,8 +1,8 @@ State | TS-FSRS

Enumeration State

Enumeration Members

Learning +

Enumeration State

Enumeration Members

Learning New Relearning Review -

Enumeration Members

Learning

Learning: 1

New

New: 0

Relearning

Relearning: 3

Review

Review: 2

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

Learning

Learning: 1

New

New: 0

Relearning

Relearning: 3

Review

Review: 2

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/functions/clamp.html b/functions/clamp.html index c302dd4..41b3411 100644 --- a/functions/clamp.html +++ b/functions/clamp.html @@ -1,4 +1,4 @@ clamp | TS-FSRS

Function clamp

  • clamp(value, min, max): number

  • Parameters

    • value: number
    • min: number
    • max: number

    Returns number

Settings

Member Visibility
+

Function clamp

  • clamp(value, min, max): number

  • Parameters

    • value: number
    • min: number
    • max: number

    Returns number

Settings

Member Visibility
diff --git a/functions/createEmptyCard.html b/functions/createEmptyCard.html index 22df750..beff250 100644 --- a/functions/createEmptyCard.html +++ b/functions/createEmptyCard.html @@ -10,4 +10,4 @@

Example

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);
-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/date_diff.html b/functions/date_diff.html index 2631d64..c41c2c8 100644 --- a/functions/date_diff.html +++ b/functions/date_diff.html @@ -1,4 +1,4 @@ date_diff | TS-FSRS

Function date_diff

Settings

Member Visibility
+

Function date_diff

Settings

Member Visibility
diff --git a/functions/date_scheduler.html b/functions/date_scheduler.html index ffb7f7a..35b28ad 100644 --- a/functions/date_scheduler.html +++ b/functions/date_scheduler.html @@ -6,4 +6,4 @@
  • t: number

    时间偏移量，当 isDay 为 true 时表示天数，为 false 时表示分钟

  • OptionalisDay: boolean

    （可选）是否按天数单位进行偏移，默认为 false，表示按分钟单位计算偏移

    • Returns Date

    偏移后的日期和时间对象

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/fixDate.html b/functions/fixDate.html index c48f719..3013363 100644 --- a/functions/fixDate.html +++ b/functions/fixDate.html @@ -2,4 +2,4 @@ window.__typeDocPluginKatexOptions=undefined; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function fixDate

    • fixDate(value): Date

    • Parameters

      • value: unknown

      Returns Date

      Deprecated

      Use TypeConvert.time instead

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/fixRating.html b/functions/fixRating.html index 97d414a..c943835 100644 --- a/functions/fixRating.html +++ b/functions/fixRating.html @@ -2,4 +2,4 @@ window.__typeDocPluginKatexOptions=undefined; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function fixRating

    • fixRating(value): Rating

    • Parameters

      • value: unknown

      Returns Rating

      Deprecated

      Use TypeConvert.rating instead

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/fixState.html b/functions/fixState.html index 84f7ba1..111f1bc 100644 --- a/functions/fixState.html +++ b/functions/fixState.html @@ -2,4 +2,4 @@ window.__typeDocPluginKatexOptions=undefined; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function fixState

    • fixState(value): State

    • Parameters

      • value: unknown

      Returns State

      Deprecated

      Use TypeConvert.state instead

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/formatDate.html b/functions/formatDate.html index d0c7183..bf5e30c 100644 --- a/functions/formatDate.html +++ b/functions/formatDate.html @@ -1,4 +1,4 @@ formatDate | TS-FSRS

    Function formatDate

    Settings

    Member Visibility
    +

    Function formatDate

    Settings

    Member Visibility
    diff --git a/functions/fsrs-1.html b/functions/fsrs-1.html index f01ce94..60d15d3 100644 --- a/functions/fsrs-1.html +++ b/functions/fsrs-1.html @@ -12,4 +12,4 @@

    Example

    Settings

    Member Visibility
    +

    Returns FSRS

    Settings

    Member Visibility
    diff --git a/functions/generatorParameters.html b/functions/generatorParameters.html index c18cacb..4545905 100644 --- a/functions/generatorParameters.html +++ b/functions/generatorParameters.html @@ -1,4 +1,4 @@ generatorParameters | TS-FSRS

    Function generatorParameters

    Settings

    Member Visibility
    +

    Function generatorParameters

    Settings

    Member Visibility
    diff --git a/functions/get_fuzz_range.html b/functions/get_fuzz_range.html index a1be42c..c63b883 100644 --- a/functions/get_fuzz_range.html +++ b/functions/get_fuzz_range.html @@ -1,4 +1,4 @@ get_fuzz_range | TS-FSRS

    Function get_fuzz_range

    • get_fuzz_range(interval, elapsed_days, maximum_interval): {
          max_ivl: number;
          min_ivl: number;
      }

    • Parameters

      • interval: number
      • elapsed_days: number
      • maximum_interval: number

      Returns {
          max_ivl: number;
          min_ivl: number;
      }

      • max_ivl: number
      • min_ivl: number

    Settings

    Member Visibility
    +

    Function get_fuzz_range

    • get_fuzz_range(interval, elapsed_days, maximum_interval): {
          max_ivl: number;
          min_ivl: number;
      }

    • Parameters

      • interval: number
      • elapsed_days: number
      • maximum_interval: number

      Returns {
          max_ivl: number;
          min_ivl: number;
      }

      • max_ivl: number
      • min_ivl: number

    Settings

    Member Visibility
    diff --git a/functions/show_diff_message.html b/functions/show_diff_message.html index ae8bff7..186088e 100644 --- a/functions/show_diff_message.html +++ b/functions/show_diff_message.html @@ -1,4 +1,4 @@ show_diff_message | TS-FSRS

    Function show_diff_message

    • show_diff_message(due, last_review, unit?, timeUnit?): string

    • Parameters

      • due: DateInput
      • last_review: DateInput
      • Optionalunit: boolean
      • timeUnit: string[] = TIMEUNITFORMAT

      Returns string

    Settings

    Member Visibility
    +

    Function show_diff_message

    • show_diff_message(due, last_review, unit?, timeUnit?): string

    • Parameters

      • due: DateInput
      • last_review: DateInput
      • Optionalunit: boolean
      • timeUnit: string[] = TIMEUNITFORMAT

      Returns string

    Settings

    Member Visibility
    diff --git a/interfaces/Card.html b/interfaces/Card.html index cb5b9ac..772a98d 100644 --- a/interfaces/Card.html +++ b/interfaces/Card.html @@ -1,7 +1,7 @@ Card | TS-FSRS

    Interface Card

    interface Card {
        difficulty: number;
        due: Date;
        elapsed_days: number;
        lapses: number;
        last_review?: Date;
        reps: number;
        scheduled_days: number;
        stability: number;
        state: State;
    }

    Properties

    difficulty +

    Interface Card

    interface Card {
        difficulty: number;
        due: Date;
        elapsed_days: number;
        lapses: number;
        last_review?: Date;
        reps: number;
        scheduled_days: number;
        stability: number;
        state: State;
    }

    Properties

    difficulty due elapsed_days lapses @@ -10,4 +10,4 @@ scheduled_days stability state -

    Properties

    difficulty

    difficulty: number

    due

    due: Date

    elapsed_days

    elapsed_days: number

    lapses

    lapses: number

    Optionallast_review

    last_review?: Date

    reps

    reps: number

    scheduled_days

    scheduled_days: number

    stability

    stability: number

    state

    state: State

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    difficulty

    difficulty: number

    due

    due: Date

    elapsed_days

    elapsed_days: number

    lapses

    lapses: number

    Optionallast_review

    last_review?: Date

    reps

    reps: number

    scheduled_days

    scheduled_days: number

    stability

    stability: number

    state

    state: State

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/CardInput.html b/interfaces/CardInput.html index 33aa674..2ef9bf4 100644 --- a/interfaces/CardInput.html +++ b/interfaces/CardInput.html @@ -1,7 +1,7 @@ CardInput | TS-FSRS

    Interface CardInput

    interface CardInput {
        difficulty: number;
        due: DateInput;
        elapsed_days: number;
        lapses: number;
        last_review?: null | DateInput;
        reps: number;
        scheduled_days: number;
        stability: number;
        state: StateType | State;
    }

    Hierarchy

    • Omit<Card, "state" | "due" | "last_review">
      • CardInput

    Properties

    difficulty +

    Interface CardInput

    interface CardInput {
        difficulty: number;
        due: DateInput;
        elapsed_days: number;
        lapses: number;
        last_review?: null | DateInput;
        reps: number;
        scheduled_days: number;
        stability: number;
        state: StateType | State;
    }

    Hierarchy

    • Omit<Card, "state" | "due" | "last_review">
      • CardInput

    Properties

    difficulty due elapsed_days lapses @@ -10,4 +10,4 @@ scheduled_days stability state -

    Properties

    difficulty

    difficulty: number

    due

    due: DateInput

    elapsed_days

    elapsed_days: number

    lapses

    lapses: number

    Optionallast_review

    last_review?: null | DateInput

    reps

    reps: number

    scheduled_days

    scheduled_days: number

    stability

    stability: number

    state

    state: StateType | State

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    difficulty

    difficulty: number

    due

    due: DateInput

    elapsed_days

    elapsed_days: number

    lapses

    lapses: number

    Optionallast_review

    last_review?: null | DateInput

    reps

    reps: number

    scheduled_days

    scheduled_days: number

    stability

    stability: number

    state

    state: StateType | State

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/FSRSParameters.html b/interfaces/FSRSParameters.html index 6c31560..7c3e578 100644 --- a/interfaces/FSRSParameters.html +++ b/interfaces/FSRSParameters.html @@ -1,9 +1,9 @@ FSRSParameters | TS-FSRS

    Interface FSRSParameters

    interface FSRSParameters {
        enable_fuzz: boolean;
        enable_short_term: boolean;
        maximum_interval: number;
        request_retention: number;
        w: number[];
    }

    Properties

    enable_fuzz +

    Interface FSRSParameters

    interface FSRSParameters {
        enable_fuzz: boolean;
        enable_short_term: boolean;
        maximum_interval: number;
        request_retention: number;
        w: number[];
    }

    Properties

    enable_fuzz enable_short_term maximum_interval request_retention w -

    Properties

    enable_fuzz

    enable_fuzz: boolean

    enable_short_term

    enable_short_term: boolean

    maximum_interval

    maximum_interval: number

    request_retention

    request_retention: number

    w

    w: number[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    enable_fuzz

    enable_fuzz: boolean

    enable_short_term

    enable_short_term: boolean

    maximum_interval

    maximum_interval: number

    request_retention

    request_retention: number

    w

    w: number[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/IPreview.html b/interfaces/IPreview.html index 933b0fe..d9a607b 100644 --- a/interfaces/IPreview.html +++ b/interfaces/IPreview.html @@ -1,9 +1,9 @@ IPreview | TS-FSRS

    Interface IPreview

    interface IPreview {
        1: RecordLogItem;
        2: RecordLogItem;
        3: RecordLogItem;
        4: RecordLogItem;
        [iterator](): IterableIterator<RecordLogItem>;
    }

    Hierarchy (view full)

    Properties

    1 +

    Interface IPreview

    interface IPreview {
        1: RecordLogItem;
        2: RecordLogItem;
        3: RecordLogItem;
        4: RecordLogItem;
        [iterator](): IterableIterator<RecordLogItem>;
    }

    Hierarchy (view full)

    Properties

    1 2 3 4

    Methods

    [iterator] -

    Properties

    1

    1: RecordLogItem

    2

    2: RecordLogItem

    3

    3: RecordLogItem

    4

    4: RecordLogItem

    Methods

    [iterator]

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Properties

    1

    1: RecordLogItem

    2

    2: RecordLogItem

    3

    3: RecordLogItem

    4

    4: RecordLogItem

    Methods

    [iterator]

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/interfaces/IScheduler.html b/interfaces/IScheduler.html index afb9748..ecea516 100644 --- a/interfaces/IScheduler.html +++ b/interfaces/IScheduler.html @@ -1,6 +1,6 @@ IScheduler | TS-FSRS

    Interface IScheduler

    interface IScheduler {
        preview(): IPreview;
        review(state: Grade): RecordLogItem;
    }

    Methods

    preview +

    Interface IScheduler

    interface IScheduler {
        preview(): IPreview;
        review(state: Grade): RecordLogItem;
    }

    Methods

    preview review -

    Methods

    preview

    review

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Methods

    preview

    review

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/interfaces/ReviewLog.html b/interfaces/ReviewLog.html index 637c684..67d2be6 100644 --- a/interfaces/ReviewLog.html +++ b/interfaces/ReviewLog.html @@ -1,7 +1,7 @@ ReviewLog | TS-FSRS

    Interface ReviewLog

    interface ReviewLog {
        difficulty: number;
        due: Date;
        elapsed_days: number;
        last_elapsed_days: number;
        rating: Rating;
        review: Date;
        scheduled_days: number;
        stability: number;
        state: State;
    }

    Properties

    difficulty +

    Interface ReviewLog

    interface ReviewLog {
        difficulty: number;
        due: Date;
        elapsed_days: number;
        last_elapsed_days: number;
        rating: Rating;
        review: Date;
        scheduled_days: number;
        stability: number;
        state: State;
    }

    Properties

    difficulty due elapsed_days last_elapsed_days @@ -10,4 +10,4 @@ scheduled_days stability state -

    Properties

    difficulty

    difficulty: number

    due

    due: Date

    elapsed_days

    elapsed_days: number

    last_elapsed_days

    last_elapsed_days: number

    rating

    rating: Rating

    review

    review: Date

    scheduled_days

    scheduled_days: number

    stability

    stability: number

    state

    state: State

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    difficulty

    difficulty: number

    due

    due: Date

    elapsed_days

    elapsed_days: number

    last_elapsed_days

    last_elapsed_days: number

    rating

    rating: Rating

    review

    review: Date

    scheduled_days

    scheduled_days: number

    stability

    stability: number

    state

    state: State

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/ReviewLogInput.html b/interfaces/ReviewLogInput.html index d3c6ae0..613b6d3 100644 --- a/interfaces/ReviewLogInput.html +++ b/interfaces/ReviewLogInput.html @@ -1,7 +1,7 @@ ReviewLogInput | TS-FSRS

    Interface ReviewLogInput

    interface ReviewLogInput {
        difficulty: number;
        due: DateInput;
        elapsed_days: number;
        last_elapsed_days: number;
        rating: RatingType | Rating;
        review: DateInput;
        scheduled_days: number;
        stability: number;
        state: StateType | State;
    }

    Hierarchy

    • Omit<ReviewLog,
          | "rating"
          | "state"
          | "due"
          | "review">
      • ReviewLogInput

    Properties

    difficulty +

    Interface ReviewLogInput

    interface ReviewLogInput {
        difficulty: number;
        due: DateInput;
        elapsed_days: number;
        last_elapsed_days: number;
        rating: RatingType | Rating;
        review: DateInput;
        scheduled_days: number;
        stability: number;
        state: StateType | State;
    }

    Hierarchy

    • Omit<ReviewLog,
          | "rating"
          | "state"
          | "due"
          | "review">
      • ReviewLogInput

    Properties

    difficulty due elapsed_days last_elapsed_days @@ -10,4 +10,4 @@ scheduled_days stability state -

    Properties

    difficulty

    difficulty: number

    due

    due: DateInput

    elapsed_days

    elapsed_days: number

    last_elapsed_days

    last_elapsed_days: number

    rating

    rating: RatingType | Rating

    review

    review: DateInput

    scheduled_days

    scheduled_days: number

    stability

    stability: number

    state

    state: StateType | State

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    difficulty

    difficulty: number

    due

    due: DateInput

    elapsed_days

    elapsed_days: number

    last_elapsed_days

    last_elapsed_days: number

    rating

    rating: RatingType | Rating

    review

    review: DateInput

    scheduled_days

    scheduled_days: number

    stability

    stability: number

    state

    state: StateType | State

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/modules.html b/modules.html index 626f3ce..fd6ca37 100644 --- a/modules.html +++ b/modules.html @@ -15,9 +15,11 @@ ReviewLogInput

    Type Aliases

    DateInput Grade +IReschedule RatingType RecordLog RecordLogItem +RescheduleOptions StateType double int diff --git a/types/DateInput.html b/types/DateInput.html index c4a0126..ee223be 100644 --- a/types/DateInput.html +++ b/types/DateInput.html @@ -1,4 +1,4 @@ DateInput | TS-FSRS

    Type Alias DateInput

    DateInput: Date | number | string

    Settings

    Member Visibility
    +

    Type Alias DateInput

    DateInput: Date | number | string

    Settings

    Member Visibility
    diff --git a/types/Grade.html b/types/Grade.html index e01862f..f9a610b 100644 --- a/types/Grade.html +++ b/types/Grade.html @@ -1,4 +1,4 @@ Grade | TS-FSRS

    Type Alias Grade

    Grade: ExcludeManual<Rating>

    Settings

    Member Visibility
    +

    Type Alias Grade

    Grade: ExcludeManual<Rating>

    Settings

    Member Visibility
    diff --git a/types/IReschedule.html b/types/IReschedule.html new file mode 100644 index 0000000..ba5b278 --- /dev/null +++ b/types/IReschedule.html @@ -0,0 +1,4 @@ +IReschedule | TS-FSRS

    Type Alias IReschedule<T>

    IReschedule<T>: {
        collections: T[];
        reschedule_item: T | null;
    }

    Type Parameters

    Settings

    Member Visibility
    diff --git a/types/RatingType.html b/types/RatingType.html index ccbaf24..5eb07b9 100644 --- a/types/RatingType.html +++ b/types/RatingType.html @@ -1,4 +1,4 @@ RatingType | TS-FSRS

    Type Alias RatingType

    RatingType:
        | "Manual"
        | "Again"
        | "Hard"
        | "Good"
        | "Easy"

    Settings

    Member Visibility
    +

    Type Alias RatingType

    RatingType:
        | "Manual"
        | "Again"
        | "Hard"
        | "Good"
        | "Easy"

    Settings

    Member Visibility
    diff --git a/types/RecordLog.html b/types/RecordLog.html index 23a3b95..a3e5270 100644 --- a/types/RecordLog.html +++ b/types/RecordLog.html @@ -1,4 +1,4 @@ RecordLog | TS-FSRS

    Type Alias RecordLog

    RecordLog: {
        [key in Grade]: RecordLogItem
    }

    Settings

    Member Visibility
    +

    Type Alias RecordLog

    RecordLog: {
        [key in Grade]: RecordLogItem
    }

    Settings

    Member Visibility
    diff --git a/types/RecordLogItem.html b/types/RecordLogItem.html index d2ceada..a1d0608 100644 --- a/types/RecordLogItem.html +++ b/types/RecordLogItem.html @@ -1,4 +1,4 @@ RecordLogItem | TS-FSRS

    Type Alias RecordLogItem

    RecordLogItem: {
        card: Card;
        log: ReviewLog;
    }

    Settings

    Member Visibility
    +

    Type Alias RecordLogItem

    RecordLogItem: {
        card: Card;
        log: ReviewLog;
    }

    Settings

    Member Visibility
    diff --git a/types/RescheduleOptions.html b/types/RescheduleOptions.html new file mode 100644 index 0000000..f813a94 --- /dev/null +++ b/types/RescheduleOptions.html @@ -0,0 +1,17 @@ +RescheduleOptions | TS-FSRS

    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

          • 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: boolean

      Indicating whether to skip manual steps.

      +
    • update_memory_state: boolean

      Indicating whether to update the FSRS memory state.

      +

    Settings

    Member Visibility
    diff --git a/types/StateType.html b/types/StateType.html index 248c88a..7693a41 100644 --- a/types/StateType.html +++ b/types/StateType.html @@ -1,4 +1,4 @@ StateType | TS-FSRS

    Type Alias StateType

    StateType:
        | "New"
        | "Learning"
        | "Review"
        | "Relearning"

    Settings

    Member Visibility
    +

    Type Alias StateType

    StateType:
        | "New"
        | "Learning"
        | "Review"
        | "Relearning"

    Settings

    Member Visibility
    diff --git a/types/double.html b/types/double.html index 73ee629..673af88 100644 --- a/types/double.html +++ b/types/double.html @@ -1,4 +1,4 @@ double | TS-FSRS

    Type Alias double

    double: number & {
        __double__: void;
    }

    Settings

    Member Visibility
    +

    Type Alias double

    double: number & {
        __double__: void;
    }

    Settings

    Member Visibility
    diff --git a/types/int.html b/types/int.html index 9178bb4..d9cf97a 100644 --- a/types/int.html +++ b/types/int.html @@ -1,4 +1,4 @@ int | TS-FSRS

    Type Alias int

    int: number & {
        __int__: void;
    }

    Settings

    Member Visibility
    +

    Type Alias int

    int: number & {
        __int__: void;
    }

    Settings

    Member Visibility
    diff --git a/types/unit.html b/types/unit.html index d581cd6..879b080 100644 --- a/types/unit.html +++ b/types/unit.html @@ -1,4 +1,4 @@ unit | TS-FSRS

    Type Alias unit

    unit: "days" | "minutes"

    Settings

    Member Visibility
    +

    Type Alias unit

    unit: "days" | "minutes"

    Settings

    Member Visibility
    diff --git a/variables/DECAY.html b/variables/DECAY.html index a886467..cb37656 100644 --- a/variables/DECAY.html +++ b/variables/DECAY.html @@ -4,4 +4,4 @@

    Variable DECAYConst

    DECAY: number = -0.5

    Default

    DECAY = -0.5
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/FACTOR.html b/variables/FACTOR.html index d2f1e1e..4436c95 100644 --- a/variables/FACTOR.html +++ b/variables/FACTOR.html @@ -6,4 +6,4 @@

    Default

    FACTOR = 19 / 81
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/FSRSVersion.html b/variables/FSRSVersion.html index 25dae35..c49784f 100644 --- a/variables/FSRSVersion.html +++ b/variables/FSRSVersion.html @@ -1,4 +1,4 @@ FSRSVersion | TS-FSRS

    Variable FSRSVersionConst

    FSRSVersion: string = 'v4.3.1 using FSRS V5.0'

    Settings

    Member Visibility
    +

    Variable FSRSVersionConst

    FSRSVersion: string = 'v4.4.0 using FSRS V5.0'

    Settings

    Member Visibility
    diff --git a/variables/Grades.html b/variables/Grades.html index 6c19baa..8d642fd 100644 --- a/variables/Grades.html +++ b/variables/Grades.html @@ -1,4 +1,4 @@ Grades | TS-FSRS

    Variable GradesConst

    Grades: Readonly<Grade[]> = ...

    Settings

    Member Visibility
    +

    Variable GradesConst

    Grades: Readonly<Grade[]> = ...

    Settings

    Member Visibility
    diff --git a/variables/default_enable_fuzz.html b/variables/default_enable_fuzz.html index 06d1f6d..3c408b7 100644 --- a/variables/default_enable_fuzz.html +++ b/variables/default_enable_fuzz.html @@ -1,4 +1,4 @@ default_enable_fuzz | TS-FSRS

    Variable default_enable_fuzzConst

    default_enable_fuzz: false = false

    Settings

    Member Visibility
    +

    Variable default_enable_fuzzConst

    default_enable_fuzz: false = false

    Settings

    Member Visibility
    diff --git a/variables/default_enable_short_term.html b/variables/default_enable_short_term.html index 2a68b17..c10b264 100644 --- a/variables/default_enable_short_term.html +++ b/variables/default_enable_short_term.html @@ -1,4 +1,4 @@ default_enable_short_term | TS-FSRS

    Variable default_enable_short_termConst

    default_enable_short_term: true = true

    Settings

    Member Visibility
    +

    Variable default_enable_short_termConst

    default_enable_short_term: true = true

    Settings

    Member Visibility
    diff --git a/variables/default_maximum_interval.html b/variables/default_maximum_interval.html index 4468d98..45303f6 100644 --- a/variables/default_maximum_interval.html +++ b/variables/default_maximum_interval.html @@ -1,4 +1,4 @@ default_maximum_interval | TS-FSRS

    Variable default_maximum_intervalConst

    default_maximum_interval: 36500 = 36500

    Settings

    Member Visibility
    +

    Variable default_maximum_intervalConst

    default_maximum_interval: 36500 = 36500

    Settings

    Member Visibility
    diff --git a/variables/default_request_retention.html b/variables/default_request_retention.html index dec9913..30bf5bc 100644 --- a/variables/default_request_retention.html +++ b/variables/default_request_retention.html @@ -1,4 +1,4 @@ default_request_retention | TS-FSRS

    Variable default_request_retentionConst

    default_request_retention: 0.9 = 0.9

    Settings

    Member Visibility
    +

    Variable default_request_retentionConst

    default_request_retention: 0.9 = 0.9

    Settings

    Member Visibility
    diff --git a/variables/default_w.html b/variables/default_w.html index b047c23..642f288 100644 --- a/variables/default_w.html +++ b/variables/default_w.html @@ -1,4 +1,4 @@ default_w | TS-FSRS

    Variable default_wConst

    default_w: number[] = ...

    Settings

    Member Visibility
    +

    Variable default_wConst

    default_w: number[] = ...

    Settings

    Member Visibility