eslint-webpack-plugin/types/getESLint.d.ts

A ESLint plugin for webpack

export type ESLint = import("eslint").ESLint;
export type LintResult = import("eslint").ESLint.LintResult;
export type Options = import("./options").Options;
export type AsyncTask = () => Promise<void>;
export type LintTask = (files: string | string[]) => Promise<LintResult[]>;
export type Linter = {
  threads: number;
  eslint: ESLint;
  lintFiles: LintTask;
  cleanup: AsyncTask;
};
export type Worker = JestWorker & {
  lintFiles: LintTask;
};
/**
 * @param {string | undefined} key a cache key
 * @param {Options} options options
 * @returns {Promise<Linter>} linter
 */
export function getESLint(
  key: string | undefined,
  { threads, ...options }: Options,
): Promise<Linter>;
/** @typedef {import('eslint').ESLint} ESLint */
/** @typedef {import('eslint').ESLint.LintResult} LintResult */
/** @typedef {import('./options').Options} Options */
/** @typedef {() => Promise<void>} AsyncTask */
/** @typedef {(files: string|string[]) => Promise<LintResult[]>} LintTask */
/** @typedef {{threads: number, eslint: ESLint, lintFiles: LintTask, cleanup: AsyncTask}} Linter */
/** @typedef {JestWorker & {lintFiles: LintTask}} Worker */
/**
 * @param {Options} options options
 * @returns {Promise<Linter>} linter
 */
export function loadESLint(options: Options): Promise<Linter>;
/**
 * @param {string | undefined} key a cache key
 * @param {number} poolSize number of workers
 * @param {Options} options options
 * @returns {Promise<Linter>} linter
 */
export function loadESLintThreaded(
  key: string | undefined,
  poolSize: number,
  options: Options,
): Promise<Linter>;
import { Worker as JestWorker } from "jest-worker";