ParseLinkResult

A result of parsing a link.

Import:

import type { ParseLinkResult } from 'obsidian-dev-utils/obsidian/parse-link';

Signature:

export interface ParseLinkResult

Properties

Property	Type	Description
alias?	string	An alias of the link.
encodedUrl?	string	An encoded URL of the link.
endOffset	number	An end offset of the link in the original text.
hasAngleBrackets?	boolean	Indicates if the link has angle brackets.
isEmbed	boolean	Indicates if the link is an embed link.
isExternal	boolean	Indicates if the link is external.
isFileUrl	boolean	Indicates if the link is a `file://` URL.
isWikilink	boolean	Indicates if the link is a wikilink.
raw	string	A raw link text.
startOffset	number	A start offset of the link in the original text.
title?	string	A title of the link.
unescapedAlias?	string	An unescaped alias of the link.
url	string	An URL of the link.

Links to this page: