Document mock options as an optional parameter

tschaub · Feb 20, 2022 · d61b9df · d61b9df
1 parent ebfc4b7
commit d61b9df
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -129,13 +129,13 @@ function restoreReadFileContext(binding) {
 /**
  * Swap out the fs bindings for a mock file system.
  * @param {Object} config Mock file system configuration.
- * @param {Object} options Any filesystem options.
+ * @param {Object} [options={}] Any filesystem options.
  * @param {boolean} options.createCwd Create a directory for `process.cwd()`
  *     (defaults to `true`).
  * @param {boolean} options.createTmp Create a directory for `os.tmpdir()`
  *     (defaults to `true`).
  */
-exports = module.exports = function mock(config, options) {
+exports = module.exports = function mock(config, options = {}) {
   const system = FileSystem.create(config, options);
   const binding = new Binding(system);