assert-file/index.d.ts

assert file utilities

// Type definitions for assert-file
// Project: https://github.com/node-modules/assert-file

type ExpectedType = string | RegExp;

/**
 * Assert file
 *
 * @param {String} file - file path
 * @param {String|RegExp|Array} [pattern] - test pattern
 *
 * @example
 * ```js
 *   assertFile(`${fixtures}/package.json`); // check whether file exists
 *   assertFile(`${fixtures}/README.md`, 'hello'); // check string includes
 *   assertFile(`${fixtures}/README.md`, /hello/); // check with regex
 *   assertFile(`${fixtures}/package.json`, { name: 'rule_file' }); // check json includes
 *   assertFile(`${fixtures}/README.md`, [ 'hello', /world/ ]); // support multiple rule
 * ```
 */
declare function assertFile(file: string, pattern?: ExpectedType | ExpectedType[]): void;

declare namespace assertFile {
  /**
   * The opposite assertion of assert file
   *
   * @param {String} file - file path
   * @param {String|RegExp|Array} [pattern] - test pattern
   *
   * @example
   * ```js
   *   assertFile.ok(`${fixtures}/package.json`);
   *   assertFile.ok(`${fixtures}/package.json`, { name: 'example' });
   *   assertFile.ok(`${fixtures}/README`, /x = y/);
   *   assertFile.ok(`${fixtures}/README`, [ 'abc', /\d+/ ]);
   * ```
   */
  export function ok(file: string, pattern?: ExpectedType | ExpectedType[]): void;

  /**
   * The opposite assertion of assert file
   *
   * @param {String} file - file path
   * @param {String|RegExp|Array} [pattern] - test pattern
   *
   * @example
   * ```js
   *   assertFile.fail(`${fixtures}/package.json`);
   *   assertFile.fail(`${fixtures}/package.json`, { name: 'example' });
   *   assertFile.fail(`${fixtures}/README`, /x = y/);
   *   assertFile.fail(`${fixtures}/README`, [ 'abc', /\d+/ ]);
   * ```
   */
  export function fail(file: string, pattern?: ExpectedType | ExpectedType[]): void;
} 

export = assertFile;