Function durationFlag

Duration flag with built-in default and min/max validation You must specify a unit Defaults to undefined if you don't specify a default

Example

import { Flags } from '@salesforce/sf-plugins-core';
public static flags = {
   wait: Flags.duration({
      min: 1,
      unit: 'minutes'
      defaultValue: 33,
      char: 'w',
      description: 'Wait time in minutes'
   }),
}
  • durationFlag(options): OptionFlag<Duration, CustomOptions>

  • Parameters

    Returns OptionFlag<Duration, CustomOptions>

  • durationFlag(options): OptionFlag<undefined | Duration[], CustomOptions>

  • Parameters

    Returns OptionFlag<undefined | Duration[], CustomOptions>

  • durationFlag(options): OptionFlag<undefined | Duration, CustomOptions>

  • Parameters

    Returns OptionFlag<undefined | Duration, CustomOptions>

  • durationFlag(options): OptionFlag<Duration, CustomOptions>

  • Parameters

    • options: DurationFlagConfig & ({ multiple?: false | undefined; } & (({ required: true; } | { default: FlagDefault<Duration | undefined, DurationFlagConfig>; }) & Partial<...>))

    Returns OptionFlag<Duration, CustomOptions>

  • durationFlag(options): OptionFlag<Duration[], CustomOptions>

  • Parameters

    • options: DurationFlagConfig & ({ multiple: true; } & (({ required: true; } | { default: FlagDefault<Duration[] | undefined, DurationFlagConfig>; }) & Partial<OptionFlag<Duration[], DurationFlagConfig>>))

    Returns OptionFlag<Duration[], CustomOptions>

  • durationFlag(options): OptionFlag<Duration, CustomOptions>

  • Parameters

    • options: DurationFlagConfig & ({ multiple?: false | undefined; } & (({ required: true; } | { default: FlagDefault<Duration | undefined, DurationFlagConfig>; }) & Partial<...>))

    Returns OptionFlag<Duration, CustomOptions>

  • durationFlag(options): OptionFlag<undefined | Duration, CustomOptions>

  • Parameters

    Returns OptionFlag<undefined | Duration, CustomOptions>

  • durationFlag(options): OptionFlag<Duration, CustomOptions>

  • Parameters

    Returns OptionFlag<Duration, CustomOptions>

  • durationFlag(options?): OptionFlag<Duration, CustomOptions>

  • Parameters

    Returns OptionFlag<Duration, CustomOptions>

  • durationFlag(options): OptionFlag<Duration[], CustomOptions>

  • Parameters

    Returns OptionFlag<Duration[], CustomOptions>

Settings

Member Visibility