File

packages/ast-to-mmd/src/app/file-filter/file-filter.ts

Description

Interface represents File filter for filtering unwanted files.

Index

Methods

Methods

accept
accept(file: SourceFile)

Decides, whether to accept file or not based on internal conditions.

Parameters :
Name Type Optional Description
file SourceFile No

SourceFile.

Returns : boolean

True, when file is accepted, False otherwise.

import { SourceFile } from 'ts-morph';

/**
 * Interface represents File filter for filtering unwanted files.
 */
export interface FileFilter {

  /**
   * Decides, whether to accept file or not based on internal conditions.
   *
   * @param file {@link SourceFile}.
   * @returns True, when file is accepted, False otherwise.
   */
  accept(file: SourceFile): boolean;

}

results matching ""

    No results matching ""