Skip to content

OpenBugReportCommandHandlerConstructorParams

Constructor parameters for OpenBugReportCommandHandler.

Import:

import type { OpenBugReportCommandHandlerConstructorParams } from '@mnaoumov/obsidian-lib/command-handlers/open-bug-report-command-handler';

Signature:

export interface OpenBugReportCommandHandlerConstructorParams

Properties

PropertyTypeDescription
appAppThe Obsidian app instance.
getDiagnostics?() => Promisable<readonly BugReportDiagnosticSection[]>Gets the optional diagnostics the report can carry, such as a BugReportLogBuffer's section or the plugin's own redacted settings. Called each time the command runs. When it returns any section, the user reviews them and chooses which to include before the form opens; a potentially private section starts excluded. Leave it out to open the form with the environment only, as before.
gitHubRepostringThe plugin's GitHub repository, as owner/name.
maxUrlLength?numberThe most characters the encoded link may have before the report moves to the clipboard.
pluginIdstringThe id of the reporting plugin.