Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a group of files in a DocFX project.

Hierarchy

  • FileGroup

Index

Constructors

constructor

Properties

baseDir

baseDir: string

The full path of the base directory for the files in the file group.

fileFilter

fileFilter: FileFilter

A {@link} FileFilter used to include / exclude files.

projectBaseDir

projectBaseDir: string

The base directory of the project containing the file group.

relativeBaseDir

relativeBaseDir: string

The base directory, relative to the project base directory, of the files in the file group.

Methods

getFiles

  • getFiles(...extensions: string[]): Promise<string[]>
  • Retrieve the paths of all files in the group.

    Parameters

    • Rest ...extensions: string[]

      Optional file extensions used to filter the results.

    Returns Promise<string[]>

    A promise that resolves to the file paths.

includesFile

  • includesFile(filePath: string): boolean
  • Determine whether the specified file is included in the group.

    Parameters

    • filePath: string

      The full or relative path of the file.

    Returns boolean

    true, if the file is included in the project; otherwise, false.

Generated using TypeDoc