Interface RulesetProvider

Hierarchy

RulesetProvider

Index

Properties

Methods

downloadRuleset listRulesets

Properties

format

format: RulesetFormat

Ruleset data format

Methods

downloadRuleset

downloadRuleset(id: string, cacheKey?: string): Promise<RulesetContent | "not-modified">
Downloads rule set if cacheKey is valid.
Parameters
- id: string
  
  The id of the Ruleset to download.
- Optional cacheKey: string
  
  A key that determines whether or not to download Ruleset.
Returns Promise<RulesetContent | "not-modified">
- Defined in src/ruleset-provider.ts:44

listRulesets

listRulesets(): Promise<RulesetMetaData[]>
Lists all available Rulesets

Returns Promise<RulesetMetaData[]>
- Defined in src/ruleset-provider.ts:37

Generated using TypeDoc