本文整理匯總了TypeScript中dgeni.Package類的典型用法代碼示例。如果您正苦於以下問題:TypeScript Package類的具體用法?TypeScript Package怎麽用?TypeScript Package使用的例子?那麽, 這裏精選的類代碼示例或許可以為您提供幫助。
在下文中一共展示了Package類的2個代碼示例,這些例子默認根據受歡迎程度排序。您可以為喜歡或者感覺有用的代碼點讚,您的評價將有助於係統推薦出更棒的TypeScript代碼示例。
示例1: Package
/**
* Dgeni package for the Angular Material docs. This just defines the package, but doesn't
* generate the docs yet.
*
* Dgeni packages are very similar to AngularJS modules. Those can contain:
*
* - Services that can be injected
* - Templates that are used to convert the data into HTML output.
* - Processors that can modify the doc items (like a build pipeline).
*
* Similar to AngularJS, there is also a `config` lifecycle hook, that can be used to
* configure specific processors, services before the procession begins.
*/
export const apiDocsPackage = new Package('material2-api-docs', [
jsdocPackage,
nunjucksPackage,
typescriptPackage,
]);
// Processor that filters out duplicate exports that should not be shown in the docs.
apiDocsPackage.processor(new FilterDuplicateExports());
// Processor that merges inherited properties of a class with the class doc.
apiDocsPackage.processor(new MergeInheritedProperties());
// Processor that filters out symbols that should not be shown in the docs.
apiDocsPackage.processor(new DocsPrivateFilter());
// Processor that appends categorization flags to the docs, e.g. `isDirective`, `isNgModule`, etc.
apiDocsPackage.processor(new Categorizer());
示例2: globSync
const dgeniPackageDeps = [
jsdocPackage,
nunjucksPackage,
typescriptPackage,
];
/** List of CDK packages that need to be documented. */
const cdkPackages = globSync(path.join(sourceDir, 'cdk', '*/'))
.filter(packagePath => !packagePath.endsWith('testing/'))
.map(packagePath => path.basename(packagePath));
/** List of Material packages that need to be documented. */
const materialPackages = globSync(path.join(sourceDir, 'lib', '*/'))
.map(packagePath => path.basename(packagePath));
export const apiDocsPackage = new Package('material2-api-docs', dgeniPackageDeps);
// Processor that filters out symbols that should not be shown in the docs.
apiDocsPackage.processor(new DocsPrivateFilter());
// Processor that appends categorization flags to the docs, e.g. `isDirective`, `isNgModule`, etc.
apiDocsPackage.processor(new Categorizer());
// Processor to group components into top-level groups such as "Tabs", "Sidenav", etc.
apiDocsPackage.processor(new ComponentGrouper());
// Configure the log level of the API docs dgeni package.
apiDocsPackage.config((log: any) => log.level = 'info');
// Configure the processor for reading files from the file system.