@ng-doc/builder
Version:
<!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/ng-doc/ng-doc"> <img src="https://ng-doc.com/assets/images/ng-doc.svg?raw=true" alt="Logo" height="150px"> </a>
30 lines (29 loc) • 997 B
TypeScript
import { NgDocApi, NgDocApiScope, NgDocCategory, NgDocPage } from '@ng-doc/core';
import { NgDocSupportedDeclaration } from '../../../types';
import { MarkdownEntry } from './markdown-entry';
export interface DeclarationEntry {
declaration: NgDocSupportedDeclaration;
scope: NgDocApiScope;
}
export type DeclarationTabEntry = MarkdownEntry & DeclarationEntry;
export type ContentEntry = NgDocPage | NgDocApi | MarkdownEntry | DeclarationEntry | DeclarationTabEntry;
export type FileEntry = NgDocPage | NgDocApi | NgDocCategory;
export type Entry = ContentEntry | NgDocCategory;
/**
*
* @param entry
* @param filePath
*/
export declare function isPageEntry(entry: Entry, filePath: string): entry is NgDocPage;
/**
*
* @param entry
* @param filePath
*/
export declare function isCategoryEntry(entry: Entry, filePath: string): entry is NgDocCategory;
/**
*
* @param entry
* @param filePath
*/
export declare function isApiEntry(entry: Entry, filePath: string): entry is NgDocApi;