Skip to content

buildBugReportIssueFormLink

Builds a link to a plugin’s bug-report issue form, prefilled with the environment and the given diagnostics. When the encoded link would be longer than BuildBugReportIssueFormLinkParams.maxUrlLength, the environment field gets BUG_REPORT_PASTE_INSTRUCTIONS instead, and the full text is returned as BugReportIssueFormLink.clipboardText for the caller to copy. Nothing is cut.

Import:

import { buildBugReportIssueFormLink } from '@mnaoumov/obsidian-lib/bug-report';

Signature:

function buildBugReportIssueFormLink(params: BuildBugReportIssueFormLinkParams): BugReportIssueFormLink

Parameters:

Parameter Type Description
params BuildBugReportIssueFormLinkParams The parameters.

Returns: BugReportIssueFormLink — The link, and the text to paste when it did not fit.


Links to this page: