@types/readme-filename

Installation

npm install --save @types/readme-filename

Summary

This package contains type definitions for readme-filename (https://github.com/ngryman/readme-filename#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/readme-filename.

index.d.ts

/**
 * Determines the path to a `README` file.
 *
 * @param root
 * The directory to look for a `README` file.
 *
 * @returns
 * The path to the `README` file.
 */
declare function readmeFilename(root?: string): Promise<string>;

export = readmeFilename;

Additional Details

• Last updated: Mon, 05 May 2025 1921 GMT
• Dependencies: none

Credits

These definitions were written by .