Neolithic Programming Machine
Wondering what’s next for npm?Check out our public roadmap! »

path-type
TypeScript icon, indicating that this package has built-in type declarations

5.0.0 • Public • Published

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.

Install

npm i path-type

DownloadsWeekly Downloads

42,265,660

Version

5.0.0

License

MIT

Unpacked Size

5.64 kB

Total Files

5

Last publish

Collaborators

  • avatar