codeql-action/node_modules/path-type
github-actions[bot] 0da815296a Update checked-in dependencies 2022-02-24 17:03:29 +00:00
..
index.d.ts replace jest with ava 2020-05-13 11:13:27 +01:00
index.js replace jest with ava 2020-05-13 11:13:27 +01:00
license replace jest with ava 2020-05-13 11:13:27 +01:00
package.json Update checked-in dependencies 2022-02-24 17:03:29 +00:00
readme.md replace jest with ava 2020-05-13 11:13:27 +01:00

readme.md

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