parseLinktext

Official

Parses the linktext of a wikilink into its component parts.

Import:

import { parseLinktext } from 'obsidian';

Example:

console.log(parseLinktext('[[foo]]')); // { path: 'foo', subpath: '' }
console.log(parseLinktext('[[foo#bar]]')); // { path: 'foo', subpath: 'bar' }

Signature:

function parseLinktext(linktext: string): ParsedLinktext

Parameters:

Parameter	Type	Description
linktext	string	A wikilink without the leading [[ and trailing ]].

Returns: ParsedLinktext — filepath and subpath (subpath can refer either to a block id, or a heading).

Example:

console.log(parseLinktext('[[foo]]')); // { path: 'foo', subpath: '' }
console.log(parseLinktext('[[foo#bar]]')); // { path: 'foo', subpath: 'bar' }