File: /var/www/vhost/disk-apps/pwa.sports-crowd.com/node_modules/@oclif/core/lib/interfaces/config.d.ts
import { PJSON } from './pjson';
import { Hooks, Hook } from './hooks';
import { Command } from './command';
import { Plugin, Options } from './plugin';
import { Topic } from './topic';
export type LoadOptions = Options | string | Config | undefined;
export type PlatformTypes = 'darwin' | 'linux' | 'win32' | 'aix' | 'freebsd' | 'openbsd' | 'sunos' | 'wsl';
export type ArchTypes = 'arm' | 'arm64' | 'mips' | 'mipsel' | 'ppc' | 'ppc64' | 's390' | 's390x' | 'x32' | 'x64' | 'x86';
export interface Config {
name: string;
version: string;
channel: string;
pjson: PJSON.CLI;
root: string;
/**
* process.arch
*/
arch: ArchTypes;
/**
* bin name of CLI command
*/
bin: string;
/**
* cache directory to use for CLI
*
* example ~/Library/Caches/mycli or ~/.cache/mycli
*/
cacheDir: string;
/**
* config directory to use for CLI
*
* example: ~/.config/mycli
*/
configDir: string;
/**
* data directory to use for CLI
*
* example: ~/.local/share/mycli
*/
dataDir: string;
/**
* base dirname to use in cacheDir/configDir/dataDir
*/
dirname: string;
/**
* points to a file that should be appended to for error logs
*
* example: ~/Library/Caches/mycli/error.log
*/
errlog: string;
/**
* path to home directory
*
* example: /home/myuser
*/
home: string;
/**
* process.platform
*/
platform: PlatformTypes;
/**
* active shell
*/
shell: string;
/**
* user agent to use for http calls
*
* example: mycli/1.2.3 (darwin-x64) node-9.0.0
*/
userAgent: string;
/**
* if windows
*/
windows: boolean;
/**
* debugging level
*
* set by ${BIN}_DEBUG or DEBUG=$BIN
*/
debug: number;
/**
* npm registry to use for installing plugins
*/
npmRegistry?: string;
userPJSON?: PJSON.User;
plugins: Plugin[];
binPath?: string;
valid: boolean;
flexibleTaxonomy?: boolean;
topicSeparator: ':' | ' ';
readonly commands: Command.Loadable[];
readonly topics: Topic[];
readonly commandIDs: string[];
runCommand<T = unknown>(id: string, argv?: string[]): Promise<T>;
runCommand<T = unknown>(id: string, argv?: string[], cachedCommand?: Command.Loadable): Promise<T>;
runHook<T extends keyof Hooks>(event: T, opts: Hooks[T]['options'], timeout?: number): Promise<Hook.Result<Hooks[T]['return']>>;
getAllCommandIDs(): string[];
getAllCommands(): Command.Loadable[];
findCommand(id: string, opts: {
must: true;
}): Command.Loadable;
findCommand(id: string, opts?: {
must: boolean;
}): Command.Loadable | undefined;
findTopic(id: string, opts: {
must: true;
}): Topic;
findTopic(id: string, opts?: {
must: boolean;
}): Topic | undefined;
findMatches(id: string, argv: string[]): Command.Loadable[];
scopedEnvVar(key: string): string | undefined;
scopedEnvVarKey(key: string): string;
scopedEnvVarTrue(key: string): boolean;
s3Url(key: string): string;
s3Key(type: 'versioned' | 'unversioned', ext: '.tar.gz' | '.tar.xz', options?: Config.s3Key.Options): string;
s3Key(type: keyof PJSON.S3.Templates, options?: Config.s3Key.Options): string;
}
export declare namespace Config {
namespace s3Key {
interface Options {
platform?: PlatformTypes;
arch?: ArchTypes;
[key: string]: any;
}
}
}