bit-docs-glob-finder/index module

find.files(siteConfig)

Parameters

  1. siteConfig {Object}:

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

    • glob {String|GlobObject}

      The glob option either specifies a minimatch pattern like:

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

      Or a GlobObject that specifies the a minimatch pattern and other siteConfig like:

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

Returns

{FileEventEmitter}:

An event emitter that emits events for matched files.