ignorefs

  • Version 3.17.0
  • Published
  • 31.6 kB
  • 1 dependency
  • MIT license

Install

npm i ignorefs
yarn add ignorefs
pnpm add ignorefs

Overview

Ignore common and custom patterns of the file system

Index

Functions

function isIgnoredPath

isIgnoredPath: (path: string, opts?: IgnoreOpts) => any;
  • Is Ignored Path Check to see if a path, either a full path or basename, should be ignored

    Parameter path

    A full path or basename of a file or directory

    Parameter opts

    Configurations options

    Returns

    Whether or not the path should be ignored

Package Files (1)

Dependencies (1)

Dev Dependencies (16)

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/ignorefs.

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