files

  • function
 

.find.files(options)

Parameters

  1. options {Object}

    Options that configure the behavior of the files that will be processed.

    • glob {String | GlobObject}

      The glob option either specifies a minmatch pattern like:

      documentjs.find.files({glob: "*.js"})
      

      Or a GlobObject that specifies the a minmatch pattern and other options like:

      documentjs.find.files({
        glob: {
          pattern: "*.js",
          cwd: __dirname  
        }
      })
      

Returns

{fileEventEmitter}

An event emitter that emits events for matched files.