Class DirectiveIndex

Project-wide lookup of Angular components, directives and pipes declared in source files, and matching of template elements against their selectors with the compiler's own SelectorMatcher.

Remarks

Built lazily on first use. Only classes in the ts-morph program are indexed; declaration files, node_modules and *.spec.ts / *.test.ts files are skipped. Library components (Angular Material, ngx-*) ship compiled metadata instead of decorators and are therefore unknown here; callers report such elements as unresolved. A class with an unparsable selector is listed but never matches.

Example

const index = new DirectiveIndex(project);
index.match({ tag: 'app-item', attributes: [['appTooltip', '']], bindingNames: ['item'] });
// [{ className: 'ItemComponent', kind: 'component', selector: 'app-item', ... }]

Index

Constructors

constructor

Methods

allDirectives match pipe

Constructors

constructor

new DirectiveIndex(
project: Project,
options?: DirectiveIndexOptions,
): DirectiveIndex
Parameters
- project: Project
  Project whose source files are indexed.
- options: DirectiveIndexOptions = {}
  Project component decorators.
Returns DirectiveIndex

Methods

allDirectives

allDirectives(): IndexedDirective[]
All indexed components and directives.

Returns IndexedDirective[]

match

match(element: MatchableElement): IndexedDirective[]
Components and directives whose selector matches element.
Parameters
- element: MatchableElement
Returns IndexedDirective[]

pipe

pipe(name: string): IndexedPipe | undefined
Pipe declared under name, if any.
Parameters
- name: string
Returns IndexedPipe | undefined

Class DirectiveIndex

Remarks

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DirectiveIndex

Methods

allDirectives

Returns IndexedDirective[]

match

Parameters

Returns IndexedDirective[]

pipe

Parameters

Returns IndexedPipe | undefined

Settings

On This Page