tsargp
    Preparing search index...

    Type Alias WithSectionUsage

    Defines additional attributes for the usage section.

    type WithSectionUsage = {
        comment?: StyledString;
        compact?: boolean;
        exclusive?: never;
        filter?: HelpSectionFilter;
        inclusive?: OptionDependencies;
        required?: ReadonlyArray<string>;
        showMarker?: boolean;
    }
    Index

    Properties

    comment? compact? exclusive? filter? inclusive? required? showMarker?

    Properties

    comment?: StyledString

    A commentary to append to the usage.

    compact?: boolean

    Whether to keep alternatives compact.

    true
    exclusive?: never

    Reserved for mutually exclusive option dependencies.

    filter?: HelpSectionFilter

    The section filter.

    inclusive?: OptionDependencies

    A record that specifies inclusive option dependencies.

    required?: ReadonlyArray<string>

    A list of option keys that should be considered always required.

    showMarker?: boolean

    Whether to display the positional marker.

    false

    Settings

    Member Visibility

    On This Page

    Properties