is-there
v4.5.2
Check if a file or directory exists in a given path.
168.7K/weekUpdated 12 months agoMITUnpacked: 16.4 KB
Published by Ionică Bizău
npm install is-there
is-there
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations]     
> Check if a file or directory exists in a given path.
Why? fs.exists already does the job!
Because fs.exists and fs.existsSync ~~will be~~ are deprecated and in some cases we still need them!
> fs.exists() is an anachronism and exists only for historical reasons. There should almost never be a reason to use it in your own code.
> In particular, checking if a file exists before opening it is an anti-pattern that leaves you vulnerable to race conditions: another process may remove the file between the calls to fs.exists() and fs.open(). Just open the file and handle the error when it's not there.
> fs.exists() will be deprecated.
> (Source, emphasis added)
:cloud: Installation
``shUsing npm
npm install --save is-there
Using yarn
yarn add is-there
`
:clipboard: Example
js
const IsThere = require("is-there");// Sync
console.log(IsThere(
${__dirname}/contents/file))
// => true
console.log(IsThere.directory(${__dirname}/contents/dir))// Callback
IsThere.file(
${__dirname}/contents/not_found, exists => {
console.log(exists)
// => false
})// Promises
IsThere.promises.directory(
${__dirname}/contents/dir).then(exists => {
console.log(exists)
// => true
}).catch(console.error)
`
:question: Get Help
There are few ways to get help:
1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:
:memo: Documentation
$3
Checks if a file or directory exists on given path.
Use without the new keyword.
#### Params
- String
: The path to the file or directory.
- Function callback: The callback function called with a boolean value representing if the file or directory exists. If this parameter is not a
function, the function will run synchronously and return the value.#### Return
- isThere|Boolean The
isThere function if the callback parameter was provided, otherwise a boolean value indicating if the file/directory
exists or not.$3
Checks if the path exists and it is a directory.#### Params
- String
path: The path to the directory.
- Function callback: The callback function called with a boolean value representing if the directory exists. If this parameter is not a
function, the function will run synchronously and return the value.#### Return
- isThere|Boolean The
isThere function if the callback parameter was provided, otherwise a boolean value indicating if the directory exists or not.$3
Check if the path exists and it is a file.#### Params
- String
path: The path to the file.
- Function callback: The callback function called with a boolean value representing if the file exists. If this parameter is not a
function, the function will run synchronously and return the value.#### Return
- isThere|Boolean The
isThere function if the callback parameter was provided, otherwise a boolean value indicating if the file exists or not.$3
The promises interface.It exports the following methods:
-
isThere.promises.exists
-
-
:yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
:sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
- Starring and sharing the projects you like :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
- Bitcoin—You can send me bitcoins at this address (or scanning the code below):
Thanks! :heart:
:dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles: -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- :scroll: License
[MIT][license] © [Ionică Bizău][website]
[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW