# @fujia/check-path

> Check if a path exists.

Latest version **1.2.0** (published 2021-12-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @fujia/check-path
pnpm add @fujia/check-path
yarn add @fujia/check-path
bun add @fujia/check-path
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2021-12-25 |
| First published | 2021-12-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=14.0.0 |
| Dependencies | 0 |
| Unpacked size | 9.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | fujia |
| Maintainers | sunnyfu |
| Keywords | path, access, filePath, exist, file, fs |

## Links

- npm: https://www.npmjs.com/package/@fujia/check-path
- Repository: https://github.com/fujia-dev/check-path
- Homepage: https://github.com/fujia-dev/check-path#readme
- Issues: https://github.com/fujia-dev/check-path/issues
- npm.io page: https://npm.io/package/@fujia/check-path

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.2.0 (latest) — 2021-12-25
- 1.1.1 — 2021-12-25
- 1.1.0 — 2021-12-06
- 1.0.1 — 2021-12-06
- 1.0.0 — 2021-12-06

## README

<div align="center">
  <img alt="hammer logo" width="200" src="./assets/Paths.svg"/>
</div>

<div align="center">
  <h1>@fujia/check-path</h1>
</div>

<div align="center">

Check if a path exists.

</div>

<div align="center">

English | [简体中文](./README.zh-CN.md)

</div>


## Installation

```bash
npm i @fujia/check-path

# or use yarn
yarn add @fujia/check-path
```

## Usage

```javascript
import { pathExist, pathExistSync } from '@fujia/check-path'

console.log(await pathExist('example.js')); // Returns true if exist, otherwise return false

console.log(pathExistSync('example.js')); // Returns true if exist, otherwise return false

```

## API

### pathExists(path)

Returns a Promise<boolean>.

### pathExistsSync(path)

Returns a boolean.

---
_Source: https://npm.io/package/@fujia/check-path · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._