Skip to content

GenerateRawMarkdownLinkParams

Params for generateRawMarkdownLink.

Import:

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

Signature:

export interface GenerateRawMarkdownLinkParams

Properties

PropertyTypeDescription
alias?string | undefinedAn alias of the link. Defaults to undefined.
isEmbed?booleanWhether the link should be an embed link.
isWikilinkbooleanWhether the link should be a wikilink.
shouldEscapeAlias?booleanWhether to escape the alias. Applicable only if isWikilink is false.
shouldUseAngleBrackets?booleanWhether to use angle brackets. Applicable only if isWikilink is false.
title?stringA title of the link.
urlstringAn URL of the link.

Links to this page: