GlobObject

  • typedef
documentjs.find.globObject

{Object}

 

An options object that configures the behavior of documentjs.find.files. It supports all of the options object of node-glob plus a pattern option that is used as node-glob's first argument. Only the most commonly used options are specified below:

Object

Properties

  1. pattern {String}

    A minmatch pattern. The following matches all .js files:

    "**/*.js"
    
  2. cwd {String}Optional

    The current working directory in which to search. Defaults to process.cwd()

  3. ignore {String}Optional

    A pattern to ignore. For example, to ignore everything in node_modules:

    {
      pattern: "**/*.js",
      ignore: "node_modules/**/*"
    }