Logo for jsDocs.io

closest-file-data

  • Version 0.1.4
  • Published
  • 225 kB
  • No dependencies
  • MIT license

Install

npm i closest-file-data
yarn add closest-file-data
pnpm add closest-file-data

Overview

Allow to find and retrieve some data (such as config file) related to a given path (with cache)

Index

Variables

Functions

Interfaces

Variables

variable _default

const _default: ((
    relPath: string,
    oneOrMoreReader: IDataReader<any> | IDataReader<any>[]
) => void | IClosestDataResult) & { cache: { clear: () => any } };

    Functions

    function closestFileData

    closestFileData: (
        relPath: string,
        oneOrMoreReader: IDataReader | IDataReader[]
    ) => IClosestDataResult | void;

      Interfaces

      interface IClosestDataResult

      interface IClosestDataResult {}

        property data

        readonly data: any;

          property path

          readonly path: string;

            interface IDataReader

            interface IDataReader<T = any> {}

              property basename

              basename: string;

                property read

                read: (file: string) => T | void;

                  Package Files (1)

                  Dependencies (0)

                  No dependencies.

                  Dev Dependencies (8)

                  Peer Dependencies (0)

                  No peer dependencies.

                  Badge

                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/closest-file-data.

                  • Markdown
                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/closest-file-data)
                  • HTML
                    <a href="https://www.jsdocs.io/package/closest-file-data"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>