• Version 5.0.4
  • Published
  • 82 kB
  • 2 dependencies
  • Artistic-2.0 license


npm i ignorefs
yarn add ignorefs
pnpm add ignorefs


Ignore common and custom patterns of the file system



function isIgnoredPath

isIgnoredPath: (path: Path, opts?: Options) => boolean;
  • Tests whether the path should be ignored

function isIgnoredPathCompatibility

isIgnoredPathCompatibility: (path: Path | string, opts?: Options) => boolean;
  • Compatibility wrapper for isIgnoredPath, supporting path string, verifying path object and options, and handling option deprecations

function upgradeOptions

upgradeOptions: (opts: Options) => Options;
  • Verify options and upgrade deprecations, returns dereferenced copy


interface Options

interface Options {}
  • Ignore Options

property ignoreAbsolutePaths

ignoreAbsolutePaths?: Array<string | RegExp>;
  • Absolute paths to ignore

property ignoreBasenames

ignoreBasenames?: Array<string | RegExp>;
  • Basenames to ignore

property ignoreCommonPatterns

ignoreCommonPatterns?: boolean;

property ignoreCustomCallback

ignoreCustomCallback?: (path: Path) => boolean | void;
  • Your own ignore handler

property ignoreCustomPatterns

ignoreCustomPatterns?: RegExp;
  • Test against each Path property

property ignoreHiddenBasenames

ignoreHiddenBasenames?: boolean;
  • Ignore basenames that begin with a . character

property ignoreHiddenFiles

ignoreHiddenFiles?: boolean;

property ignorePaths

ignorePaths?: Array<string | RegExp>;

property ignoreRelativePaths

ignoreRelativePaths?: Array<string | RegExp>;
  • Relative paths to ignore

property ignoreUndesiredBasenames

ignoreUndesiredBasenames?: boolean;
  • Ignore commonly undesirable basenames: https://github.com/bevry/ignorepatterns

interface Path

interface Path {}
  • A path to check its ignore status

property absolutePath

absolutePath?: string;
  • The absolute path, if any

property basename

basename?: string;
  • If basename of the path, if any

property relativePath

relativePath?: string;
  • The relative path, if any

Package Files (1)

Dependencies (2)

Dev Dependencies (15)

Peer Dependencies (0)

No peer dependencies.


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
  • HTML
    <a href="https://www.jsdocs.io/package/ignorefs"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>