Home Reference Source Test 
import Argument from 'gulp-task-help/src/Argument.js'
public class | source

Argument

An argument description

Static Method Summary

Static Public Methods
public static

compare(argA: Argument, argB: Argument): number

Compare two arguments lexicographically by name

Constructor Summary

Public Constructor
public

constructor(argumentName: string, description: string, defaultValue: *)

Construct an argument

Member Summary

Public Members
public get

defaultValue: *: *

The default argument value
public get

The argument description
public get

name: string: *

The argument name

Static Public Methods

public static compare(argA: Argument, argB: Argument): number source

Compare two arguments lexicographically by name

Params:

NameTypeAttributeDescription
argA Argument

The first argument
argB Argument

The second argument

Return:

number

See:

Public Constructors

public constructor(argumentName: string, description: string, defaultValue: *) source

Construct an argument

Params:

NameTypeAttributeDescription
argumentName string

The name of the argument
description string
  • optional

The description of the argument
defaultValue *
  • optional

The default value of the argument

Public Members

public get defaultValue: *: * source

The default argument value

Return:

*

public get description: string: * source

The argument description

Return:

string

public get name: string: * source

The argument name

Return:

string