Skip to content

CliHandlerRegistrarRegisterCliHandlerParams

Parameters for registering a CLI handler.

Import:

import type { CliHandlerRegistrarRegisterCliHandlerParams } from 'obsidian-dev-utils/obsidian/plugin-cli-handler-registrar';

Signature:

export interface CliHandlerRegistrarRegisterCliHandlerParams

Properties

PropertyTypeDescription
commandstringThe command to register the handler for.
descriptionstringThe description of the command.
flagsCliFlags | nullThe flags for the command.

Methods

MethodReturnsDescription
handler(cliData)Promisable<string>The handler to register.