Skip to content

Repository files navigation

path-type

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

Tip

You may not need this package. Node.js provides the same functionality natively via fs.stat (e.g., (await stat(path)).isFile()).

Install

npm install path-type

Usage

import{isFile}from'path-type';console.log(awaitisFile('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.

About

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

Resources

Code of conduct

Contributing

Security policy

Stars

80 stars

Watchers

5 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages