HeadingSubpathResult

Official

Both Official Unofficial

Both Own Inherited

Subpath result for a heading from resolveSubpath

Import:

import type { HeadingSubpathResult } from 'obsidian';

Example:

console.log(resolveSubpath(myNoteCache, '#foo'));

Signature:

export interface HeadingSubpathResult extends SubpathResult

Extends: SubpathResult

Properties

	Property	Type	Description
	current	HeadingCache	The cache of the found heading.
	end	Loc | null	The end location of the subpath. (Inherited from SubpathResult)
	next	HeadingCache	The cache of the next heading on the same or higher level.
	start	Loc	The start location of the subpath. (Inherited from SubpathResult)
	type	'heading'	The type of the subpath result.

---

Links to this page:

• resolveSubpath