@adguard/agtree/dist/types/parser/options.d.ts

Tool set for working with adblock filter lists

/**
 * @file Common options for all parsers.
 */
/**
 * Callback function type for handling parse errors in tolerant mode.
 *
 * @param error The error that occurred during parsing
 */
export type OnParseError = (error: unknown) => void;
/**
 * Common options for all parsers.
 */
export interface ParserOptions {
    /**
     * If `true`, then the parser will not throw an error if the rule is syntactically invalid, instead it will
     * return an `InvalidRule` object with the error attached to it.
     */
    tolerant?: boolean;
    /**
     * Whether to include location information in the AST nodes.
     */
    isLocIncluded?: boolean;
    /**
     * Whether to parse AdBlock-specific rules.
     */
    parseAbpSpecificRules?: boolean;
    /**
     * Whether to parse uBlock Origin-specific rules.
     */
    parseUboSpecificRules?: boolean;
    /**
     * Whether to parse raw parts.
     */
    includeRaws?: boolean;
    /**
     * Whether to ignore comment-rules.
     */
    ignoreComments?: boolean;
    /**
     * Whether to parse host rules.
     */
    parseHostRules?: boolean;
    /**
     * Callback function to handle parse errors when tolerant mode is enabled.
     */
    onParseError?: OnParseError;
}
/**
 * Default parser options.
 */
export declare const defaultParserOptions: ParserOptions;