diff options
Diffstat (limited to 'node_modules/path-type/readme.md')
| -rw-r--r-- | node_modules/path-type/readme.md | 72 |
1 files changed, 0 insertions, 72 deletions
diff --git a/node_modules/path-type/readme.md b/node_modules/path-type/readme.md deleted file mode 100644 index 4c972fa..0000000 --- a/node_modules/path-type/readme.md +++ /dev/null @@ -1,72 +0,0 @@ -# path-type [](https://travis-ci.org/sindresorhus/path-type) - -> Check if a path is a file, directory, or symlink - - -## Install - -``` -$ npm install path-type -``` - - -## Usage - -```js -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](https://sindresorhus.com) |