@heroku-cli/command
- Version 9.0.2
- Published
- 62.8 kB
- 10 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
Classes
Namespaces
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 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>;
Namespaces
namespace APIClient
namespace APIClient {}
namespace completions
module 'lib/completions.d.ts' {}
variable AppAddonCompletion
const AppAddonCompletion: Interfaces.Completion;
variable AppCompletion
const AppCompletion: Interfaces.Completion;
variable AppDynoCompletion
const AppDynoCompletion: Interfaces.Completion;
variable BuildpackCompletion
const BuildpackCompletion: Interfaces.Completion;
variable DynoSizeCompletion
const DynoSizeCompletion: Interfaces.Completion;
variable FileCompletion
const FileCompletion: Interfaces.Completion;
variable oneDay
const oneDay: number;
variable PipelineCompletion
const PipelineCompletion: Interfaces.Completion;
variable ProcessTypeCompletion
const ProcessTypeCompletion: Interfaces.Completion;
variable RegionCompletion
const RegionCompletion: Interfaces.Completion;
variable RemoteCompletion
const RemoteCompletion: Interfaces.Completion;
variable RoleCompletion
const RoleCompletion: Interfaces.Completion;
variable ScopeCompletion
const ScopeCompletion: Interfaces.Completion;
variable SpaceCompletion
const SpaceCompletion: Interfaces.Completion;
variable StackCompletion
const StackCompletion: Interfaces.Completion;
variable StageCompletion
const StageCompletion: Interfaces.Completion;
variable TeamCompletion
const TeamCompletion: Interfaces.Completion;
function herokuGet
herokuGet: ( resource: string, ctx: { config: Interfaces.Config }) => Promise<string[]>;
Package Files (10)
Dependencies (10)
Dev Dependencies (22)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto 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[](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>
- Updated .
Package analyzed in 4466 ms. - Missing or incorrect documentation? Open an issue for this package.