External module "src/topic-metadata"

Index

Enumerations

Interfaces

Functions

Functions

categorizeTopic

categorizeTopic(metadata: TopicMetadata): TopicType.Conceptual | TopicType.Namespace | TopicType.Type | TopicType.Property | TopicType.Method | TopicType.PowerShellCmdlet

- Defined in src/topic-metadata.ts:128
Determine the type of topic represented by the specified topic metadata.

Parameters
- metadata: TopicMetadata
  
  The topic metadata.
Returns TopicType.Conceptual | TopicType.Namespace | TopicType.Type | TopicType.Property | TopicType.Method | TopicType.PowerShellCmdlet

getFileTopics

getFileTopics(contentFile: string): Promise<TopicMetadata[]>

- Defined in src/topic-metadata.ts:100
Get metadata for the topic(s) defined in the specified content file.

Parameters
- contentFile: string
  
  The full path of the content file.
Returns Promise<TopicMetadata[]>

A Promise that resolves to the topic metadata.

parseManagedReferenceYaml

parseManagedReferenceYaml(fileName: string): Promise<TopicMetadata[]>

- Defined in src/topic-metadata.ts:229
Parse page metadata from DocFX managed-class-reference YAML.

Parameters
- fileName: string
Returns Promise<TopicMetadata[]>

parseMarkdownTopicMetadata

parseMarkdownTopicMetadata(fileName: string): Promise<TopicMetadata>

- Defined in src/topic-metadata.ts:178
Parse page metadata from a Markdown file's YAML front-matter.

Parameters
- fileName: string
  
  The full path to the file.
Returns Promise<TopicMetadata>

A promise that resolves to the page metadata (or null if the page metadata could not be parsed).

Generated using TypeDoc