is-hidden

is-hidden

Tiny package that checks if a basename (.gitignore, example.js) is hidden (starts with a dot).

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • isHidden(basename)
• Types
• Compatibility
• Contribute
• Security
• License

What is this?

Tiny package that checks if a basename is hidden.

When should I use this?

Probably not, you can do check this yourself. I was doing this so many times that I made it a package years ago.

Install

This package is ESM only. In Node.js (version 14.14+, 16.0+), install with npm:

npm install is-hidden

In Deno with esm.sh:

import {isHidden} from 'https://esm.sh/is-hidden@2'

In browsers with esm.sh:

<script type="module">
  import {isHidden} from 'https://esm.sh/is-hidden@2?bundle'
</script>

Use

import {isHidden} from 'is-hidden'

isHidden('.git') // => true
isHidden('readme.md') // => false

API

This package exports the identifier isHidden. There is no default export.

isHidden(basename)

Check if basename is hidden (starts with a dot).

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. It also works in Deno and modern browsers.

Contribute

Yes please! See How to Contribute to Open Source.

Security

This package is safe.

License

MIT © Titus Wormer