Logo for jsDocs.io

path-exists

  • Version 5.0.0
  • Published
  • 4.12 kB
  • No dependencies
  • MIT license

Install

npm i path-exists
yarn add path-exists
pnpm add path-exists

Overview

Check if a path exists

Index

Functions

Functions

function pathExists

pathExists: (path: string) => Promise<boolean>;

  • Check if a path exists.

    Returns

    Whether the path exists.

    Example 1

    // foo.ts
    import {pathExists} from 'path-exists';
    

    console.log(await pathExists('foo.ts'));
    //=> true

function pathExistsSync

pathExistsSync: (path: string) => boolean;

  • Synchronously check if a path exists.

    Returns

    Whether the path exists.

    Example 1

    // foo.ts
    import {pathExistsSync} from 'path-exists';
    

    console.log(pathExistsSync('foo.ts'));
    //=> true

Package Files (1)

Dependencies (0)

No dependencies.

Dev Dependencies (3)

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/path-exists.

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