@heroku-cli/command

  • Version 11.3.2
  • Published
  • 85.6 kB
  • 12 dependencies
  • ISC license

Install

npm i @heroku-cli/command
yarn add @heroku-cli/command
pnpm add @heroku-cli/command

Overview

base class for Heroku CLI commands

Index

Variables

variable vars

const vars: Vars;

    Classes

    class APIClient

    class APIClient {}

      constructor

      constructor(config: Interfaces.Config, options?: IOptions);

        property auth

        auth: string;

          property authPromise

          authPromise?: Promise<HTTP<any>>;

            property config

            protected config: Interfaces.Config;

              property defaults

              readonly defaults: any;

                property http

                http: any;

                  property options

                  options: IOptions;

                    property particleboard

                    readonly particleboard: ParticleboardClient;

                      property preauthPromises

                      preauthPromises: { [k: string]: Promise<HTTP<any>> };

                        property twoFactorMutex

                        readonly twoFactorMutex: Mutex<string>;

                          method delete

                          delete: <T>(url: string, options?: APIClient.Options) => Promise<HTTP<T>>;

                            method get

                            get: <T>(url: string, options?: APIClient.Options) => Promise<HTTP<T>>;

                              method login

                              login: (opts?: Login.Options) => Promise<void>;

                                method logout

                                logout: () => Promise<void>;

                                  method patch

                                  patch: <T>(url: string, options?: APIClient.Options) => Promise<HTTP<T>>;

                                    method post

                                    post: <T>(url: string, options?: APIClient.Options) => Promise<HTTP<T>>;

                                      method preauth

                                      preauth: (app: string, factor: string) => Promise<HTTP<unknown>>;

                                        method put

                                        put: <T>(url: string, options?: APIClient.Options) => Promise<HTTP<T>>;

                                          method request

                                          request: <T>(url: string, options?: APIClient.Options) => Promise<HTTP<T>>;

                                            method stream

                                            stream: (url: string, options?: APIClient.Options) => Promise<HTTP<unknown>>;

                                              method twoFactorPrompt

                                              twoFactorPrompt: () => Promise<string>;

                                                class Command

                                                abstract class Command extends Base {}

                                                  property allowArbitraryFlags

                                                  allowArbitraryFlags: boolean;

                                                    property base

                                                    base: string;

                                                      property cli

                                                      readonly cli: any;

                                                        property heroku

                                                        readonly heroku: APIClient;

                                                          property legacyHerokuClient

                                                          readonly legacyHerokuClient: any;

                                                            property out

                                                            readonly out: any;

                                                              method parse

                                                              protected parse: <
                                                              F extends FlagOutput,
                                                              B extends FlagOutput,
                                                              A extends ArgOutput
                                                              >(
                                                              options?: Input<F, B, A>,
                                                              argv?: string[]
                                                              ) => Promise<ParserOutput<F, B, A>>;

                                                                Namespaces

                                                                namespace APIClient

                                                                namespace APIClient {}

                                                                  interface Options

                                                                  interface Options extends HTTPRequestOptions {}

                                                                    property retryAuth

                                                                    retryAuth?: boolean;

                                                                      namespace completions

                                                                      module 'lib/completions.d.ts' {}

                                                                        variable AppAddonCompletion

                                                                        const AppAddonCompletion: Completion;

                                                                          variable AppCompletion

                                                                          const AppCompletion: Completion;

                                                                            variable AppDynoCompletion

                                                                            const AppDynoCompletion: Completion;

                                                                              variable BuildpackCompletion

                                                                              const BuildpackCompletion: Completion;

                                                                                variable DynoSizeCompletion

                                                                                const DynoSizeCompletion: Completion;

                                                                                  variable FileCompletion

                                                                                  const FileCompletion: Completion;

                                                                                    variable oneDay

                                                                                    const oneDay: number;

                                                                                      variable PipelineCompletion

                                                                                      const PipelineCompletion: Completion;

                                                                                        variable ProcessTypeCompletion

                                                                                        const ProcessTypeCompletion: Completion;

                                                                                          variable RegionCompletion

                                                                                          const RegionCompletion: Completion;

                                                                                            variable RemoteCompletion

                                                                                            const RemoteCompletion: Completion;

                                                                                              variable RoleCompletion

                                                                                              const RoleCompletion: Completion;

                                                                                                variable ScopeCompletion

                                                                                                const ScopeCompletion: Completion;

                                                                                                  variable SpaceCompletion

                                                                                                  const SpaceCompletion: Completion;

                                                                                                    variable StackCompletion

                                                                                                    const StackCompletion: Completion;

                                                                                                      variable StageCompletion

                                                                                                      const StageCompletion: Completion;

                                                                                                        variable TeamCompletion

                                                                                                        const TeamCompletion: Completion;

                                                                                                          function herokuGet

                                                                                                          herokuGet: (
                                                                                                          resource: string,
                                                                                                          ctx: { config: Interfaces.Config }
                                                                                                          ) => Promise<string[]>;

                                                                                                            namespace flags

                                                                                                            module 'lib/flags/index.d.ts' {}

                                                                                                              variable app

                                                                                                              const app: any;

                                                                                                                variable org

                                                                                                                const org: any;

                                                                                                                  variable pipeline

                                                                                                                  const pipeline: any;

                                                                                                                    variable remote

                                                                                                                    const remote: any;

                                                                                                                      variable team

                                                                                                                      const team: any;

                                                                                                                        Package Files (10)

                                                                                                                        Dependencies (12)

                                                                                                                        Dev Dependencies (32)

                                                                                                                        Peer Dependencies (0)

                                                                                                                        No peer dependencies.

                                                                                                                        Badge

                                                                                                                        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                                        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@heroku-cli/command.

                                                                                                                        • Markdown
                                                                                                                          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@heroku-cli/command)
                                                                                                                        • HTML
                                                                                                                          <a href="https://www.jsdocs.io/package/@heroku-cli/command"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>