Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "documentation/filters"

Index

Interfaces

Variables

Functions

Object literals

Variables

Const defaultDocumentFilter

defaultDocumentFilter: (document: IDocument) => boolean = createGlobDocumentFilter(defaultFilterConfig.documentIgnorePatterns)

Type declaration

    • (document: IDocument): boolean

    • Parameters

      • document: IDocument

      Returns boolean

Const defaultModuleFilter

defaultModuleFilter: (module: IModule) => boolean = createRegexModuleFilter(new RegExp(defaultFilterConfig.modulesRegex))

Type declaration

    • (module: IModule): boolean

    • Parameters

      • module: IModule

      Returns boolean

Functions

Const createGlobDocumentFilter

  • createGlobDocumentFilter(ignorePatterns: string[]): (document: IDocument) => boolean

  • Parameters

    • ignorePatterns: string[]

    Returns (document: IDocument) => boolean

      • (document: IDocument): boolean

      • Parameters

        • document: IDocument

        Returns boolean

Const createRegexModuleFilter

  • createRegexModuleFilter(filter?: RegExp): (module: IModule) => boolean

  • Parameters

    • Optional filter: RegExp

    Returns (module: IModule) => boolean

      • (module: IModule): boolean

      • Parameters

        • module: IModule

        Returns boolean

Object literals

Const defaultFilterConfig

defaultFilterConfig: object

documentIgnorePatterns

documentIgnorePatterns: string[] = ["**"]

modulesRegex

modulesRegex: string = ".*"

Generated using TypeDoc