ReporterValidationErrors.d.ts 1.1 KB

12345678910111213141516171819
  1. /**
  2. * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
  3. *
  4. * This source code is licensed under the MIT license found in the
  5. * LICENSE file in the root directory of this source tree.
  6. */
  7. import type { Config } from '@jest/types';
  8. import { ValidationError } from 'jest-validate';
  9. /**
  10. * Reporter Validation Error is thrown if the given arguments
  11. * within the reporter are not valid.
  12. *
  13. * This is a highly specific reporter error and in the future will be
  14. * merged with jest-validate. Till then, we can make use of it. It works
  15. * and that's what counts most at this time.
  16. */
  17. export declare function createReporterError(reporterIndex: number, reporterValue: Array<Config.ReporterConfig> | string): ValidationError;
  18. export declare function createArrayReporterError(arrayReporter: Config.ReporterConfig, reporterIndex: number, valueIndex: number, value: string | Record<string, unknown>, expectedType: string, valueName: string): ValidationError;
  19. export declare function validateReporters(reporterConfig: Array<Config.ReporterConfig | string>): boolean;