# is-writable

> Check if a file or directory is writable.

Latest version **2.0.0** (published 2020-07-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install is-writable
pnpm add is-writable
yarn add is-writable
bun add is-writable
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2020-07-16 |
| First published | 2019-10-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.17 <11 \|\| >=11.14 |
| Dependencies | 0 |
| Unpacked size | 3.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Richie Bendall |
| Maintainers | richienb |
| Keywords | writable, access, filesystem, file, directory, path, filename |

## Links

- npm: https://www.npmjs.com/package/is-writable
- Repository: https://github.com/Richienb/is-writable
- Homepage: https://github.com/Richienb/is-writable#readme
- Issues: https://github.com/Richienb/is-writable/issues
- npm.io page: https://npm.io/package/is-writable

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2020-07-16
- 1.0.1 — 2019-10-21
- 1.0.0 — 2019-10-17
- 0.0.0 — 2019-10-16

## README

# is-writable [![Travis CI Build Status](https://img.shields.io/travis/com/Richienb/is-writable/master.svg?style=for-the-badge)](https://travis-ci.com/Richienb/is-writable)

Check if a file or directory is writable.

[![NPM Badge](https://nodei.co/npm/is-writable.png)](https://npmjs.com/package/is-writable)

## Install

```sh
npm install is-writable
```

## Usage

```js
const isWritable = require("is-writable");

(async () => {
	await isWritable("file.txt")
	//=> true
})()
```

## API

### isWritable(filepath)
### isWritable.sync(filepath)

#### filepath

Type: `string`

The file or directory to check.

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