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.

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 5.0.0
    3,833,535
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 5.0.0
    3,833,535
  • 4.0.0
    35,532,163
  • 3.0.0
    9,426,496
  • 2.0.0
    2,484,429
  • 1.1.0
    4,960,684
  • 1.0.0
    811

Package Sidebar

Install

npm i path-type

Weekly Downloads

56,238,118

Version

5.0.0

License

MIT

Unpacked Size

5.64 kB

Total Files

5

Last publish

Collaborators

  • sindresorhus