Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Config

Hierarchy

  • Config

Implements

Index

Constructors

constructor

Properties

_base

_base: string = _base

registers ts-node for reading typescript source (./src) instead of compiled js files (./lib) there are likely issues doing this any the tsconfig.json files are not compatible with others

arch

arch: ArchTypes

bin

bin: string

cacheDir

cacheDir: string

commandsDir

commandsDir: string | undefined

configDir

configDir: string

dataDir

dataDir: string

debug

debug: number = 0

dirname

dirname: string

Optional engine

engine: IEngine

errlog

errlog: string

home

home: string

hooks

hooks: object

Type declaration

  • [k: string]: string[]

name

name: string

npmRegistry

npmRegistry: string

pjson

pjson: any

platform

platform: PlatformTypes

pluginsModule

pluginsModule: string | undefined

root

root: string

shell

shell: string

tsconfig

tsconfig: TSConfig | undefined

userAgent

userAgent: string

version

version: string

windows

windows: boolean

Methods

Private _debug

  • _debug(): number

Private _hooks

  • _hooks(): Promise<object>

Private _libToSrcPath

  • _libToSrcPath(orig: string): Promise<string | undefined>
  • convert a path from the compiled ./lib files to the ./src typescript source this is for developing typescript plugins/CLIs if there is a tsconfig and the original sources exist, it attempts to require ts-

    Parameters

    • orig: string

    Returns Promise<string | undefined>

Private _shell

  • _shell(): string

Private _tsConfig

  • _tsConfig(): Promise<TSConfig | undefined>

Private dir

  • dir(category: "cache" | "data" | "config"): string
  • Parameters

    • category: "cache" | "data" | "config"

    Returns string

load

  • load(root: string, pjson: readPkg.Package, baseConfig?: IConfig): Promise<this>
  • Parameters

    • root: string
    • pjson: readPkg.Package
    • Optional baseConfig: IConfig

    Returns Promise<this>

Private macosCacheDir

  • macosCacheDir(): string | undefined

scopedEnvVar

  • scopedEnvVar(k: string): undefined | string
  • Parameters

    • k: string

    Returns undefined | string

scopedEnvVarKey

  • scopedEnvVarKey(k: string): string

scopedEnvVarTrue

  • scopedEnvVarTrue(k: string): boolean

Private windowsHome

  • windowsHome(): undefined | string

Private windowsHomedriveHome

  • windowsHomedriveHome(): undefined | string

Private windowsUserprofileHome

  • windowsUserprofileHome(): undefined | string

Generated using TypeDoc