@types/readme-filename
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

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.

/**
 * 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 19:02:21 GMT
  • Dependencies: none

Credits

These definitions were written by .

/@types/readme-filename/

    Package Sidebar

    Install

    npm i @types/readme-filename

    Weekly Downloads

    0

    Version

    1.0.3

    License

    MIT

    Unpacked Size

    2.94 kB

    Total Files

    5

    Last publish

    Collaborators

    • types