Interface ModifierProject

interface ModifierProject {
    excludePdpFactoryIds?: string | string[];
    excludeProjectInterfaces?: string | (string | string[])[];
    includePdpFactoryIds?: string | string[];
    includeProjectInterfaces?: string | (string | string[])[];
}

Properties

excludePdpFactoryIds?: string | string[]

String representation of RegExp pattern(s) to match against the Project Data Provider Factory Ids that provided each project's metadata (using the test function) to determine if the projects should absolutely not be included even if they match with includeProjectInterfaces.

Defaults to none, so all projects that match includePdpFactoryIds will be included

excludeProjectInterfaces?: string | (string | string[])[]

String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should absolutely not be included even if they match with includeProjectInterfaces.

If this is one string, it will be matched against projectInterfaces. If this is an array, each entry is handled based on its type (at least one entry must match for this filter condition to exclude the project):

  • If the entry is a string, it will be matched against each projectInterface. If any match, the project will pass this filter condition and exclude the project
  • If the entry is an array of strings, each will be matched against each projectInterface. If every string matches against at least one projectInterface, the project will pass this filter condition and exclude the project

In other words, each entry in the first-level array is OR'ed together. Each entry in second-level arrays (arrays within the first-level array) are AND'ed together.

Defaults to no ProjectInterfaces, so all projects that match includeProjectInterfaces will be included

excludeProjectInterfaces: ['one', ['two', 'three']];

This filter condition will succeed and exclude projects whose projectInterfaces fulfill at least one of the following conditions (At least one entry in the array must match):

  • Include one
  • Include both two and three.
includePdpFactoryIds?: string | string[]

String representation of RegExp pattern(s) to match against the Project Data Provider Factory Ids that provided each project's metadata (using the test function) to determine if the projects should be included.

Defaults to all Project Data Provider Factory Ids, so all projects that do not match excludePdpFactoryIds will be included

includeProjectInterfaces?: string | (string | string[])[]

String representation of RegExp pattern(s) to match against projects' projectInterfaces (using the test function) to determine if they should be included.

If this is one string, it will be matched against projectInterfaces. If this is an array, each entry is handled based on its type (at least one entry must match for this filter condition to pass):

  • If the entry is a string, it will be matched against each projectInterface. If any match, the project will pass this filter condition
  • If the entry is an array of strings, each will be matched against each projectInterface. If every string matches against at least one projectInterface, the project will pass this filter condition

In other words, each entry in the first-level array is OR'ed together. Each entry in second-level arrays (arrays within the first-level array) are AND'ed together.

Defaults to all ProjectInterfaces, so all projects that do not match excludeProjectInterfaces will be included

includeProjectInterfaces: ['one', ['two', 'three']];

This filter condition will succeed on projects whose projectInterfaces fulfill at least one of the following conditions (At least one entry in the array must match):

  • Include one
  • Include both two and three.