Home > @microsoft/rush-lib > IGlobalCommand

IGlobalCommand interface

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Information about the currently executing global script command (as defined in command-line.json) provided to plugins.

Signature:

export interface IGlobalCommand extends IRushCommand 

Extends: IRushCommand

Methods

Method	Description
getCustomParametersByLongName(longName)	(BETA) Get a parameter by its long name (e.g. "--output-path") that was defined in command-line.json for this command. If the parameter was not defined or not provided on the command line, this will throw.
setHandled()	(BETA) Call this from a plugin hook to indicate that the command has been fully handled by the plugin. When set, the default shell command execution will be skipped.