# is-regular-file

> Checks if a given path is a regular file

Latest version **1.1.1** (published 2018-01-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install is-regular-file
pnpm add is-regular-file
yarn add is-regular-file
bun add is-regular-file
```

## 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 | 1.1.1 |
| Published | 2018-01-15 |
| First published | 2016-05-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | André Cruz |
| Maintainers | satazor |
| Keywords | file, regular, path |

## Links

- npm: https://www.npmjs.com/package/is-regular-file
- Repository: https://github.com/moxystudio/node-is-regular-file
- Issues: https://github.com/moxystudio/node-is-regular-file/issues
- npm.io page: https://npm.io/package/is-regular-file

## 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

- 1.1.1 (latest) — 2018-01-15
- 1.1.0 — 2017-08-31
- 1.0.1 — 2016-05-13
- 1.0.0 — 2016-05-13

## README

# is-regular-file

[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-dm-dev-image]][david-dm-dev-url] [![Greenkeeper badge][greenkeeper-image]][greenkeeper-url]

[npm-url]:https://npmjs.org/package/is-regular-file
[downloads-image]:http://img.shields.io/npm/dm/is-regular-file.svg
[npm-image]:http://img.shields.io/npm/v/is-regular-file.svg
[travis-url]:https://travis-ci.org/moxystudio/node-is-regular-file
[travis-image]:http://img.shields.io/travis/moxystudio/node-is-regular-file/master.svg
[codecov-url]:https://codecov.io/gh/moxystudio/node-is-regular-file
[codecov-image]:https://img.shields.io/codecov/c/github/moxystudio/node-is-regular-file/master.svg
[david-dm-url]:https://david-dm.org/moxystudio/node-is-regular-file
[david-dm-image]:https://img.shields.io/david/moxystudio/node-is-regular-file.svg
[david-dm-dev-url]:https://david-dm.org/moxystudio/node-is-regular-file?type=dev
[david-dm-dev-image]:https://img.shields.io/david/dev/moxystudio/node-is-regular-file.svg
[greenkeeper-image]:https://badges.greenkeeper.io/moxystudio/node-is-regular-file.svg
[greenkeeper-url]:https://greenkeeper.io/

Checks if a path is a regular file.


## Installation

`$ npm install is-regular-file`


## Usage

```js
const isRegularFile = require('is-regular-file');

isRegularFile('path/to/file')
.then((is) => console.log('Is regular file:', is));
```

or if you prefer sync:

```js
const isRegularFileSync = require('is-regular-file').sync;

console.log('Is regular file:', isRegularFileSync('path/to/file'));
```

## Tests

`$ npm test`   
`$ npm test-cov` to get coverage report


## License

Released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).

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