GlobObject typedef

An options object that configures the behavior of bit-docs-glob-finder/index. 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

Options

  • pattern {String}:

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

    "**/*.js"
    
  • cwd {String}:

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

  • ignore {String}:

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

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