alex/filter.d.ts

Catch insensitive, inconsiderate writing

export function filter(
  this: import('unified').Processor<void, import('mdast').Root, void, void>,
  settings_0?: Options | undefined
):
  | void
  | import('unified').Transformer<import('mdast').Root, import('mdast').Root>
export type Root = import('mdast').Root
/**
 * Configuration.
 */
export type Options = {
  /**
   * The `deny` field should be an array of rules or `undefined` (the default is
   * `undefined`).
   * When provided, *only* the rules specified are reported.
   * You cannot use both `allow` and `deny` at the same time.
   */
  deny?: string[] | undefined
  /**
   * The `allow` field should be an array of rules or `undefined` (the default
   * is `undefined`).
   * When provided, the rules specified are skipped and not reported.
   * You cannot use both `allow` and `deny` at the same time.
   */
  allow?: string[] | undefined
}