Angular Modernizer
    Preparing search index...

    Interface FindComponentHostsOutput

    Output of the find-component-hosts tool.

    interface FindComponentHostsOutput {
        alternatives: { className: string; file: string; selector: string }[];
        candidateHosts?: DynamicHost[];
        candidateTruncated: boolean;
        counts: {
            candidateHosts: number;
            dynamicHosts: number;
            hosts: number;
            occurrences: number;
            occurrencesMissingRequired: number;
            templatesScanned: number;
        };
        coverage: {
            inputs: Record<string, CoverageOutput>;
            outputs: Record<string, CoverageOutput>;
        };
        dynamicHosts?: DynamicHost[];
        dynamicTruncated: boolean;
        hosts?: HostOutput[];
        summary: string;
        target?: HostTarget;
        truncated: boolean;
        tsConfigPath: string;
        warnings?: string[];
    }

    Hierarchy

    • Omit<
          ComponentHostResult,
          "hosts"
          | "coverage"
          | "dynamicHosts"
          | "candidateHosts",
      >
      • FindComponentHostsOutput
    Index

    Properties

    alternatives candidateHosts? candidateTruncated counts coverage dynamicHosts? dynamicTruncated hosts? summary target? truncated tsConfigPath warnings?

    Properties

    alternatives: { className: string; file: string; selector: string }[]

    Other classes that matched the query too (ambiguous class name or selector).

    Type Declaration

    • className: string

      Class name.

    • file: string

      Absolute path of the declaring file.

    • selector: string

      Selector from the decorator.

    candidateHosts?: DynamicHost[]

    Registry lookups whose selector comes from data, cut to maxResults; omitted with summaryOnly.

    candidateTruncated: boolean

    true when maxResults cut the candidate list.

    counts: {
        candidateHosts: number;
        dynamicHosts: number;
        hosts: number;
        occurrences: number;
        occurrencesMissingRequired: number;
        templatesScanned: number;
    }

    Totals of the result.

    Type Declaration

    • candidateHosts: number

      Entries in ComponentHostResult.candidateHosts.

    • dynamicHosts: number

      Entries in ComponentHostResult.dynamicHosts.

    • hosts: number

      Template hosts.

    • occurrences: number

      Matching elements over all hosts.

    • occurrencesMissingRequired: number

      Occurrences with at least one missing required input.

    • templatesScanned: number

      Templates whose text may contain the selector and were parsed.

    coverage: {
        inputs: Record<string, CoverageOutput>;
        outputs: Record<string, CoverageOutput>;
    }

    Per input/output: host counts, and host names unless summaryOnly (capped by maxResults).

    Type Declaration

    dynamicHosts?: DynamicHost[]

    Places creating the component in code, cut to maxResults; omitted with summaryOnly.

    dynamicTruncated: boolean

    true when maxResults cut the dynamic host list.

    hosts?: HostOutput[]

    Hosts, cut to maxResults; omitted with summaryOnly.

    summary: string

    Short text summary of the hosts and the binding coverage.

    target?: HostTarget

    undefined when no project component/directive matched the query.

    truncated: boolean

    true when maxResults cut the host list.

    tsConfigPath: string

    The tsconfig whose program was searched.

    warnings?: string[]

    Conditions that can make the result incomplete (unresolved library imports).

    Settings

    Member Visibility

    On This Page

    Properties