@adguard/agtree
Version:
Tool set for working with adblock filter lists
24 lines (23 loc) • 1.06 kB
TypeScript
/**
* @file Comment rule converter
*/
import { type AnyCommentRule } from '../../nodes/index.js';
import { RuleConverterBase } from '../base-interfaces/rule-converter-base.js';
import { type NodeConversionResult } from '../base-interfaces/conversion-result.js';
/**
* Comment rule converter class
*
* @todo Implement `convertToUbo` and `convertToAbp`
*/
export declare class CommentRuleConverter extends RuleConverterBase {
/**
* Converts a comment rule to AdGuard format, if possible.
*
* @param rule Rule node to convert
* @returns An object which follows the {@link NodeConversionResult} interface. Its `result` property contains
* the array of converted rule nodes, and its `isConverted` flag indicates whether the original rule was converted.
* If the rule was not converted, the result array will contain the original node with the same object reference
* @throws If the rule is invalid or cannot be converted
*/
static convertToAdg(rule: AnyCommentRule): NodeConversionResult<AnyCommentRule>;
}