Skip to main content
function defineRuleFor<TRuleRegistry>(ruleRegistry): <Name>(name, fields, resolve?) => RuleEntry<Name, SanitizedRuleFields<Omit<CpsatRuleConfigEntryFor<Pick<TRuleRegistry, Name>>, "name">>>;
Creates a registry-bound defineRule helper.

​
Type Parameters

​
TRuleRegistry

TRuleRegistry extends CpsatRuleRegistry

​
Parameters

​
ruleRegistry
TRuleRegistry
required

​
Returns

<Name>(name, fields, resolve?) => RuleEntry<Name, SanitizedRuleFields<Omit<CpsatRuleConfigEntryFor<Pick<TRuleRegistry, Name>>, "name">>> Use this when authoring custom rules directly and you want immediate compile-time validation of the rule name and config fields against a specific rule registry.