Frontmatter | @stoplight/markdown

Type parameters

T: object

Hierarchy

Frontmatter

Implements

IFrontmatter<T>

Index

Constructors

constructor

Properties

document

Accessors

isEmpty

Methods

Constructors

constructor

new Frontmatter(data: Node | string, mutate?: boolean): Frontmatter

- Defined in frontmatter/frontmatter.ts:21
Parameters
- data: Node | string
- Default value mutate: boolean = false
Returns Frontmatter

Properties

document

document: Node

Accessors

isEmpty

isEmpty:

Methods

get

get<V>(prop: PropertyPath): V | void

Implementation of IFrontmatter.get
- Defined in frontmatter/frontmatter.ts:59
Type parameters
- V
Parameters
- prop: PropertyPath
Returns V | void

getAll

getAll(): Partial<T> | void

Implementation of IFrontmatter.getAll
- Defined in frontmatter/frontmatter.ts:53
Returns Partial<T> | void

set

set(prop: PropertyPath, value: unknown): void

Implementation of IFrontmatter.set
- Defined in frontmatter/frontmatter.ts:65
Parameters
- prop: PropertyPath
- value: unknown
Returns void

stringify

stringify(): string

Implementation of IFrontmatter.stringify
- Defined in frontmatter/frontmatter.ts:94
Returns string

unset

unset(prop: PropertyPath): void

Implementation of IFrontmatter.unset
- Defined in frontmatter/frontmatter.ts:74
Parameters
- prop: PropertyPath
Returns void

Static getFrontmatterBlock

getFrontmatterBlock(value: string): Optional<string>

- Defined in frontmatter/frontmatter.ts:99
Parameters
- value: string
Returns Optional<string>