CommandOpts

@tsed/cli-core

Usage

import { CommandOpts } from "@tsed/cli-core";

See /packages/cli-core/src/interfaces/CommandOptions.ts.

Overview

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

description

description: string;

Description of the commander.option()

type

type?: Type<any>;

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

itemType

itemType?: Type<any>;

Use item type to parse items

defaultValue

defaultValue?: string | number | boolean | any;

Default value

required

required?: boolean;

Define a require option

customParser:

customParser?: (value: any) => any;

Use a custom Parser