Skip to content

OpenGitHubCommandHandler

Base class for commands that open a page in the plugin’s GitHub repository.

Import:

import { OpenGitHubCommandHandler } from '@mnaoumov/obsidian-lib/command-handlers/open-git-hub-command-handler';

Signature:

export class OpenGitHubCommandHandler extends GlobalCommandHandler

Extends: GlobalCommandHandler

Constructor

new OpenGitHubCommandHandler(params: OpenGitHubCommandHandlerConstructorParams)

Constructs a new instance.

Properties

PropertyTypeDescription
gitHubRepostringThe plugin's repository, as owner/name.
iconIconNameThe icon for the command.
(Inherited from GlobalCommandHandler)
idstringThe ID of the command.
(Inherited from GlobalCommandHandler)
namestringThe display name of the command.
(Inherited from GlobalCommandHandler)

Methods

MethodReturnsDescription
buildCommand()CommandBuilds a plain Obsidian Command object with a checkCallback.
(Inherited from GlobalCommandHandler)
canExecute()booleanChecks whether the command can currently execute.
(Inherited from GlobalCommandHandler)
execute()Promise<void>Opens the page in the browser when the command is available.
getUrl()Promisable<string>Builds the destination URL.
onRegistered(context)Promise<void>Called after the command has been registered with Obsidian. Subclasses use the provided context to register menu event handlers.

Throws when the same instance is registered twice. A handler stores per-registration state — the plugin name here, the active-file provider and the submenu override in AbstractFileCommandHandler, plus whatever a subclass records — and the menu closures registered here read that state lazily, at menu-render time. So a second registration silently rewrites what the first registration's closures will see. CommandHandlerComponent registers a handler set once per menu surface, which is why CommandHandlerFactory must build FRESH instances on every call; this guard turns a factory that hands out shared instances into a loud failure instead of a wrong context menu.
(Inherited from GlobalCommandHandler)

Links to this page: