GlobalCommandHandler

Command handler for global commands invoked from the command palette.

Subclasses override canExecute and execute to provide behavior.

Import:

import { GlobalCommandHandler } from 'obsidian-dev-utils/obsidian/command-handlers/global-command-handler';

Signature:

export class GlobalCommandHandler extends CommandHandler

Extends: CommandHandler

Constructor

new GlobalCommandHandler(params: CommandHandlerConstructorParams)

Creates a new global command handler.

Properties

Property	Type	Description
icon	IconName	The icon for the command. (Inherited from CommandHandler)
id	string	The ID of the command. (Inherited from CommandHandler)
name	string	The display name of the command. (Inherited from CommandHandler)

Methods

Method	Returns	Description
buildCommand()	Command	Builds a plain Obsidian Command object with a checkCallback.
canExecute()	boolean	Checks whether the command can currently execute.
execute()	Promisable<void>	Executes the command.
onRegistered(context)	Promise<void>	Called after the command has been registered with Obsidian. Subclasses use the provided context to register menu event handlers. (Inherited from CommandHandler)

---

Links to this page:

• AbstractFileCommandHandler
• OpenDemoVaultCommandHandler
• OpenSettingsCommandHandler
• UnlockActiveNoteCommandHandler