# CommandOptions Interface

Module
import { CommandOptions } from "@tsed/cli-core"
Source/packages/cli-core/src/interfaces/CommandParameters.ts

# Overview

interface CommandOptions {
    description: string;
    type?: Type<any>;
    itemType?: Type<any>;
    defaultValue?: string | number | boolean | any;
    required?: boolean;
    customParser?: (value: any) => any;
}

# Members

description: string

Description of the commander.option()


type?: Type<any>

Use type to parse the option (String, Number, Boolean, Array)


itemType?: Type<any>

Use item type to parse items


defaultValue?: string | number | boolean | any

Default value


required?: boolean

Define a require option


customParser?: (value: any) => any

Use a custom Parser