From 69215386cbd4d435dc6aedf5bb3e5b487aefecc4 Mon Sep 17 00:00:00 2001 From: svc-cli-bot Date: Sun, 24 Nov 2024 08:48:33 +0000 Subject: [PATCH] docs: publishing gh-pages [skip ci] --- classes/SfCommandError.SfCommandError.html | 4 +- classes/sfCommand.SfCommand-1.html | 44 +++++++++---------- classes/ux_base.UxBase.html | 4 +- classes/ux_progress.Progress-1.html | 14 +++--- classes/ux_spinner.Spinner.html | 14 +++--- classes/ux_ux.Ux.html | 20 ++++----- .../compatibility.arrayWithDeprecation.html | 2 +- functions/errorFormatting.formatError.html | 2 +- functions/errorHandling.computeErrorCode.html | 2 +- functions/errorHandling.errorIsGack.html | 2 +- functions/errorHandling.errorIsTypeError.html | 2 +- functions/flags_duration.durationFlag.html | 2 +- ...flags_orgApiVersion.orgApiVersionFlag.html | 2 +- functions/flags_orgFlags.getHubOrThrow.html | 2 +- functions/flags_orgFlags.getOrgOrThrow.html | 2 +- functions/flags_orgFlags.maybeGetHub.html | 2 +- functions/flags_orgFlags.maybeGetOrg.html | 2 +- functions/flags_orgFlags.optionalHubFlag.html | 2 +- functions/flags_orgFlags.optionalOrgFlag.html | 2 +- functions/flags_orgFlags.requiredHubFlag.html | 2 +- functions/flags_orgFlags.requiredOrgFlag.html | 2 +- .../flags_salesforceId.salesforceIdFlag.html | 2 +- functions/stubUx.stubPrompter.html | 2 +- functions/stubUx.stubSfCommandUx.html | 2 +- functions/stubUx.stubSpinner.html | 2 +- functions/stubUx.stubUx.html | 2 +- functions/util.parseVarArgs.html | 2 +- functions/util.removeEmpty.html | 2 +- functions/util.toHelpSection.html | 2 +- functions/ux_prompts.confirm.html | 2 +- functions/ux_prompts.secretPrompt.html | 2 +- functions/ux_styledObject.default.html | 2 +- functions/ux_table.convertToNewTableAPI.html | 2 +- modules/SfCommandError.html | 2 +- modules/compatibility.html | 2 +- modules/errorFormatting.html | 2 +- modules/errorHandling.html | 2 +- modules/exported.html | 2 +- modules/flags_duration.html | 2 +- modules/flags_flags.html | 2 +- modules/flags_orgApiVersion.html | 2 +- modules/flags_orgFlags.html | 2 +- modules/flags_salesforceId.html | 2 +- modules/sfCommand.SfCommand.html | 2 +- modules/sfCommand.html | 2 +- modules/stubUx.html | 2 +- modules/util.html | 2 +- modules/ux_base.html | 2 +- modules/ux_progress.Progress.html | 2 +- modules/ux_progress.html | 2 +- modules/ux_prompts.html | 2 +- modules/ux_spinner.html | 2 +- modules/ux_standardColors.html | 2 +- modules/ux_styledObject.html | 2 +- modules/ux_table.html | 2 +- modules/ux_ux.html | 2 +- .../SfCommandError.SfCommandErrorOptions.html | 2 +- ...atibility.ArrayWithDeprecationOptions.html | 2 +- types/flags_duration.DurationFlagConfig.html | 2 +- types/flags_salesforceId.IdFlagConfig.html | 2 +- types/sfCommand.SfCommand.Error.html | 2 +- types/sfCommand.SfCommand.Info.html | 2 +- types/sfCommand.SfCommand.Json.html | 2 +- types/sfCommand.SfCommand.Warning.html | 2 +- types/sfCommand.SfCommandInterface.html | 2 +- types/ux_progress.Progress.Bar.html | 2 +- types/ux_progress.Progress.Options.html | 2 +- types/ux_progress.Progress.Payload.html | 2 +- types/ux_prompts.PromptInputs.html | 2 +- variables/compatibility.loglevel.html | 2 +- ...ility.optionalHubFlagWithDeprecations.html | 2 +- ...ility.optionalOrgFlagWithDeprecations.html | 2 +- ...ity.orgApiVersionFlagWithDeprecations.html | 2 +- ...ility.requiredHubFlagWithDeprecations.html | 2 +- ...ility.requiredOrgFlagWithDeprecations.html | 2 +- variables/flags_flags.Flags.html | 2 +- .../flags_orgApiVersion.maxDeprecated.html | 2 +- .../flags_orgApiVersion.maxDeprecatedUrl.html | 2 +- ...lags_orgApiVersion.minValidApiVersion.html | 2 +- variables/ux_prompts.prompts.html | 2 +- .../ux_standardColors.StandardColors.html | 2 +- 81 files changed, 125 insertions(+), 125 deletions(-) diff --git a/classes/SfCommandError.SfCommandError.html b/classes/SfCommandError.SfCommandError.html index 4190b05b..9f802aaf 100644 --- a/classes/SfCommandError.SfCommandError.html +++ b/classes/SfCommandError.SfCommandError.html @@ -1,4 +1,4 @@ -SfCommandError | @salesforce/sf-plugins-core

Class SfCommandError

Hierarchy

  • SfError
    • SfCommandError

Properties

commandName +SfCommandError | @salesforce/sf-plugins-core

Class SfCommandError

Hierarchy

  • SfError
    • SfCommandError

Properties

commandName oclif result? skipOclifErrorHandling @@ -7,4 +7,4 @@

Methods

appendErrorSuggestions toJson from -

Properties

commandName

commandName: string

oclif

oclif: {
    exit: number;
}

Optionalresult

result?: unknown

skipOclifErrorHandling

skipOclifErrorHandling: boolean

status

status: number

Optionalwarnings

warnings?: (string | StructuredMessage)[]

Methods

appendErrorSuggestions

toJson

Staticfrom

Settings

Member Visibility

On This Page

Properties
Methods
+

Properties

commandName

commandName: string

oclif

oclif: {
    exit: number;
}

Optionalresult

result?: unknown

skipOclifErrorHandling

skipOclifErrorHandling: boolean

status

status: number

Optionalwarnings

warnings?: (string | StructuredMessage)[]

Methods

appendErrorSuggestions

toJson

Staticfrom

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/classes/sfCommand.SfCommand-1.html b/classes/sfCommand.SfCommand-1.html index 3ca23460..f6c1c203 100644 --- a/classes/sfCommand.SfCommand-1.html +++ b/classes/sfCommand.SfCommand-1.html @@ -17,7 +17,7 @@

Example

import { SfCommand } from '@salesforce/sf-plugins-core';
export type MyJsonOutput = { success: boolean };
export default class MyCommand extends SfCommand<MyJsonOutput> {
  public async run(): Promise<MyJsonOutput> {
   return { success: true };
 }
}
-

Type Parameters

Hierarchy

Constructors

constructor +

Type Parameters

  • T

Hierarchy

  • Command
    • SfCommand

Constructors

constructor

Properties

configAggregator progress project? @@ -43,47 +43,47 @@ table url warn -

Constructors

constructor

Properties

configAggregator

configAggregator: ConfigAggregator

ConfigAggregator instance for accessing global and local configuration.

-

progress

progress: Progress

Add a progress bar to the console. Progress

-

Optionalproject

project?: SfProject

spinner

spinner: Spinner

Add a spinner to the console. Spinner

-

StaticbaseFlags

baseFlags: {
    flags-dir: OptionFlag<undefined | string, CustomOptions>;
} = ...

Static OptionalconfigurationVariablesSection

configurationVariablesSection?: HelpSection

Add a CONFIGURATION VARIABLES section to the help output.

+

Constructors

constructor

Properties

configAggregator

configAggregator: ConfigAggregator

ConfigAggregator instance for accessing global and local configuration.

+

progress

progress: Progress

Add a progress bar to the console. Progress

+

Optionalproject

project?: SfProject

spinner

spinner: Spinner

Add a spinner to the console. Spinner

+

StaticbaseFlags

baseFlags: {
    flags-dir: OptionFlag<undefined | string, CustomOptions>;
} = ...

Static OptionalconfigurationVariablesSection

configurationVariablesSection?: HelpSection

Add a CONFIGURATION VARIABLES section to the help output.

Example

import { SfCommand, toHelpSection } from '@salesforce/sf-plugins-core';
import { OrgConfigProperties } from '@salesforce/core';
export default class MyCommand extends SfCommand {
  public static configurationVariablesSection = toHelpSection(
    'CONFIGURATION VARIABLES',
    OrgConfigProperties.TARGET_ORG,
    OrgConfigProperties.ORG_API_VERSION,
  );
}
-

StaticenableJsonFlag

enableJsonFlag: boolean = true

Static OptionalenvVariablesSection

envVariablesSection?: HelpSection

Add an Environment VARIABLES section to the help output.

+

StaticenableJsonFlag

enableJsonFlag: boolean = true

Static OptionalenvVariablesSection

envVariablesSection?: HelpSection

Add an Environment VARIABLES section to the help output.

Example

import { SfCommand, toHelpSection } from '@salesforce/sf-plugins-core';
import { EnvironmentVariable } from '@salesforce/core';
export default class MyCommand extends SfCommand {
  public static envVariablesSection = toHelpSection(
    'ENVIRONMENT VARIABLES',
    EnvironmentVariable.SF_TARGET_ORG,
    EnvironmentVariable.SF_USE_PROGRESS_BAR,
  );
}
-

Static OptionalerrorCodes

errorCodes?: HelpSection

Add an ERROR CODES section to the help output.

+

Static OptionalerrorCodes

errorCodes?: HelpSection

Add an ERROR CODES section to the help output.

Example

import { SfCommand, toHelpSection } from '@salesforce/sf-plugins-core';
export default class MyCommand extends SfCommand {
  public static errorCodes = toHelpSection(
    'ERROR CODES',
    { 0: 'Success', 1: 'Failure' },
  );
}
-

StaticrequiresProject

requiresProject: boolean

Set to true if the command must be executed inside a Salesforce project directory.

+

StaticrequiresProject

requiresProject: boolean

Set to true if the command must be executed inside a Salesforce project directory.

If set to true the command will throw an error if the command is executed outside of a Salesforce project directory. Additionally, this.project will be set to the current Salesforce project (SfProject).

-

Methods

_run

confirm

  • confirm(__namedParameters): Promise<boolean>

  • Prompt user for yes/no confirmation. +

Methods

_run

confirm

  • confirm(__namedParameters): Promise<boolean>

  • Prompt user for yes/no confirmation. Avoid calling in --json scenarios and always provide a --no-prompt option for scripting

    -

    Parameters

    Returns Promise<boolean>

info

info

jsonEnabled

  • jsonEnabled(): boolean

  • Determine if the command is being run with the --json flag in a command that supports it.

    +

Returns void

jsonEnabled

  • jsonEnabled(): boolean

  • Determine if the command is being run with the --json flag in a command that supports it.

    Returns boolean

    true if the command supports json and the --json flag is present

    -

logJson

  • logJson(json): void

  • Parameters

    • json: unknown

    Returns void

logSensitive

  • logSensitive(msg?): void

  • Warn user about sensitive information (access tokens, etc...) before logging to the console.

    +

logJson

  • logJson(json): void

  • Parameters

    • json: unknown

    Returns void

logSensitive

  • logSensitive(msg?): void

  • Warn user about sensitive information (access tokens, etc...) before logging to the console.

    Parameters

    • Optionalmsg: string

      The message to log.

      -

    Returns void

logSuccess

  • logSuccess(message): void

  • Log a success message that has the standard success message color applied.

    +

Returns void

logSuccess

  • logSuccess(message): void

  • Log a success message that has the standard success message color applied.

    Parameters

    • message: string

      The message to log.

      -

    Returns void

Abstractrun

  • run(): Promise<T>

  • actual command run code goes here

    -

    Returns Promise<T>

secretPrompt

  • secretPrompt(__namedParameters): Promise<string>

  • Prompt user for yes/no confirmation. +

Returns void

Abstractrun

  • run(): Promise<T>

  • actual command run code goes here

    +

    Returns Promise<T>

secretPrompt

  • secretPrompt(__namedParameters): Promise<string>

  • Prompt user for yes/no confirmation. Avoid calling in --json scenarios and always provide a --no-prompt option for scripting

    -

    Parameters

    Returns Promise<string>

styledHeader

  • styledHeader(text): void

  • Log stylized header to the console. Will automatically be suppressed when --json flag is present.

    +

    Parameters

    Returns Promise<string>

styledHeader

  • styledHeader(text): void

  • Log stylized header to the console. Will automatically be suppressed when --json flag is present.

    Parameters

    • text: string

      the text to display as a header.

      -

    Returns void

styledJSON

  • styledJSON(obj): void

  • Log stylized JSON to the console. Will automatically be suppressed when --json flag is present.

    +

Returns void

styledJSON

  • styledJSON(obj): void

  • Log stylized JSON to the console. Will automatically be suppressed when --json flag is present.

    Parameters

    • obj: AnyJson

      The JSON to log.

      -

    Returns void

styledObject

  • styledObject(obj): void

  • Log stylized object to the console. Will automatically be suppressed when --json flag is present.

    +

Returns void

styledObject

  • styledObject(obj): void

  • Log stylized object to the console. Will automatically be suppressed when --json flag is present.

    Parameters

    • obj: AnyJson

      The object to log.

      -

    Returns void

table

  • table<R>(options): void

  • Display a table on the console. Will automatically be suppressed when --json flag is present.

    -

    Type Parameters

    • R extends Record<string, unknown>

    Parameters

    • options: TableOptions<R>

    Returns void

url

  • url(text, uri, params?): void

  • Log a stylized url to the console. Will automatically be suppressed when --json flag is present.

    +

Returns void

table

  • table<R>(options): void

  • Display a table on the console. Will automatically be suppressed when --json flag is present.

    +

    Type Parameters

    • R extends Record<string, unknown>

    Parameters

    • options: TableOptions<R>

    Returns void

url

  • url(text, uri, params?): void

  • Log a stylized url to the console. Will automatically be suppressed when --json flag is present.

    Parameters

    • text: string

      The text to display for the url.

    • uri: string

      The url to display.

      -
    • params: {} = {}

      Returns void

    warn

    • warn(input): Warning

    • Log warning to users. If --json is enabled, then the warning will be added to the json output under the warnings property.

      +
    • params: {} = {}

      Returns void

      warn

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Methods
      +

      Returns Warning

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      Methods
      diff --git a/classes/ux_base.UxBase.html b/classes/ux_base.UxBase.html index deae5f5a..3daf9bcf 100644 --- a/classes/ux_base.UxBase.html +++ b/classes/ux_base.UxBase.html @@ -1,3 +1,3 @@ -UxBase | @salesforce/sf-plugins-core

      Class UxBase

      Hierarchy (view full)

      Constructors

      constructor +UxBase | @salesforce/sf-plugins-core

      Class UxBase

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      outputEnabled -

      Constructors

      constructor

      Properties

      ReadonlyoutputEnabled

      outputEnabled: boolean

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      +

      Constructors

      constructor

      Properties

      ReadonlyoutputEnabled

      outputEnabled: boolean

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      diff --git a/classes/ux_progress.Progress-1.html b/classes/ux_progress.Progress-1.html index 19ae4e55..0b981104 100644 --- a/classes/ux_progress.Progress-1.html +++ b/classes/ux_progress.Progress-1.html @@ -1,14 +1,14 @@ Progress | @salesforce/sf-plugins-core

      Class Progress

      Class for display a progress bar to the console. Will automatically be suppressed if the --json flag is present.

      -

      Hierarchy (view full)

      Constructors

      constructor +

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      outputEnabled

      Methods

      finish setTotal start stop update -

      Constructors

      constructor

      Properties

      ReadonlyoutputEnabled

      outputEnabled: boolean

      Methods

      finish

      • finish(payload?): void

      • Update the progress bar with the final number and stop it.

        -

        Parameters

        • payload: {} = {}

          Returns void

        setTotal

        • setTotal(total): void

        • Set the total number of expected components.

          -

          Parameters

          • total: number

          Returns void

        start

        • start(total, payload?, options?): void

        • Start the progress bar.

          -

          Parameters

          • total: number
          • payload: Payload = {}
          • options: Partial<Options> = Progress.DEFAULT_OPTIONS

          Returns void

        stop

        update

        • update(num, payload?): void

        • Update the progress bar.

          -

          Parameters

          • num: number
          • payload: {} = {}

            Returns void

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          Methods
          +

          Constructors

          constructor

          Properties

          ReadonlyoutputEnabled

          outputEnabled: boolean

          Methods

          finish

          • finish(payload?): void

          • Update the progress bar with the final number and stop it.

            +

            Parameters

            • payload: {} = {}

              Returns void

            setTotal

            • setTotal(total): void

            • Set the total number of expected components.

              +

              Parameters

              • total: number

              Returns void

            start

            • start(total, payload?, options?): void

            • Start the progress bar.

              +

              Parameters

              • total: number
              • payload: Payload = {}
              • options: Partial<Options> = Progress.DEFAULT_OPTIONS

              Returns void

            stop

            update

            • update(num, payload?): void

            • Update the progress bar.

              +

              Parameters

              • num: number
              • payload: {} = {}

                Returns void

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              Methods
              diff --git a/classes/ux_spinner.Spinner.html b/classes/ux_spinner.Spinner.html index d4595ba7..29427239 100644 --- a/classes/ux_spinner.Spinner.html +++ b/classes/ux_spinner.Spinner.html @@ -1,14 +1,14 @@ Spinner | @salesforce/sf-plugins-core

              Class Spinner

              This class is a light wrapper around ux.action that allows us to automatically suppress any actions if --json flag is present.

              -

              Hierarchy (view full)

              Constructors

              constructor +

              Hierarchy (view full)

              Constructors

              constructor

              Properties

              outputEnabled

              Accessors

              status

              Methods

              pause start stop -

              Constructors

              constructor

              Properties

              ReadonlyoutputEnabled

              outputEnabled: boolean

              Accessors

              status

              • get status(): undefined | string

              • Get the status of the current spinner.

                -

                Returns undefined | string

              • set status(status): void

              • Set the status of the current spinner.

                -

                Parameters

                • status: undefined | string

                Returns void

              Methods

              pause

              • pause(fn, icon?): void

              • Pause the spinner on the console.

                -

                Parameters

                • fn: (() => unknown)
                    • (): unknown

                    • Returns unknown

                • Optionalicon: string

                Returns void

              start

              • start(action, status?, opts?): void

              • Start a spinner on the console.

                -

                Parameters

                • action: string
                • Optionalstatus: string
                • Optionalopts: {
                      stdout?: boolean;
                  }
                  • Optionalstdout?: boolean

                Returns void

              stop

              • stop(msg?): void

              • Stop the spinner on the console.

                -

                Parameters

                • Optionalmsg: string

                Returns void

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              Accessors
              Methods
              +

              Constructors

              constructor

              Properties

              ReadonlyoutputEnabled

              outputEnabled: boolean

              Accessors

              status

              • get status(): undefined | string

              • Get the status of the current spinner.

                +

                Returns undefined | string

              • set status(status): void

              • Set the status of the current spinner.

                +

                Parameters

                • status: undefined | string

                Returns void

              Methods

              pause

              • pause(fn, icon?): void

              • Pause the spinner on the console.

                +

                Parameters

                • fn: (() => unknown)
                    • (): unknown

                    • Returns unknown

                • Optionalicon: string

                Returns void

              start

              • start(action, status?, opts?): void

              • Start a spinner on the console.

                +

                Parameters

                • action: string
                • Optionalstatus: string
                • Optionalopts: {
                      stdout?: boolean;
                  }
                  • Optionalstdout?: boolean

                Returns void

              stop

              • stop(msg?): void

              • Stop the spinner on the console.

                +

                Parameters

                • Optionalmsg: string

                Returns void

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              Accessors
              Methods
              diff --git a/classes/ux_ux.Ux.html b/classes/ux_ux.Ux.html index 01d8be0f..47271cae 100644 --- a/classes/ux_ux.Ux.html +++ b/classes/ux_ux.Ux.html @@ -2,7 +2,7 @@

              Example

              import { SfCommand, Ux } from '@salesforce/sf-plugins-core';
              import { AnyJson } from '@salesforce/ts-types';

              class MyCommand extends SfCommand<AnyJson> {
                public async run(): Promise<AnyJson> {
                  const ux = new Ux(!this.jsonEnabled());
                }
              }
              -

              Hierarchy (view full)

              Constructors

              constructor +

              Hierarchy (view full)

              Constructors

              constructor

              Properties

              outputEnabled spinner

              Methods

              log @@ -13,24 +13,24 @@ table url warn -

              Constructors

              constructor

              • new Ux(__namedParameters?): Ux

              • Parameters

                • __namedParameters: {
                      jsonEnabled: boolean;
                  } = ...
                  • jsonEnabled: boolean

                Returns Ux

              Properties

              ReadonlyoutputEnabled

              outputEnabled: boolean

              Readonlyspinner

              spinner: Spinner

              Methods

              log

              • log(message?, ...args): void

              • Log a message to the console. This will be automatically suppressed if output is disabled.

                +

              Constructors

              constructor

              • new Ux(__namedParameters?): Ux

              • Parameters

                • __namedParameters: {
                      jsonEnabled: boolean;
                  } = ...
                  • jsonEnabled: boolean

                Returns Ux

              Properties

              ReadonlyoutputEnabled

              outputEnabled: boolean

              Readonlyspinner

              spinner: Spinner

              Methods

              log

              • log(message?, ...args): void

              • Log a message to the console. This will be automatically suppressed if output is disabled.

                Parameters

                • Optionalmessage: string

                  Message to log. Formatting is supported.

                • Rest...args: string[]

                  Args to be used for formatting.

                  -

                Returns void

              logToStderr

              • logToStderr(message?, ...args): void

              • Log a message to stderr. This will be automatically suppressed if output is disabled.

                +

              Returns void

              logToStderr

              • logToStderr(message?, ...args): void

              • Log a message to stderr. This will be automatically suppressed if output is disabled.

                Parameters

                • Optionalmessage: string

                  Message to log. Formatting is supported.

                • Rest...args: string[]

                  Args to be used for formatting.

                  -

                Returns void

              styledHeader

              • styledHeader(text): void

              • Display stylized header to the console. This will be automatically suppressed if output is disabled.

                +

              Returns void

              styledHeader

              • styledHeader(text): void

              • Display stylized header to the console. This will be automatically suppressed if output is disabled.

                Parameters

                • text: string

                  header to display

                  -

                Returns void

              styledJSON

              • styledJSON(obj, theme?): void

              • Display stylized JSON to the console. This will be automatically suppressed if output is disabled.

                +

              Returns void

              styledJSON

              • styledJSON(obj, theme?): void

              • Display stylized JSON to the console. This will be automatically suppressed if output is disabled.

                Parameters

                • obj: AnyJson

                  JSON to display

                  -
                • Optionaltheme: Record<string, string>

                Returns void

              styledObject

              • styledObject(obj, keys?): void

              • Display stylized object to the console. This will be automatically suppressed if output is disabled.

                +
              • Optionaltheme: Record<string, string>

              Returns void

              styledObject

              • styledObject(obj, keys?): void

              • Display stylized object to the console. This will be automatically suppressed if output is disabled.

                Parameters

                • obj: AnyJson

                  Object to display

                • Optionalkeys: string[]

                  Keys of object to display

                  -

                Returns void

              table

              • table<T>(options): void

              • Display a table to the console. This will be automatically suppressed if output is disabled.

                +

              Returns void

              table

              • table<T>(options): void

              • Display a table to the console. This will be automatically suppressed if output is disabled.

                Type Parameters

                • T extends Record<string, unknown>

                Parameters

                • options: TableOptions<T>

                  Table properties

                  -

                Returns void

              url

              • url(text, uri, params?): void

              • Display a url to the console. This will be automatically suppressed if output is disabled.

                +

              Returns void

              url

              • url(text, uri, params?): void

              • Display a url to the console. This will be automatically suppressed if output is disabled.

                Parameters

                • text: string

                  text to display

                • uri: string

                  URL link

                  -
                • params: {} = {}

                  Returns void

                warn

                • warn(message): void

                • Log a warning message to the console. This will be automatically suppressed if output is disabled.

                  +
                • params: {} = {}

                  Returns void

                  warn

                  • warn(message): void

                  • Log a warning message to the console. This will be automatically suppressed if output is disabled.

                    Parameters

                    • message: string | Error

                      Warning message to log.

                      -

                    Returns void

                  Settings

                  Member Visibility

                  On This Page

                  Constructors
                  Properties
                  Methods
                  +

                  Returns void

                  Settings

                  Member Visibility

                  On This Page

                  Constructors
                  Properties
                  Methods
                  diff --git a/functions/compatibility.arrayWithDeprecation.html b/functions/compatibility.arrayWithDeprecation.html index f82c138e..dbe4c908 100644 --- a/functions/compatibility.arrayWithDeprecation.html +++ b/functions/compatibility.arrayWithDeprecation.html @@ -1,2 +1,2 @@ arrayWithDeprecation | @salesforce/sf-plugins-core

                  Function arrayWithDeprecation

                  @deprecated. Use multiple: true with delimiter: ',' instead

                  -

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/functions/errorFormatting.formatError.html b/functions/errorFormatting.formatError.html index 997d23f7..943d69f8 100644 --- a/functions/errorFormatting.formatError.html +++ b/functions/errorFormatting.formatError.html @@ -1 +1 @@ -formatError | @salesforce/sf-plugins-core

                  Function formatError

                  Settings

                  Member Visibility
                  +formatError | @salesforce/sf-plugins-core

                  Function formatError

                  Settings

                  Member Visibility
                  diff --git a/functions/errorHandling.computeErrorCode.html b/functions/errorHandling.computeErrorCode.html index df2c3261..2f9d0caf 100644 --- a/functions/errorHandling.computeErrorCode.html +++ b/functions/errorHandling.computeErrorCode.html @@ -8,4 +8,4 @@
                • use the process exitCode
                • default to 1
                  • -

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/functions/errorHandling.errorIsGack.html b/functions/errorHandling.errorIsGack.html index 58e38c9d..b1a8d4e4 100644 --- a/functions/errorHandling.errorIsGack.html +++ b/functions/errorHandling.errorIsGack.html @@ -1,2 +1,2 @@ errorIsGack | @salesforce/sf-plugins-core

                  Function errorIsGack

                  identifies gacks via regex. Searches the error message, stack, and recursively checks the cause chain

                  -
                  • errorIsGack(error): boolean

                  • Parameters

                    • error: Error | SfError<AnyJson>

                    Returns boolean

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/functions/errorHandling.errorIsTypeError.html b/functions/errorHandling.errorIsTypeError.html index fa1a0752..30d1a4b9 100644 --- a/functions/errorHandling.errorIsTypeError.html +++ b/functions/errorHandling.errorIsTypeError.html @@ -1,2 +1,2 @@ errorIsTypeError | @salesforce/sf-plugins-core

                  Function errorIsTypeError

                  identifies TypeError. Searches the error message, stack, and recursively checks the cause chain

                  -
                  • errorIsTypeError(error): boolean

                  • Parameters

                    • error: Error | SfError<AnyJson>

                    Returns boolean

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/functions/flags_duration.durationFlag.html b/functions/flags_duration.durationFlag.html index 62cf7120..7aa4adf9 100644 --- a/functions/flags_duration.durationFlag.html +++ b/functions/flags_duration.durationFlag.html @@ -4,4 +4,4 @@

                  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'
                     }),
                  }
                  -

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/functions/flags_orgApiVersion.orgApiVersionFlag.html b/functions/flags_orgApiVersion.orgApiVersionFlag.html index bc3defb9..d1070396 100644 --- a/functions/flags_orgApiVersion.orgApiVersionFlag.html +++ b/functions/flags_orgApiVersion.orgApiVersionFlag.html @@ -6,4 +6,4 @@

                  Example

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

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/functions/flags_orgFlags.getHubOrThrow.html b/functions/flags_orgFlags.getHubOrThrow.html index 42d38c1b..b96b049c 100644 --- a/functions/flags_orgFlags.getHubOrThrow.html +++ b/functions/flags_orgFlags.getHubOrThrow.html @@ -1 +1 @@ -getHubOrThrow | @salesforce/sf-plugins-core

                  Function getHubOrThrow

                  • getHubOrThrow(aliasOrUsername?): Promise<Org>

                  • Parameters

                    • OptionalaliasOrUsername: string

                    Returns Promise<Org>

                  Settings

                  Member Visibility
                  +getHubOrThrow | @salesforce/sf-plugins-core

                  Function getHubOrThrow

                  • getHubOrThrow(aliasOrUsername?): Promise<Org>

                  • Parameters

                    • OptionalaliasOrUsername: string

                    Returns Promise<Org>

                  Settings

                  Member Visibility
                  diff --git a/functions/flags_orgFlags.getOrgOrThrow.html b/functions/flags_orgFlags.getOrgOrThrow.html index f024eedc..a38c1955 100644 --- a/functions/flags_orgFlags.getOrgOrThrow.html +++ b/functions/flags_orgFlags.getOrgOrThrow.html @@ -1 +1 @@ -getOrgOrThrow | @salesforce/sf-plugins-core

                  Function getOrgOrThrow

                  • getOrgOrThrow(input?): Promise<Org>

                  • Parameters

                    • Optionalinput: string

                    Returns Promise<Org>

                  Settings

                  Member Visibility
                  +getOrgOrThrow | @salesforce/sf-plugins-core

                  Function getOrgOrThrow

                  • getOrgOrThrow(input?): Promise<Org>

                  • Parameters

                    • Optionalinput: string

                    Returns Promise<Org>

                  Settings

                  Member Visibility
                  diff --git a/functions/flags_orgFlags.maybeGetHub.html b/functions/flags_orgFlags.maybeGetHub.html index 76805137..f6a54fbe 100644 --- a/functions/flags_orgFlags.maybeGetHub.html +++ b/functions/flags_orgFlags.maybeGetHub.html @@ -1 +1 @@ -maybeGetHub | @salesforce/sf-plugins-core

                  Function maybeGetHub

                  • maybeGetHub(input?): Promise<undefined | Org>

                  • Parameters

                    • Optionalinput: string

                    Returns Promise<undefined | Org>

                  Settings

                  Member Visibility
                  +maybeGetHub | @salesforce/sf-plugins-core

                  Function maybeGetHub

                  • maybeGetHub(input?): Promise<undefined | Org>

                  • Parameters

                    • Optionalinput: string

                    Returns Promise<undefined | Org>

                  Settings

                  Member Visibility
                  diff --git a/functions/flags_orgFlags.maybeGetOrg.html b/functions/flags_orgFlags.maybeGetOrg.html index 8fe501d5..7df51358 100644 --- a/functions/flags_orgFlags.maybeGetOrg.html +++ b/functions/flags_orgFlags.maybeGetOrg.html @@ -1 +1 @@ -maybeGetOrg | @salesforce/sf-plugins-core

                  Function maybeGetOrg

                  • maybeGetOrg(input): Promise<Org>

                  • Parameters

                    • input: string

                    Returns Promise<Org>

                  • maybeGetOrg(input): Promise<undefined>

                  • Parameters

                    • input: undefined

                    Returns Promise<undefined>

                  • maybeGetOrg(input?): Promise<Org | undefined>

                  • Parameters

                    • Optionalinput: string

                    Returns Promise<Org | undefined>

                  Settings

                  Member Visibility
                  +maybeGetOrg | @salesforce/sf-plugins-core

                  Function maybeGetOrg

                  • maybeGetOrg(input): Promise<Org>

                  • Parameters

                    • input: string

                    Returns Promise<Org>

                  • maybeGetOrg(input): Promise<undefined>

                  • Parameters

                    • input: undefined

                    Returns Promise<undefined>

                  • maybeGetOrg(input?): Promise<Org | undefined>

                  • Parameters

                    • Optionalinput: string

                    Returns Promise<Org | undefined>

                  Settings

                  Member Visibility
                  diff --git a/functions/flags_orgFlags.optionalHubFlag.html b/functions/flags_orgFlags.optionalHubFlag.html index ebf63588..e9f6f63f 100644 --- a/functions/flags_orgFlags.optionalHubFlag.html +++ b/functions/flags_orgFlags.optionalHubFlag.html @@ -5,4 +5,4 @@

                  Example

                  import { Flags } from '@salesforce/sf-plugins-core';
                  public static flags = {
                      // setting length or prefix
                     'target-org': optionalHubFlag(),
                     // adding properties
                     'flag2': optionalHubFlag({
                         description: 'flag2 description',
                         char: 'h'
                      }),
                  }
                  -

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/functions/flags_orgFlags.optionalOrgFlag.html b/functions/flags_orgFlags.optionalOrgFlag.html index 239839fd..38f0de09 100644 --- a/functions/flags_orgFlags.optionalOrgFlag.html +++ b/functions/flags_orgFlags.optionalOrgFlag.html @@ -4,4 +4,4 @@

                  Example

                  import { Flags } from '@salesforce/sf-plugins-core';
                  public static flags = {
                      // setting length or prefix
                     'target-org': Flags.optionalOrg(),
                     // adding properties
                     'flag2': Flags.optionalOrg({
                         required: true,
                         description: 'flag2 description',
                      }),
                  }
                  -

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/functions/flags_orgFlags.requiredHubFlag.html b/functions/flags_orgFlags.requiredHubFlag.html index bd6d67cd..09bb3beb 100644 --- a/functions/flags_orgFlags.requiredHubFlag.html +++ b/functions/flags_orgFlags.requiredHubFlag.html @@ -5,4 +5,4 @@

                  Example

                  import { Flags } from '@salesforce/sf-plugins-core';
                  public static flags = {
                      // setting length or prefix
                     'target-org': requiredHub(),
                     // adding properties
                     'flag2': requiredHub({
                         required: true,
                         description: 'flag2 description',
                         char: 'h'
                      }),
                  }
                  -

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/functions/flags_orgFlags.requiredOrgFlag.html b/functions/flags_orgFlags.requiredOrgFlag.html index c08d86e5..e25cd90c 100644 --- a/functions/flags_orgFlags.requiredOrgFlag.html +++ b/functions/flags_orgFlags.requiredOrgFlag.html @@ -5,4 +5,4 @@

                  Example

                  import { Flags } from '@salesforce/sf-plugins-core';
                  public static flags = {
                      // setting length or prefix
                     'target-org': Flags.requiredOrg(),
                     // adding properties
                     'flag2': Flags.requiredOrg({
                         required: true,
                         description: 'flag2 description',
                         char: 'o'
                      }),
                  }
                  -

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/functions/flags_salesforceId.salesforceIdFlag.html b/functions/flags_salesforceId.salesforceIdFlag.html index 69a10a41..e5b3a487 100644 --- a/functions/flags_salesforceId.salesforceIdFlag.html +++ b/functions/flags_salesforceId.salesforceIdFlag.html @@ -2,4 +2,4 @@

                  Example

                  import { Flags } from '@salesforce/sf-plugins-core';
                  public static flags = {
                      // set length or prefix
                     'flag-name': salesforceId({ length: 15, startsWith: '00D' }),
                     // add flag properties
                     'flag2': salesforceId({
                         required: true,
                         description: 'flag2 description',
                      }),
                     // override the character i
                     'flag3': salesforceId({
                         char: 'j',
                      }),
                  }
                  -

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/functions/stubUx.stubPrompter.html b/functions/stubUx.stubPrompter.html index 0c92f134..d255c493 100644 --- a/functions/stubUx.stubPrompter.html +++ b/functions/stubUx.stubPrompter.html @@ -2,4 +2,4 @@

                  Parameters

                  Returns {
                      confirm: SinonStub<[PromptInputs<boolean>], Promise<boolean>>;
                      secret: SinonStub<[PromptInputs<string>], Promise<string>>;
                  }

                  Example

                  import { stubPrompter } from '@salesforce/sf-plugins-core';
                  let prompterStubs: ReturnType<typeof stubPrompter>;

                  // inside your beforeEach, $$ is a SinonSandbox
                  prompterStubs = stubPrompter($$.SANDBOX);

                  // inside some test
                  expect(prompterStubs.confirm.firstCall.args[0]).to.equal(
                      messages.getMessage('confirmDelete', ['scratch', testOrg.username])
                    );
                  -

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/functions/stubUx.stubSfCommandUx.html b/functions/stubUx.stubSfCommandUx.html index 808e35de..6fae2a7a 100644 --- a/functions/stubUx.stubSfCommandUx.html +++ b/functions/stubUx.stubSfCommandUx.html @@ -3,4 +3,4 @@

                  Parameters

                  Returns {
                      info: SinonStub<[input: Info], void>;
                      log: SinonStub<[message?: string, ...args: any[]], void>;
                      logJson: SinonStub<[json: unknown], void>;
                      logSensitive: SinonStub<[msg?: string], void>;
                      logSuccess: SinonStub<[message: string], void>;
                      logToStderr: SinonStub<[message?: string, ...args: any[]], void>;
                      styledHeader: SinonStub<[text: string], void>;
                      styledJSON: SinonStub<[obj: AnyJson], void>;
                      styledObject: SinonStub<[obj: AnyJson], void>;
                      table: SinonStub<[options: TableOptions<Record<string, unknown>>], void>;
                      url: SinonStub<[text: string, uri: string, params: {}], void>;
                      warn: SinonStub<[input: Warning], Warning>;
                  }

                  Example

                  import { stubSfCommandUx } from '@salesforce/sf-plugins-core';
                  let stubSfCommandUxStubs: ReturnType<typeof stubSfCommandUx>;

                  // inside your beforeEach, $$ is a SinonSandbox
                  cmdStubs = stubSfCommandUx($$.SANDBOX);

                  // inside some test
                  expect(cmdStubs.warn.args.flat()).to.deep.include(`foo`);
                  -

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/functions/stubUx.stubSpinner.html b/functions/stubUx.stubSpinner.html index 5671603a..2886b7df 100644 --- a/functions/stubUx.stubSpinner.html +++ b/functions/stubUx.stubSpinner.html @@ -3,4 +3,4 @@

                  Parameters

                  Returns {
                      start: SinonStub<[action: string, status?: string, opts?: {
                          stdout?: boolean;
                      }], void>;
                      stop: SinonStub<[msg?: string], void>;
                  }

                  Example

                  import { stubSpinner } from '@salesforce/sf-plugins-core';
                  let spinnerStubs: ReturnType<typeof stubSpinner>;

                  // inside your beforeEach, $$ is a SinonSandbox
                  spinnerStubs = stubSpinner($$.SANDBOX);

                  // inside some test
                  expect(spinnerStubs.callCount).equals(1);
                  -

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/functions/stubUx.stubUx.html b/functions/stubUx.stubUx.html index d566e26b..300812c1 100644 --- a/functions/stubUx.stubUx.html +++ b/functions/stubUx.stubUx.html @@ -3,4 +3,4 @@

                  Parameters

                  Returns {
                      log: SinonStub<[message?: string, ...args: string[]], void>;
                      styledHeader: SinonStub<[text: string], void>;
                      styledJSON: SinonStub<[obj: AnyJson, theme?: Record<string, string>], void>;
                      styledObject: SinonStub<[obj: AnyJson, keys?: string[]], void>;
                      table: SinonStub<[options: TableOptions<Record<string, unknown>>], void>;
                      url: SinonStub<[text: string, uri: string, params: {}], void>;
                      warn: SinonStub<[message: string | Error], void>;
                  }

                  Example

                  import { stubUx } from '@salesforce/sf-plugins-core';
                  let stubUxStubs: ReturnType<typeof stubUx>;

                  // inside your beforeEach, $$ is a SinonSandbox
                  stubUxStubs = stubUx($$.SANDBOX);

                  // inside some test
                  expect(stubUxStubs.log.args.flat()).to.deep.include(`foo`);
                  -

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/functions/util.parseVarArgs.html b/functions/util.parseVarArgs.html index 70ba08be..5cfd59e8 100644 --- a/functions/util.parseVarArgs.html +++ b/functions/util.parseVarArgs.html @@ -1 +1 @@ -parseVarArgs | @salesforce/sf-plugins-core

                  Function parseVarArgs

                  • parseVarArgs(args, argv): Record<string, string | undefined>

                  • Parameters

                    • args: Record<string, unknown>
                    • argv: string[]

                    Returns Record<string, string | undefined>

                  Settings

                  Member Visibility
                  +parseVarArgs | @salesforce/sf-plugins-core

                  Function parseVarArgs

                  • parseVarArgs(args, argv): Record<string, string | undefined>

                  • Parameters

                    • args: Record<string, unknown>
                    • argv: string[]

                    Returns Record<string, string | undefined>

                  Settings

                  Member Visibility
                  diff --git a/functions/util.removeEmpty.html b/functions/util.removeEmpty.html index 0a9e11eb..546fd14d 100644 --- a/functions/util.removeEmpty.html +++ b/functions/util.removeEmpty.html @@ -1 +1 @@ -removeEmpty | @salesforce/sf-plugins-core

                  Function removeEmpty

                  • removeEmpty(obj): Record<string, unknown>

                  • Parameters

                    • obj: Record<string, unknown>

                    Returns Record<string, unknown>

                  Settings

                  Member Visibility
                  +removeEmpty | @salesforce/sf-plugins-core

                  Function removeEmpty

                  • removeEmpty(obj): Record<string, unknown>

                  • Parameters

                    • obj: Record<string, unknown>

                    Returns Record<string, unknown>

                  Settings

                  Member Visibility
                  diff --git a/functions/util.toHelpSection.html b/functions/util.toHelpSection.html index 4cad8453..fa5b3b20 100644 --- a/functions/util.toHelpSection.html +++ b/functions/util.toHelpSection.html @@ -2,4 +2,4 @@ Takes a string to be used as section header text and an array of enums that identify the variable or property to be included in the help body.

                  -

                  Parameters

                  Returns HelpSection

                  Settings

                  Member Visibility
                  +

                  Parameters

                  Returns HelpSection

                  Settings

                  Member Visibility
                  diff --git a/functions/ux_prompts.confirm.html b/functions/ux_prompts.confirm.html index 7463b024..52c8f54e 100644 --- a/functions/ux_prompts.confirm.html +++ b/functions/ux_prompts.confirm.html @@ -1 +1 @@ -confirm | @salesforce/sf-plugins-core

                  Function confirm

                  Settings

                  Member Visibility
                  +confirm | @salesforce/sf-plugins-core

                  Function confirm

                  Settings

                  Member Visibility
                  diff --git a/functions/ux_prompts.secretPrompt.html b/functions/ux_prompts.secretPrompt.html index 2f907baf..e06bf86e 100644 --- a/functions/ux_prompts.secretPrompt.html +++ b/functions/ux_prompts.secretPrompt.html @@ -1 +1 @@ -secretPrompt | @salesforce/sf-plugins-core

                  Function secretPrompt

                  Settings

                  Member Visibility
                  +secretPrompt | @salesforce/sf-plugins-core

                  Function secretPrompt

                  Settings

                  Member Visibility
                  diff --git a/functions/ux_styledObject.default.html b/functions/ux_styledObject.default.html index 497f9caf..0b98c6ea 100644 --- a/functions/ux_styledObject.default.html +++ b/functions/ux_styledObject.default.html @@ -1 +1 @@ -default | @salesforce/sf-plugins-core

                  Function default

                  Settings

                  Member Visibility
                  +default | @salesforce/sf-plugins-core

                  Function default

                  Settings

                  Member Visibility
                  diff --git a/functions/ux_table.convertToNewTableAPI.html b/functions/ux_table.convertToNewTableAPI.html index 39b9e34f..03bd2302 100644 --- a/functions/ux_table.convertToNewTableAPI.html +++ b/functions/ux_table.convertToNewTableAPI.html @@ -10,4 +10,4 @@
                • 'print-line'

                  • Type Parameters

                  Parameters

                  Returns TableOptions<Record<string, unknown>>

                  Deprecated

                  Please use the new table API directly.

                  -

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/modules/SfCommandError.html b/modules/SfCommandError.html index 82a1fc15..d21ce948 100644 --- a/modules/SfCommandError.html +++ b/modules/SfCommandError.html @@ -1,3 +1,3 @@ -SfCommandError | @salesforce/sf-plugins-core

                  Module SfCommandError

                  Index

                  Classes

                  SfCommandError +SfCommandError | @salesforce/sf-plugins-core

                  Module SfCommandError

                  Index

                  Classes

                  SfCommandError

                  Type Aliases

                  SfCommandErrorOptions

                  Settings

                  Member Visibility
                  diff --git a/modules/compatibility.html b/modules/compatibility.html index b76a7f53..bc984c15 100644 --- a/modules/compatibility.html +++ b/modules/compatibility.html @@ -1,4 +1,4 @@ -compatibility | @salesforce/sf-plugins-core

                  Module compatibility

                  Index

                  Type Aliases

                  ArrayWithDeprecationOptions +compatibility | @salesforce/sf-plugins-core

                  Module compatibility

                  Index

                  Type Aliases

                  ArrayWithDeprecationOptions

                  Variables

                  loglevel optionalHubFlagWithDeprecations optionalOrgFlagWithDeprecations diff --git a/modules/errorFormatting.html b/modules/errorFormatting.html index 73a64852..6ab82bf9 100644 --- a/modules/errorFormatting.html +++ b/modules/errorFormatting.html @@ -1,2 +1,2 @@ -errorFormatting | @salesforce/sf-plugins-core

                  Module errorFormatting

                  Index

                  Functions

                  formatError +errorFormatting | @salesforce/sf-plugins-core

                  Module errorFormatting

                  Index

                  Functions

                  formatError

                  Settings

                  Member Visibility
                  diff --git a/modules/errorHandling.html b/modules/errorHandling.html index 896254db..2c24f3e8 100644 --- a/modules/errorHandling.html +++ b/modules/errorHandling.html @@ -1,4 +1,4 @@ -errorHandling | @salesforce/sf-plugins-core

                  Module errorHandling

                  Index

                  Functions

                  computeErrorCode +errorHandling | @salesforce/sf-plugins-core

                  Module errorHandling

                  Index

                  Functions

                  computeErrorCode errorIsGack errorIsTypeError

                  Settings

                  Member Visibility
                  diff --git a/modules/exported.html b/modules/exported.html index 3c3ea6ff..2f6d6703 100644 --- a/modules/exported.html +++ b/modules/exported.html @@ -1,4 +1,4 @@ -exported | @salesforce/sf-plugins-core

                  Module exported

                  References

                  ArrayWithDeprecationOptions +exported | @salesforce/sf-plugins-core

                  Module exported

                  References

                  ArrayWithDeprecationOptions Flags Progress SfCommand diff --git a/modules/flags_duration.html b/modules/flags_duration.html index 8024469f..f4f80257 100644 --- a/modules/flags_duration.html +++ b/modules/flags_duration.html @@ -1,3 +1,3 @@ -flags/duration | @salesforce/sf-plugins-core

                  Module flags/duration

                  Index

                  Type Aliases

                  DurationFlagConfig +flags/duration | @salesforce/sf-plugins-core

                  Module flags/duration

                  Index

                  Type Aliases

                  DurationFlagConfig

                  Functions

                  durationFlag

                  Settings

                  Member Visibility
                  diff --git a/modules/flags_flags.html b/modules/flags_flags.html index ef565862..179e2b39 100644 --- a/modules/flags_flags.html +++ b/modules/flags_flags.html @@ -1,2 +1,2 @@ -flags/flags | @salesforce/sf-plugins-core

                  Module flags/flags

                  Index

                  Variables

                  Flags +flags/flags | @salesforce/sf-plugins-core

                  Module flags/flags

                  Index

                  Variables

                  Flags

                  Settings

                  Member Visibility
                  diff --git a/modules/flags_orgApiVersion.html b/modules/flags_orgApiVersion.html index d1a7de2b..34e77873 100644 --- a/modules/flags_orgApiVersion.html +++ b/modules/flags_orgApiVersion.html @@ -1,4 +1,4 @@ -flags/orgApiVersion | @salesforce/sf-plugins-core

                  Module flags/orgApiVersion

                  Index

                  Variables

                  maxDeprecated +flags/orgApiVersion | @salesforce/sf-plugins-core

                  Module flags/orgApiVersion

                  Index

                  Variables

                  maxDeprecated maxDeprecatedUrl minValidApiVersion

                  Functions

                  orgApiVersionFlag diff --git a/modules/flags_orgFlags.html b/modules/flags_orgFlags.html index 119739f4..ebcd98a4 100644 --- a/modules/flags_orgFlags.html +++ b/modules/flags_orgFlags.html @@ -1,4 +1,4 @@ -flags/orgFlags | @salesforce/sf-plugins-core

                  Module flags/orgFlags

                  Index

                  Functions

                  getHubOrThrow +flags/orgFlags | @salesforce/sf-plugins-core

                  Module flags/orgFlags

                  Index

                  Functions

                  getHubOrThrow getOrgOrThrow maybeGetHub maybeGetOrg diff --git a/modules/flags_salesforceId.html b/modules/flags_salesforceId.html index c3c096c9..582cc366 100644 --- a/modules/flags_salesforceId.html +++ b/modules/flags_salesforceId.html @@ -1,3 +1,3 @@ -flags/salesforceId | @salesforce/sf-plugins-core

                  Module flags/salesforceId

                  Index

                  Type Aliases

                  IdFlagConfig +flags/salesforceId | @salesforce/sf-plugins-core

                  Module flags/salesforceId

                  Index

                  Type Aliases

                  IdFlagConfig

                  Functions

                  salesforceIdFlag

                  Settings

                  Member Visibility
                  diff --git a/modules/sfCommand.SfCommand.html b/modules/sfCommand.SfCommand.html index 7ce08580..80edc7e5 100644 --- a/modules/sfCommand.SfCommand.html +++ b/modules/sfCommand.SfCommand.html @@ -1,4 +1,4 @@ -SfCommand | @salesforce/sf-plugins-core

                  Namespace SfCommand

                  Index

                  Type Aliases

                  Error +SfCommand | @salesforce/sf-plugins-core

                  Namespace SfCommand

                  Index

                  Type Aliases

                  Error Info Json Warning diff --git a/modules/sfCommand.html b/modules/sfCommand.html index eb8e95f8..f40e6abf 100644 --- a/modules/sfCommand.html +++ b/modules/sfCommand.html @@ -1,4 +1,4 @@ -sfCommand | @salesforce/sf-plugins-core

                  Module sfCommand

                  Index

                  Namespaces

                  SfCommand +sfCommand | @salesforce/sf-plugins-core

                  Module sfCommand

                  Index

                  Namespaces

                  SfCommand

                  Classes

                  SfCommand

                  Type Aliases

                  SfCommandInterface

                  Settings

                  Member Visibility
                  diff --git a/modules/stubUx.html b/modules/stubUx.html index 8e3c3cb5..391ca7fc 100644 --- a/modules/stubUx.html +++ b/modules/stubUx.html @@ -1,4 +1,4 @@ -stubUx | @salesforce/sf-plugins-core

                  Module stubUx

                  Index

                  Functions

                  stubPrompter +stubUx | @salesforce/sf-plugins-core

                  Module stubUx

                  Index

                  Functions

                  stubPrompter stubSfCommandUx stubSpinner stubUx diff --git a/modules/util.html b/modules/util.html index ee2f0790..59d3e27f 100644 --- a/modules/util.html +++ b/modules/util.html @@ -1,4 +1,4 @@ -util | @salesforce/sf-plugins-core

                  Module util

                  Index

                  Functions

                  parseVarArgs +util | @salesforce/sf-plugins-core

                  Module util

                  Index

                  Functions

                  parseVarArgs removeEmpty toHelpSection

                  Settings

                  Member Visibility
                  diff --git a/modules/ux_base.html b/modules/ux_base.html index 07c13028..f4cefb65 100644 --- a/modules/ux_base.html +++ b/modules/ux_base.html @@ -1,2 +1,2 @@ -ux/base | @salesforce/sf-plugins-core

                  Module ux/base

                  Index

                  Classes

                  UxBase +ux/base | @salesforce/sf-plugins-core

                  Module ux/base

                  Index

                  Classes

                  UxBase

                  Settings

                  Member Visibility
                  diff --git a/modules/ux_progress.Progress.html b/modules/ux_progress.Progress.html index e782523c..1109806c 100644 --- a/modules/ux_progress.Progress.html +++ b/modules/ux_progress.Progress.html @@ -1,4 +1,4 @@ -Progress | @salesforce/sf-plugins-core

                  Namespace Progress

                  Index

                  Type Aliases

                  Bar +Progress | @salesforce/sf-plugins-core

                  Namespace Progress

                  Index

                  Type Aliases

                  Bar Options Payload

                  Settings

                  Member Visibility
                  diff --git a/modules/ux_progress.html b/modules/ux_progress.html index f0074caf..0e432d41 100644 --- a/modules/ux_progress.html +++ b/modules/ux_progress.html @@ -1,3 +1,3 @@ -ux/progress | @salesforce/sf-plugins-core

                  Module ux/progress

                  Index

                  Namespaces

                  Progress +ux/progress | @salesforce/sf-plugins-core

                  Module ux/progress

                  Index

                  Namespaces

                  Progress

                  Classes

                  Progress

                  Settings

                  Member Visibility
                  diff --git a/modules/ux_prompts.html b/modules/ux_prompts.html index 4a145a89..95a326f3 100644 --- a/modules/ux_prompts.html +++ b/modules/ux_prompts.html @@ -1,4 +1,4 @@ -ux/prompts | @salesforce/sf-plugins-core

                  Module ux/prompts

                  Index

                  Type Aliases

                  PromptInputs +ux/prompts | @salesforce/sf-plugins-core

                  Module ux/prompts

                  Index

                  Type Aliases

                  PromptInputs

                  Variables

                  prompts

                  Functions

                  confirm secretPrompt diff --git a/modules/ux_spinner.html b/modules/ux_spinner.html index 1335c248..f3c043db 100644 --- a/modules/ux_spinner.html +++ b/modules/ux_spinner.html @@ -1,2 +1,2 @@ -ux/spinner | @salesforce/sf-plugins-core

                  Module ux/spinner

                  Index

                  Classes

                  Spinner +ux/spinner | @salesforce/sf-plugins-core

                  Module ux/spinner

                  Index

                  Classes

                  Spinner

                  Settings

                  Member Visibility
                  diff --git a/modules/ux_standardColors.html b/modules/ux_standardColors.html index 575fa10e..fd01187d 100644 --- a/modules/ux_standardColors.html +++ b/modules/ux_standardColors.html @@ -1,2 +1,2 @@ -ux/standardColors | @salesforce/sf-plugins-core

                  Module ux/standardColors

                  Index

                  Variables

                  StandardColors +ux/standardColors | @salesforce/sf-plugins-core

                  Module ux/standardColors

                  Index

                  Variables

                  StandardColors

                  Settings

                  Member Visibility
                  diff --git a/modules/ux_styledObject.html b/modules/ux_styledObject.html index 672afac3..b0054c3e 100644 --- a/modules/ux_styledObject.html +++ b/modules/ux_styledObject.html @@ -1,2 +1,2 @@ -ux/styledObject | @salesforce/sf-plugins-core

                  Module ux/styledObject

                  Index

                  Functions

                  default +ux/styledObject | @salesforce/sf-plugins-core

                  Module ux/styledObject

                  Index

                  Functions

                  default

                  Settings

                  Member Visibility
                  diff --git a/modules/ux_table.html b/modules/ux_table.html index 9ada27ed..5d7f1175 100644 --- a/modules/ux_table.html +++ b/modules/ux_table.html @@ -1,2 +1,2 @@ -ux/table | @salesforce/sf-plugins-core

                  Module ux/table

                  Index

                  Functions

                  convertToNewTableAPI +ux/table | @salesforce/sf-plugins-core

                  Module ux/table

                  Index

                  Functions

                  convertToNewTableAPI

                  Settings

                  Member Visibility
                  diff --git a/modules/ux_ux.html b/modules/ux_ux.html index a078a160..e642060b 100644 --- a/modules/ux_ux.html +++ b/modules/ux_ux.html @@ -1,2 +1,2 @@ -ux/ux | @salesforce/sf-plugins-core

                  Module ux/ux

                  Index

                  Classes

                  Ux +ux/ux | @salesforce/sf-plugins-core

                  Module ux/ux

                  Index

                  Classes

                  Ux

                  Settings

                  Member Visibility
                  diff --git a/types/SfCommandError.SfCommandErrorOptions.html b/types/SfCommandError.SfCommandErrorOptions.html index d4b1b16b..63223d2a 100644 --- a/types/SfCommandError.SfCommandErrorOptions.html +++ b/types/SfCommandError.SfCommandErrorOptions.html @@ -1 +1 @@ -SfCommandErrorOptions | @salesforce/sf-plugins-core

                  Type Alias SfCommandErrorOptions<T>

                  SfCommandErrorOptions<T>: {
                      actions?: string[];
                      cause?: unknown;
                      code: string;
                      commandName: string;
                      context?: string;
                      data?: T;
                      exitCode: number;
                      message: string;
                      name?: string;
                      result?: unknown;
                      warnings?: (StructuredMessage | string)[];
                  }

                  Type Parameters

                  • T extends ErrorDataProperties = ErrorDataProperties

                  Settings

                  Member Visibility
                  +SfCommandErrorOptions | @salesforce/sf-plugins-core

                  Type Alias SfCommandErrorOptions<T>

                  SfCommandErrorOptions<T>: {
                      actions?: string[];
                      cause?: unknown;
                      code: string;
                      commandName: string;
                      context?: string;
                      data?: T;
                      exitCode: number;
                      message: string;
                      name?: string;
                      result?: unknown;
                      warnings?: (StructuredMessage | string)[];
                  }

                  Type Parameters

                  • T extends ErrorDataProperties = ErrorDataProperties

                  Settings

                  Member Visibility
                  diff --git a/types/compatibility.ArrayWithDeprecationOptions.html b/types/compatibility.ArrayWithDeprecationOptions.html index 40e50d0a..127808e2 100644 --- a/types/compatibility.ArrayWithDeprecationOptions.html +++ b/types/compatibility.ArrayWithDeprecationOptions.html @@ -1 +1 @@ -ArrayWithDeprecationOptions | @salesforce/sf-plugins-core

                  Type Alias ArrayWithDeprecationOptions

                  ArrayWithDeprecationOptions: {
                      multiple?: true;
                      parse?: undefined;
                  }

                  Settings

                  Member Visibility
                  +ArrayWithDeprecationOptions | @salesforce/sf-plugins-core

                  Type Alias ArrayWithDeprecationOptions

                  ArrayWithDeprecationOptions: {
                      multiple?: true;
                      parse?: undefined;
                  }

                  Settings

                  Member Visibility
                  diff --git a/types/flags_duration.DurationFlagConfig.html b/types/flags_duration.DurationFlagConfig.html index dcc46c89..3886106a 100644 --- a/types/flags_duration.DurationFlagConfig.html +++ b/types/flags_duration.DurationFlagConfig.html @@ -1 +1 @@ -DurationFlagConfig | @salesforce/sf-plugins-core

                  Type Alias DurationFlagConfig

                  DurationFlagConfig: {
                      defaultValue?: number;
                      max?: number;
                      min?: number;
                      unit: Required<DurationUnit>;
                  }

                  Settings

                  Member Visibility
                  +DurationFlagConfig | @salesforce/sf-plugins-core

                  Type Alias DurationFlagConfig

                  DurationFlagConfig: {
                      defaultValue?: number;
                      max?: number;
                      min?: number;
                      unit: Required<DurationUnit>;
                  }

                  Settings

                  Member Visibility
                  diff --git a/types/flags_salesforceId.IdFlagConfig.html b/types/flags_salesforceId.IdFlagConfig.html index fdec6ba3..d1937c4a 100644 --- a/types/flags_salesforceId.IdFlagConfig.html +++ b/types/flags_salesforceId.IdFlagConfig.html @@ -1,3 +1,3 @@ IdFlagConfig | @salesforce/sf-plugins-core

                  Type Alias IdFlagConfig

                  IdFlagConfig: {
                      length?: 15 | 18 | "both";
                      startsWith?: string;
                  }

                  Type declaration

                  • Optionallength?: 15 | 18 | "both"

                    Can specify if the version must be 15 or 18 characters long or 'both'. Leave blank to allow either 15 or 18.

                  • OptionalstartsWith?: string

                    If the ID belongs to a certain sobject type, specify the 3 character prefix.

                    -

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/types/sfCommand.SfCommand.Error.html b/types/sfCommand.SfCommand.Error.html index 17e3bd89..2e5dbf9d 100644 --- a/types/sfCommand.SfCommand.Error.html +++ b/types/sfCommand.SfCommand.Error.html @@ -1 +1 @@ -Error | @salesforce/sf-plugins-core

                  Type Alias Error

                  Error: SfCommandError

                  Settings

                  Member Visibility
                  +Error | @salesforce/sf-plugins-core

                  Type Alias Error

                  Error: SfCommandError

                  Settings

                  Member Visibility
                  diff --git a/types/sfCommand.SfCommand.Info.html b/types/sfCommand.SfCommand.Info.html index f8d73eff..d29cdec3 100644 --- a/types/sfCommand.SfCommand.Info.html +++ b/types/sfCommand.SfCommand.Info.html @@ -1 +1 @@ -Info | @salesforce/sf-plugins-core

                  Type Alias Info

                  Info: StructuredMessage | string

                  Settings

                  Member Visibility
                  +Info | @salesforce/sf-plugins-core

                  Type Alias Info

                  Info: StructuredMessage | string

                  Settings

                  Member Visibility
                  diff --git a/types/sfCommand.SfCommand.Json.html b/types/sfCommand.SfCommand.Json.html index b974963c..51eb31ba 100644 --- a/types/sfCommand.SfCommand.Json.html +++ b/types/sfCommand.SfCommand.Json.html @@ -1 +1 @@ -Json | @salesforce/sf-plugins-core

                  Type Alias Json<T>

                  Json<T>: {
                      result: T;
                      status: number;
                      warnings?: Warning[];
                  }

                  Type Parameters

                  • T

                  Settings

                  Member Visibility
                  +Json | @salesforce/sf-plugins-core

                  Type Alias Json<T>

                  Json<T>: {
                      result: T;
                      status: number;
                      warnings?: Warning[];
                  }

                  Type Parameters

                  • T

                  Settings

                  Member Visibility
                  diff --git a/types/sfCommand.SfCommand.Warning.html b/types/sfCommand.SfCommand.Warning.html index 510fac36..e59c9eb7 100644 --- a/types/sfCommand.SfCommand.Warning.html +++ b/types/sfCommand.SfCommand.Warning.html @@ -1 +1 @@ -Warning | @salesforce/sf-plugins-core

                  Type Alias Warning

                  Warning: StructuredMessage | string

                  Settings

                  Member Visibility
                  +Warning | @salesforce/sf-plugins-core

                  Type Alias Warning

                  Warning: StructuredMessage | string

                  Settings

                  Member Visibility
                  diff --git a/types/sfCommand.SfCommandInterface.html b/types/sfCommand.SfCommandInterface.html index b3c18251..983eef46 100644 --- a/types/sfCommand.SfCommandInterface.html +++ b/types/sfCommand.SfCommandInterface.html @@ -1 +1 @@ -SfCommandInterface | @salesforce/sf-plugins-core

                  Type Alias SfCommandInterface

                  SfCommandInterface: {
                      configurationVariablesSection?: HelpSection;
                      envVariablesSection?: HelpSection;
                      errorCodes?: HelpSection;
                  } & Command.Class

                  Settings

                  Member Visibility
                  +SfCommandInterface | @salesforce/sf-plugins-core

                  Type Alias SfCommandInterface

                  SfCommandInterface: {
                      configurationVariablesSection?: HelpSection;
                      envVariablesSection?: HelpSection;
                      errorCodes?: HelpSection;
                  } & Command.Class

                  Settings

                  Member Visibility
                  diff --git a/types/ux_progress.Progress.Bar.html b/types/ux_progress.Progress.Bar.html index aeb904cc..8585f383 100644 --- a/types/ux_progress.Progress.Bar.html +++ b/types/ux_progress.Progress.Bar.html @@ -1 +1 @@ -Bar | @salesforce/sf-plugins-core

                  Type Alias Bar

                  Bar: {
                      setTotal: ((num: number) => void);
                      start: ((total: number, startValue: number, payload?: object) => void);
                      stop: (() => void);
                      update: ((num: number, payload?: object) => void);
                  }

                  Settings

                  Member Visibility
                  +Bar | @salesforce/sf-plugins-core

                  Type Alias Bar

                  Bar: {
                      setTotal: ((num: number) => void);
                      start: ((total: number, startValue: number, payload?: object) => void);
                      stop: (() => void);
                      update: ((num: number, payload?: object) => void);
                  }

                  Settings

                  Member Visibility
                  diff --git a/types/ux_progress.Progress.Options.html b/types/ux_progress.Progress.Options.html index cd5edc19..2ef83a43 100644 --- a/types/ux_progress.Progress.Options.html +++ b/types/ux_progress.Progress.Options.html @@ -1 +1 @@ -Options | @salesforce/sf-plugins-core

                  Type Alias Options

                  Options: {
                      barCompleteChar: string;
                      barIncompleteChar: string;
                      format: string;
                      linewrap: boolean;
                      noTTYOutput: boolean;
                      title: string;
                  }

                  Settings

                  Member Visibility
                  +Options | @salesforce/sf-plugins-core

                  Type Alias Options

                  Options: {
                      barCompleteChar: string;
                      barIncompleteChar: string;
                      format: string;
                      linewrap: boolean;
                      noTTYOutput: boolean;
                      title: string;
                  }

                  Settings

                  Member Visibility
                  diff --git a/types/ux_progress.Progress.Payload.html b/types/ux_progress.Progress.Payload.html index aa1c023e..99fc9ef5 100644 --- a/types/ux_progress.Progress.Payload.html +++ b/types/ux_progress.Progress.Payload.html @@ -1 +1 @@ -Payload | @salesforce/sf-plugins-core

                  Type Alias Payload

                  Payload: Record<string, unknown>

                  Settings

                  Member Visibility
                  +Payload | @salesforce/sf-plugins-core

                  Type Alias Payload

                  Payload: Record<string, unknown>

                  Settings

                  Member Visibility
                  diff --git a/types/ux_prompts.PromptInputs.html b/types/ux_prompts.PromptInputs.html index 3a191e7e..ee568c2d 100644 --- a/types/ux_prompts.PromptInputs.html +++ b/types/ux_prompts.PromptInputs.html @@ -1,4 +1,4 @@ PromptInputs | @salesforce/sf-plugins-core

                  Type Alias PromptInputs<T>

                  PromptInputs<T>: {
                      defaultAnswer?: T;
                      message: string;
                      ms?: number;
                  }

                  Type Parameters

                  • T

                  Type declaration

                  • OptionaldefaultAnswer?: T

                    default value to offer to the user. Will be used if the user does not respond within the timeout period.

                  • message: string

                    text to display. Do not include a question mark

                  • Optionalms?: number

                    after this many ms, the prompt will time out. If a default value is provided, the default will be used. Otherwise the prompt will throw an error

                    -

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/variables/compatibility.loglevel.html b/variables/compatibility.loglevel.html index 60af89e5..17345ade 100644 --- a/variables/compatibility.loglevel.html +++ b/variables/compatibility.loglevel.html @@ -1,4 +1,4 @@ loglevel | @salesforce/sf-plugins-core

                  Variable loglevelConst

                  loglevel: OptionFlag<undefined | string, CustomOptions> = ...

                  Use only for commands that maintain sfdx compatibility. Flag will be hidden and will show a warning if used. Flag does not set the loglevel

                  -

                  Deprecated

                  Settings

                  Member Visibility
                  +

                  Deprecated

                  Settings

                  Member Visibility
                  diff --git a/variables/compatibility.optionalHubFlagWithDeprecations.html b/variables/compatibility.optionalHubFlagWithDeprecations.html index c4d8629b..40f21401 100644 --- a/variables/compatibility.optionalHubFlagWithDeprecations.html +++ b/variables/compatibility.optionalHubFlagWithDeprecations.html @@ -1 +1 @@ -optionalHubFlagWithDeprecations | @salesforce/sf-plugins-core

                  Variable optionalHubFlagWithDeprecationsConst

                  optionalHubFlagWithDeprecations: OptionFlag<undefined | Org, CustomOptions> = ...

                  Deprecated

                  Settings

                  Member Visibility
                  +optionalHubFlagWithDeprecations | @salesforce/sf-plugins-core

                  Variable optionalHubFlagWithDeprecationsConst

                  optionalHubFlagWithDeprecations: OptionFlag<undefined | Org, CustomOptions> = ...

                  Deprecated

                  Settings

                  Member Visibility
                  diff --git a/variables/compatibility.optionalOrgFlagWithDeprecations.html b/variables/compatibility.optionalOrgFlagWithDeprecations.html index 35c3f3a3..08847cab 100644 --- a/variables/compatibility.optionalOrgFlagWithDeprecations.html +++ b/variables/compatibility.optionalOrgFlagWithDeprecations.html @@ -1 +1 @@ -optionalOrgFlagWithDeprecations | @salesforce/sf-plugins-core

                  Variable optionalOrgFlagWithDeprecationsConst

                  optionalOrgFlagWithDeprecations: OptionFlag<Org, CustomOptions> = ...

                  Deprecated

                  Settings

                  Member Visibility
                  +optionalOrgFlagWithDeprecations | @salesforce/sf-plugins-core

                  Variable optionalOrgFlagWithDeprecationsConst

                  optionalOrgFlagWithDeprecations: OptionFlag<Org, CustomOptions> = ...

                  Deprecated

                  Settings

                  Member Visibility
                  diff --git a/variables/compatibility.orgApiVersionFlagWithDeprecations.html b/variables/compatibility.orgApiVersionFlagWithDeprecations.html index 2fb19000..64766da6 100644 --- a/variables/compatibility.orgApiVersionFlagWithDeprecations.html +++ b/variables/compatibility.orgApiVersionFlagWithDeprecations.html @@ -3,4 +3,4 @@

                  Deprecated

                  Example

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

                  Settings

                  Member Visibility
                  +

                  Settings

                  Member Visibility
                  diff --git a/variables/compatibility.requiredHubFlagWithDeprecations.html b/variables/compatibility.requiredHubFlagWithDeprecations.html index 58617a9e..03977ec1 100644 --- a/variables/compatibility.requiredHubFlagWithDeprecations.html +++ b/variables/compatibility.requiredHubFlagWithDeprecations.html @@ -1 +1 @@ -requiredHubFlagWithDeprecations | @salesforce/sf-plugins-core

                  Variable requiredHubFlagWithDeprecationsConst

                  requiredHubFlagWithDeprecations: OptionFlag<Org, CustomOptions> = ...

                  Deprecated

                  Settings

                  Member Visibility
                  +requiredHubFlagWithDeprecations | @salesforce/sf-plugins-core

                  Variable requiredHubFlagWithDeprecationsConst

                  requiredHubFlagWithDeprecations: OptionFlag<Org, CustomOptions> = ...

                  Deprecated

                  Settings

                  Member Visibility
                  diff --git a/variables/compatibility.requiredOrgFlagWithDeprecations.html b/variables/compatibility.requiredOrgFlagWithDeprecations.html index f424d1ed..1d45176d 100644 --- a/variables/compatibility.requiredOrgFlagWithDeprecations.html +++ b/variables/compatibility.requiredOrgFlagWithDeprecations.html @@ -1 +1 @@ -requiredOrgFlagWithDeprecations | @salesforce/sf-plugins-core

                  Variable requiredOrgFlagWithDeprecationsConst

                  requiredOrgFlagWithDeprecations: OptionFlag<Org, CustomOptions> = ...

                  Deprecated

                  Settings

                  Member Visibility
                  +requiredOrgFlagWithDeprecations | @salesforce/sf-plugins-core

                  Variable requiredOrgFlagWithDeprecationsConst

                  requiredOrgFlagWithDeprecations: OptionFlag<Org, CustomOptions> = ...

                  Deprecated

                  Settings

                  Member Visibility
                  diff --git a/variables/flags_flags.Flags.html b/variables/flags_flags.Flags.html index 85ce86ea..af6289f9 100644 --- a/variables/flags_flags.Flags.html +++ b/variables/flags_flags.Flags.html @@ -11,4 +11,4 @@

                  Type Parameters

                  • T extends readonly string[]
                  • P extends CustomOptions

                  Parameters

                  • defaults: Partial<OptionFlag<ReadonlyElementOf<T>[], P>> & {} & ({} | {})

                  Returns FlagDefinition<typeof defaults.options[number], P, {}>

                  Example

                  export default class MyCommand extends Command {
                    static flags = {
                      name: Flags.option({
                        options: ['foo', 'bar'] as const,
                      })(),
                    }
                  }
                  -
                • <T, P>(defaults): FlagDefinition<typeof defaults.options[number], P, {}>

                • Type Parameters

                  • T extends readonly string[]
                  • P extends CustomOptions

                  Parameters

                  • defaults: Partial<OptionFlag<ReadonlyElementOf<T>, P>> & {} & ({} | {})

                  Returns FlagDefinition<typeof defaults.options[number], P, {}>

                • <T, P>(defaults): FlagDefinition<typeof defaults.options[number], P, {}>

                • Type Parameters

                  • T extends readonly string[]
                  • P extends CustomOptions

                  Parameters

                  • defaults: Partial<OptionFlag<ReadonlyElementOf<T>, P>> & {}

                  Returns FlagDefinition<typeof defaults.options[number], P, {}>

                • <T, P>(defaults): FlagDefinition<typeof defaults.options[number], P, {}>

                • Type Parameters

                  • T extends readonly string[]
                  • P extends CustomOptions

                  Parameters

                  • defaults: Partial<OptionFlag<ReadonlyElementOf<T>[], P>> & {}

                  Returns FlagDefinition<typeof defaults.options[number], P, {}>

                • optionalHub: FlagDefinition<Org, CustomOptions, {}>
                • optionalOrg: FlagDefinition<Org, CustomOptions, {}>
                • orgApiVersion: FlagDefinition<string, CustomOptions, {}>
                • requiredHub: FlagDefinition<Org, CustomOptions, {}>
                • requiredOrg: FlagDefinition<Org, CustomOptions, {}>
                • salesforceId: FlagDefinition<string, IdFlagConfig, {}>
                • string: FlagDefinition<string, CustomOptions, {}>
                • url: FlagDefinition<URL, CustomOptions, {}>

                  • Settings

                  Member Visibility
                  +
                • <T, P>(defaults): FlagDefinition<typeof defaults.options[number], P, {}>

                • Type Parameters

                  • T extends readonly string[]
                  • P extends CustomOptions

                  Parameters

                  • defaults: Partial<OptionFlag<ReadonlyElementOf<T>, P>> & {} & ({} | {})

                  Returns FlagDefinition<typeof defaults.options[number], P, {}>

                • <T, P>(defaults): FlagDefinition<typeof defaults.options[number], P, {}>

                • Type Parameters

                  • T extends readonly string[]
                  • P extends CustomOptions

                  Parameters

                  • defaults: Partial<OptionFlag<ReadonlyElementOf<T>, P>> & {}

                  Returns FlagDefinition<typeof defaults.options[number], P, {}>

                • <T, P>(defaults): FlagDefinition<typeof defaults.options[number], P, {}>

                • Type Parameters

                  • T extends readonly string[]
                  • P extends CustomOptions

                  Parameters

                  • defaults: Partial<OptionFlag<ReadonlyElementOf<T>[], P>> & {}

                  Returns FlagDefinition<typeof defaults.options[number], P, {}>

                • optionalHub: FlagDefinition<Org, CustomOptions, {}>
                • optionalOrg: FlagDefinition<Org, CustomOptions, {}>
                • orgApiVersion: FlagDefinition<string, CustomOptions, {}>
                • requiredHub: FlagDefinition<Org, CustomOptions, {}>
                • requiredOrg: FlagDefinition<Org, CustomOptions, {}>
                • salesforceId: FlagDefinition<string, IdFlagConfig, {}>
                • string: FlagDefinition<string, CustomOptions, {}>
                • url: FlagDefinition<URL, CustomOptions, {}>

                  • Settings

                  Member Visibility
                  diff --git a/variables/flags_orgApiVersion.maxDeprecated.html b/variables/flags_orgApiVersion.maxDeprecated.html index fcde69ae..8de4a534 100644 --- a/variables/flags_orgApiVersion.maxDeprecated.html +++ b/variables/flags_orgApiVersion.maxDeprecated.html @@ -1 +1 @@ -maxDeprecated | @salesforce/sf-plugins-core

                  Variable maxDeprecatedConst

                  maxDeprecated: 30 = 30

                  Settings

                  Member Visibility
                  +maxDeprecated | @salesforce/sf-plugins-core

                  Variable maxDeprecatedConst

                  maxDeprecated: 30 = 30

                  Settings

                  Member Visibility
                  diff --git a/variables/flags_orgApiVersion.maxDeprecatedUrl.html b/variables/flags_orgApiVersion.maxDeprecatedUrl.html index f6fc8cf8..b64360ce 100644 --- a/variables/flags_orgApiVersion.maxDeprecatedUrl.html +++ b/variables/flags_orgApiVersion.maxDeprecatedUrl.html @@ -1 +1 @@ -maxDeprecatedUrl | @salesforce/sf-plugins-core

                  Variable maxDeprecatedUrlConst

                  maxDeprecatedUrl: "https://help.salesforce.com/s/articleView?id=000354473&type=1;" = 'https://help.salesforce.com/s/articleView?id=000354473&type=1;'

                  Settings

                  Member Visibility
                  +maxDeprecatedUrl | @salesforce/sf-plugins-core

                  Variable maxDeprecatedUrlConst

                  maxDeprecatedUrl: "https://help.salesforce.com/s/articleView?id=000354473&type=1;" = 'https://help.salesforce.com/s/articleView?id=000354473&type=1;'

                  Settings

                  Member Visibility
                  diff --git a/variables/flags_orgApiVersion.minValidApiVersion.html b/variables/flags_orgApiVersion.minValidApiVersion.html index e6dc3c14..6d538022 100644 --- a/variables/flags_orgApiVersion.minValidApiVersion.html +++ b/variables/flags_orgApiVersion.minValidApiVersion.html @@ -1 +1 @@ -minValidApiVersion | @salesforce/sf-plugins-core

                  Variable minValidApiVersionConst

                  minValidApiVersion: 21 = 21

                  Settings

                  Member Visibility
                  +minValidApiVersion | @salesforce/sf-plugins-core

                  Variable minValidApiVersionConst

                  minValidApiVersion: 21 = 21

                  Settings

                  Member Visibility
                  diff --git a/variables/ux_prompts.prompts.html b/variables/ux_prompts.prompts.html index 2b95e554..60d551cf 100644 --- a/variables/ux_prompts.prompts.html +++ b/variables/ux_prompts.prompts.html @@ -1 +1 @@ -prompts | @salesforce/sf-plugins-core

                  Variable promptsConst

                  prompts: {
                      confirm: ((__namedParameters: PromptInputs<boolean>) => Promise<boolean>);
                      secretPrompt: ((__namedParameters: PromptInputs<string>) => Promise<string>);
                  } = ...

                  Settings

                  Member Visibility
                  +prompts | @salesforce/sf-plugins-core

                  Variable promptsConst

                  prompts: {
                      confirm: ((__namedParameters: PromptInputs<boolean>) => Promise<boolean>);
                      secretPrompt: ((__namedParameters: PromptInputs<string>) => Promise<string>);
                  } = ...

                  Settings

                  Member Visibility
                  diff --git a/variables/ux_standardColors.StandardColors.html b/variables/ux_standardColors.StandardColors.html index 36a63e7d..d60f4c1f 100644 --- a/variables/ux_standardColors.StandardColors.html +++ b/variables/ux_standardColors.StandardColors.html @@ -1 +1 @@ -StandardColors | @salesforce/sf-plugins-core

                  Variable StandardColorsConst

                  StandardColors: {
                      error: Ansis;
                      info: Ansis;
                      success: Ansis;
                      warning: Ansis;
                  } = ...

                  Settings

                  Member Visibility
                  +StandardColors | @salesforce/sf-plugins-core

                  Variable StandardColorsConst

                  StandardColors: {
                      error: Ansis;
                      info: Ansis;
                      success: Ansis;
                      warning: Ansis;
                  } = ...

                  Settings

                  Member Visibility