# is-hidden-file

> Check if a file/folder is hidden on node js that works on any platform.

Latest version **1.1.2** (published 2021-06-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install is-hidden-file
pnpm add is-hidden-file
yarn add is-hidden-file
bun add is-hidden-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.2 |
| Published | 2021-06-22 |
| First published | 2021-06-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 6 |
| Author | Justin Maximillian Kimlim |
| Maintainers | kimlimjustin |
| Keywords | file, is, hidden, dot, is-hidden, windows, linux |

## Links

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

## Dependencies (1)

- [cross-spawn](https://npm.io/package/cross-spawn.md) ^7.0.3

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 1.1.2 (latest) — 2021-06-22
- 1.1.1 — 2021-06-12
- 1.1.0 — 2021-06-08
- 1.0.1 — 2021-06-07
- 1.0.0 — 2021-06-07

## README

<div align="center">

# is-hidden-file
[![npm version](https://img.shields.io/badge/dynamic/json?color=317EFB&logo=npm&style=for-the-badge&label=Version&query=version&url=https%3A%2F%2Funpkg.com%2Fis-hidden-file%40latest%2Fpackage.json)](https://www.npmjs.com/package/is-hidden-file)
</div>

> Check if a file/folder is hidden on all platforms.

- Unix: Check file name starts with `.`.
- Windows: Check if file hidden using native code.

## Installation
- npm: `npm i is-hidden-file`
- yarn: `yarn add is-hidden-file`

## Usage
#### Node js
```js
const { isHiddenFile } = require("is-hidden-file");

console.log(isHiddenFile(".git")) // true
console.log(isHiddenFile("README.md")) // false
```

#### Node js with typescript
```ts
import { isHiddenFile } from "is-hidden-file";

console.log(isHiddenFile(".git")) // true
console.log(isHiddenFile("README.md")) // false
```

## License
MIT

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