Home Manual Reference Source Test
import UsageError from 'atscm-cli/src/lib/error/UsageError.js'
public class | source

UsageError

Extends:

Error → UsageError

An error reported when yargs fails to parse arguments.

Test:

Constructor Summary

Public Constructor
public

constructor(message: string, help: string)

Creates a new UsageError based on an error message and the failing parser.

Member Summary

Public Members
public

Help text for the failing command.

Public Constructors

public constructor(message: string, help: string) source

Creates a new UsageError based on an error message and the failing parser.

Params:

NameTypeAttributeDescription
message string

The error message.

help string

Help text for the failing command.

Test:

Public Members

public help: String source

Help text for the failing command.