Type alias WithRequired

WithRequired: {
    comment?: string;
    required?: ReadonlyArray<string>;
    requires?: Readonly<Record<string, string>>;
}

Defines additional attributes for the usage section.

Type declaration

  • Optional Readonly comment?: string

    A commentary to append to the usage.

  • Optional Readonly required?: ReadonlyArray<string>

    A list of options that should be considered required in the usage.

  • Optional Readonly requires?: Readonly<Record<string, string>>

    A map of option keys to required options.