Skip to content

Interface: LessonRetirementBuilder ​

Defined in: builders/lesson-retirement-builder.ts:9

Fluent configurator for automatic lesson retirement thresholds ($r in .retireAfter($r => ...)).

Configures immediate retirement on lifetime violation count ceilings or low sliding-window clean-pass rates after a minimum number of injections.

Methods ​

build() ​

ts
build(): LessonRetirementConfig;

Defined in: builders/lesson-retirement-builder.ts:43

Compiles and returns the frozen LessonRetirementConfig.

Freezes the configured violation ceiling and clean-pass rate threshold into a passive AST record.

Returns ​

LessonRetirementConfig

Deeply frozen retirement configuration.


maxViolations() ​

ts
maxViolations(count): LessonRetirementBuilder;

Defined in: builders/lesson-retirement-builder.ts:19

Sets the maximum lifetime violation count $v$ before immediate retirement.

Any lesson whose cumulative violated count reaches count is retired from future recall.

Parameters ​

ParameterTypeDescription
countnumberMaximum allowed lifetime violation count.

Returns ​

LessonRetirementBuilder

New immutable retirement builder.


orMinCleanPassRate() ​

ts
orMinCleanPassRate(minRate, opts): LessonRetirementBuilder;

Defined in: builders/lesson-retirement-builder.ts:31

Sets the minimum sliding-window clean-pass rate threshold after opts.afterInjections injections.

Retires lessons whose clean-pass rate falls below minRate once at least opts.afterInjections have occurred.

Parameters ​

ParameterTypeDescription
minRatenumberMinimum clean-pass rate in $[0, 1]$.
opts{ afterInjections: number; }Warmup injection count before evaluating minRate.
opts.afterInjectionsnumber-

Returns ​

LessonRetirementBuilder

New immutable retirement builder.

Released under the MIT License.