Upgrading commander 3 to 4
Unknown3.0.2 → 4.1.1
Fetching 6 releases from GitHub…0 / 6
UnknownUpgrade verdict
DepDelta is still reading the notes for this range, so breaking changes can't be ruled out yet.
In plain terms
- DepDelta is still reading the release notes in this range, so it can't rule out breaking changes yet.
- This page updates as the notes come in.
Must act Still reading release notes
DepDelta is still reading the release notes in this range. This updates as they come in.
Requires Node.js >= 6 from 4.0.0 (none stated before).
API changes
Generated by DepDelta from published .d.ts files. Not mixed with prose notes.
- removed:
property commander.CommanderStatic.CommandOptions: CommandOptions - removed:
property commander.CommanderStatic.ParseOptionsResult: ParseOptionsResult - removed:
type commander.Command = local.Command - removed:
type commander.Option = local.Option - changed:
property commander.CommanderStatic.Command: typeof local.Command → property commander.CommanderStatic.Command: CommandConstructor - changed:
property commander.CommanderStatic.Option: typeof local.Option → property commander.CommanderStatic.Option: OptionConstructor - added:
index commander.Command[key: string]: any - added:
interface commander.Command extends NodeJS.EventEmitter - added:
interface commander.CommanderError extends Error - added:
interface commander.Option - added:
method commander.Command.action(fn: (...args: any[]) => void | Promise<void>): Command - added:
method commander.Command.alias(): string - added:
method commander.Command.alias(alias: string): Command - added:
method commander.Command.allowUnknownOption(arg?: boolean): Command - added:
method commander.Command.arguments(desc: string): Command - added:
method commander.Command.command(nameAndArgs: string, description: string, opts?: commander.CommandOptions): Command - added:
method commander.Command.command(nameAndArgs: string, opts?: CommandOptions): Command - added:
method commander.Command.description(): string - added:
method commander.Command.description(str: string, argsDescription?: { [argName: string]: string }): Command - added:
method commander.Command.exitOverride(callback?: (err: CommanderError) => never|void): Command - added:
method commander.Command.help(cb?: (str: string) => string): never - added:
method commander.Command.helpOption(flags?: string, description?: string): Command - added:
method commander.Command.name(): string - added:
method commander.Command.name(str: string): Command - added:
method commander.Command.option(flags: string, description?: string, defaultValue?: any): Command - added:
method commander.Command.option(flags: string, description?: string, fn?: ((arg1: any, arg2: any) => void) | RegExp, defaultValue?: any): Command - added:
method commander.Command.opts(): { [key: string]: any } - added:
method commander.Command.outputHelp(cb?: (str: string) => string): void - added:
method commander.Command.parse(argv: string[]): Command - added:
method commander.Command.parseAsync(argv: string[]): Promise<any> - added:
method commander.Command.parseExpectedArgs(args: string[]): Command - added:
method commander.Command.parseOptions(argv: string[]): commander.ParseOptionsResult - added:
method commander.Command.passCommandToAction(value?: boolean): Command - added:
method commander.Command.requiredOption(flags: string, description?: string, defaultValue?: any): Command - added:
method commander.Command.requiredOption(flags: string, description?: string, fn?: ((arg1: any, arg2: any) => void) | RegExp, defaultValue?: any): Command - added:
method commander.Command.storeOptionsAsProperties(value?: boolean): Command - added:
method commander.Command.usage(): string - added:
method commander.Command.usage(str: string): Command - added:
method commander.Command.version(str: string, flags?: string, description?: string): Command - added:
property commander.Command.args: string[] - added:
property commander.CommanderError.code: string - added:
property commander.CommanderError.exitCode: number - added:
property commander.CommanderError.message: string - added:
property commander.CommanderError.nestedError?: string - added:
property commander.CommanderStatic.CommanderError:CommanderErrorConstructor - added:
property commander.Option.bool: boolean - added:
property commander.Option.description: string - added:
property commander.Option.flags: string - added:
property commander.Option.long: string - added:
property commander.Option.mandatory: boolean - added:
property commander.Option.optional: boolean - added:
property commander.Option.required: boolean - added:
property commander.Option.short?: string - added:
type commander.CommandConstructor = { new (name?: string): Command } - added:
type commander.CommanderErrorConstructor = { new (exitCode: number, code: string, message: string): CommanderError } - added:
type commander.OptionConstructor = { new (flags: string, description?: string): Option }