test-filesystem 1.1.2 → 1.3.0

package/README.md

@@ -6,6 +6,11 @@ There are three options for accessing these functions:
 2. ES6 modules: dist/*.mjs
 3. Bundles Browser file: browser/test-fs.js
 
+## Installation
+
+In your project's root directory, run: `npm install --save-dev test-filesystem`
+(or `yarn add --dev test-filesystem` if you use Yarn).
+
 ## Usage
 To use the temporary directory in tests. Do the following in your tests:
 ```js
@@ -58,6 +63,7 @@ An assortment of objects that can be used in tests and some functions to help de
     * [.exports.createTempDir()](#module_test-fs.exports.createTempDir) ⇒ <code>Promise.&lt;(\*\|void)&gt;</code>
     * [.removeDirectory(dirPath)](#module_test-fs.removeDirectory) ⇒ <code>Promise.&lt;\*&gt;</code>
     * [.logObject(object, [label], [outputType])](#module_test-fs.logObject) ⇒ <code>string</code> \| <code>undefined</code>
+    * [.fileExists(filePath)](#module_test-fs.fileExists) ⇒ <code>boolean</code>
     * [.countMatches(content, search)](#module_test-fs.countMatches) ⇒ <code>number</code>
 
 <a name="module_test-fs.nodeTree"></a>
@@ -149,6 +155,17 @@ Log out an object in a nicely formatted way.
 | [label] | <code>string</code> | <code>&quot;logging&quot;</code> | 
 | [outputType] | <code>string</code> | <code>&quot;log&quot;</code> | 
 
+<a name="module_test-fs.fileExists"></a>
+
+### test-fs.fileExists(filePath) ⇒ <code>boolean</code>
+Detect if a file exists and is usable.
+
+**Kind**: static method of [<code>test-fs</code>](#module_test-fs)  
+
+| Param | Type |
+| --- | --- |
+| filePath | <code>string</code> | 
+
 <a name="module_test-fs.countMatches"></a>
 
 ### test-fs.countMatches(content, search) ⇒ <code>number</code>