apiVersion for a salesforce org's rest api. Will validate format and that the api version is still supported. Will default to the version specified in Config, if it exists (and will provide an override warning)

CAVEAT: unlike the apiversion flag on sfdxCommand, this does not set the version on the org/connection We leave this up to the plugins to implement

import { Flags } from '@salesforce/sf-plugins-core';
public static flags = {
'api-version': Flags.orgApiVersion({
char: 'a',
description: 'api version for the org'
}),
}
  • Parameters

    • options: CustomOptions & {} & Partial<OptionFlag<string, CustomOptions>>

    Returns OptionFlag<string, CustomOptions>

  • Parameters

    • options: CustomOptions & {} & Partial<OptionFlag<undefined | string[], CustomOptions>>

    Returns OptionFlag<undefined | string[], CustomOptions>

  • Parameters

    • options: CustomOptions & {} & Partial<OptionFlag<undefined | string, CustomOptions>>

    Returns OptionFlag<undefined | string, CustomOptions>

  • Parameters

    • options: CustomOptions & {} & (({ required: true; } | { default: FlagDefault<string | undefined, CustomOptions>; }) & Partial<OptionFlag<string, CustomOptions>>)

    Returns OptionFlag<string, CustomOptions>

  • Parameters

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

    Returns OptionFlag<string[], CustomOptions>

  • Parameters

    • options: CustomOptions & {} & (({ required: true; } | { default: FlagDefault<string | undefined, CustomOptions>; }) & Partial<OptionFlag<string, CustomOptions>>)

    Returns OptionFlag<string, CustomOptions>

  • Parameters

    • options: CustomOptions & {} & Partial<OptionFlag<undefined | string, CustomOptions>>

    Returns OptionFlag<undefined | string, CustomOptions>

  • Parameters

    • options: CustomOptions & {} & Partial<OptionFlag<undefined | string, CustomOptions>>

    Returns OptionFlag<undefined | string, CustomOptions>

  • Parameters

    • Optionaloptions: CustomOptions & {} & Partial<OptionFlag<undefined | string, CustomOptions>>

    Returns OptionFlag<undefined | string, CustomOptions>

  • Parameters

    • options: CustomOptions & {} & Partial<OptionFlag<undefined | string[], CustomOptions>>

    Returns OptionFlag<undefined | string[], CustomOptions>