Class FrontMatterHandler

Stores and retrieves Front Matter data from FRONT_MATTER_DATA_STORE.

Hierarchy

FrontMatterHandler

Index

Methods

get
set

Methods

Static get

get(filePath: string): FrontMatterData

- Defined in src/tools/front-matter/front-matter-handler.class.ts:14
Gets the front matter data for a given file by its path.

Parameters
- filePath: string
  
  full absolute path to the file.
Returns FrontMatterData

the Front Matter data of that file.

Static set

set(filePath: string, data: FrontMatterData): void

- Defined in src/tools/front-matter/front-matter-handler.class.ts:25
Stores the front matter for a file, indexed by its full absolute path. If the object for the given path does not exist, it is created first.

Parameters
- filePath: string
  
  the full absolute path to the file.
- data: FrontMatterData
  
  the data to store.
Returns void