path-type

Check if a path is a file, directory, or symlink

Usage no npm install needed!

<script type="module">
  import pathType from 'https://cdn.skypack.dev/path-type';
</script>

README

path-type

Check if a path is a file, directory, or symlink

Install

$ npm install path-type

Usage

import {isFile} from 'path-type';

console.log(await isFile('package.json'));
//=> true

API

isFile(path)

Check whether the passed path is a file.

Returns a Promise<boolean>.

path

Type: string

The path to check.

isDirectory(path)

Check whether the passed path is a directory.

Returns a Promise<boolean>.

isSymlink(path)

Check whether the passed path is a symlink.

Returns a Promise<boolean>.

isFileSync(path)

Synchronously check whether the passed path is a file.

Returns a boolean.

isDirectorySync(path)

Synchronously check whether the passed path is a directory.

Returns a boolean.

isSymlinkSync(path)

Synchronously check whether the passed path is a symlink.

Returns a boolean.

Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.