Class MetadataCache

Cache for topic metadata.

Hierarchy

MetadataCache

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new MetadataCache(stateDirectory: string): MetadataCache

- Defined in src/metadata-cache.ts:75
Create a new topic metadata cache.

Parameters
- stateDirectory: string
  
  The directory for persisted cache state.
Returns MetadataCache

Accessors

hasOpenProject

get hasOpenProject(): boolean

- Defined in src/metadata-cache.ts:73
Does the cache currently have an open project?

Returns boolean

isPopulated

get isPopulated(): boolean

- Defined in src/metadata-cache.ts:33
Is the cache currently populated?

Returns boolean

project

get project(): DocFXProject

- Defined in src/metadata-cache.ts:52
The cache's underlying DocFX project.

Returns DocFXProject

projectDir

get projectDir(): string

- Defined in src/metadata-cache.ts:66
The current project directory (if any).

Returns string

projectFile

get projectFile(): string

- Defined in src/metadata-cache.ts:59
The current project file (if any).

Returns string

topicChanges

get topicChanges(): Observer<TopicChange>

- Defined in src/metadata-cache.ts:45
An observer for ongoing changes to topic metadata.

Returns Observer<TopicChange>

topicCount

get topicCount(): number

- Defined in src/metadata-cache.ts:38
The number of topics in the cache.

Returns number

Methods

closeProject

closeProject(): Promise<void>

- Defined in src/metadata-cache.ts:144
Close the current DocFX project (if any).

Returns Promise<void>

ensurePopulated

ensurePopulated(progress?: Observer<string>): Promise<boolean>

- Defined in src/metadata-cache.ts:195
Ensure that the cache is populated.

Parameters
- Optional progress: Observer<string>
  
  An optional observer used to report progress.
Returns Promise<boolean>

true, if the cache was successfully populated; otherwise, false.

flush

flush(clearWorkspaceState?: boolean): Promise<void>

- Defined in src/metadata-cache.ts:158
Flush the metadata cache.

Parameters
- Optional clearWorkspaceState: boolean
  
  Also clear any state data persisted in workspace state?
Returns Promise<void>

getTopic

getTopic(uid: string): TopicMetadata | null

- Defined in src/metadata-cache.ts:99
Get the metadata for the topic (if any) associated with the specified UID.

throws

MetadataCacheError The cache does not current have an open project.

Parameters
- uid: string
  
  The target UID.
Returns TopicMetadata | null

The metadata, or null if no topic was found with the specified Id.

getTopics

getTopics(uidPrefix?: string): TopicMetadata[]

- Defined in src/metadata-cache.ts:113
Get metadata for some or all of the topics in the cache.

throws

MetadataCacheError The cache does not current have an open project.

Parameters
- Optional uidPrefix: string
  
  If specified, only topics whose UID start with the specified prefix will be returned.
Returns TopicMetadata[]

The topic metadata.

openProject

openProject(docfxProjectFile: string): Promise<void>

- Defined in src/metadata-cache.ts:130
Open a DocFX project.

Parameters
- docfxProjectFile: string
  
  The DocFX project file.
Returns Promise<void>

persist

persist(): Promise<void>

- Defined in src/metadata-cache.ts:175
Persist the metadata cache state.

Returns Promise<void>

Generated using TypeDoc