Home Reference Source Repository
import {ProjectSymbols} from 'ngast/dist-docs/lib/project-symbols.js'
public class | source

ProjectSymbols

This class is a wrapper around an Angular project. It provides access to the root module of the project as well as to it's lazy loaded modules which can be resolved.

Constructor Summary

Public Constructor
public

constructor(programFactory: ProgramFactory, resolver: ResourceResolver, lazyModuleResolver: any)

Creates an instance of ProjectSymbols.

Method Summary

Public Methods
public

Returns a list of all modules in the project:

  • All lazy loaded modules
  • The root module
public

Provides access to the ContextSymbols corresponding to the root module of the project that is not loaded lazily.

Public Constructors

public constructor(programFactory: ProgramFactory, resolver: ResourceResolver, lazyModuleResolver: any) source

Creates an instance of ProjectSymbols.

Params:

NameTypeAttributeDescription
programFactory ProgramFactory
resolver ResourceResolver
lazyModuleResolver any
  • optional
  • default: new BasicLazyModuleResolver()

Public Methods

public getLazyLoadedContexts(): ContextSymbols[] source

Returns a list of all modules in the project:

  • All lazy loaded modules
  • The root module

Return:

ContextSymbols[]

public getRootContext(): ContextSymbols source

Provides access to the ContextSymbols corresponding to the root module of the project that is not loaded lazily.

Return:

ContextSymbols