documentation.federated.com.../node_modules/path-type
2023-05-30 11:55:11 -06:00
..
index.d.ts initial 2023-05-30 11:55:11 -06:00
index.js initial 2023-05-30 11:55:11 -06:00
license initial 2023-05-30 11:55:11 -06:00
package.json initial 2023-05-30 11:55:11 -06:00
readme.md initial 2023-05-30 11:55:11 -06:00

path-type Build Status

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

Install

$ npm install path-type

Usage

const {isFile} = require('path-type');

(async () => {
	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.

License

MIT © Sindre Sorhus