Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "config"

Index

Type aliases

GenericInstallConfig

GenericInstallConfig: object

Type declaration

  • cwd: string

    Working directory in which to run the package manager

  • prefer: SupportedPackageManagers | null

    Allows you to "force" package manager if available

  • stdio: StdioOption | StdioOption[]

    Passes to execa in which way the I/O should be passed

InstallConfig

Available options to modify the behavior of install and installSync

PackageManagerFlag

PackageManagerFlag: keyof PackageManagerFlagConfig

PackageManagerFlagConfig

PackageManagerFlagConfig: object

Type declaration

  • bundle: boolean

    Saves dependency as bundled dependency (only available for npm)

  • dev: boolean

    Installs the passed dependencies as dev dependencies

  • exact: boolean

    Uses the save exact functionality of pkg manager

  • noSave: boolean

    Does not write the dependency to package.json (only available for npm)

  • verbose: boolean

    Runs package manager in verbose mode

ProjectInstallConfig

ProjectInstallConfig: GenericInstallConfig & ProjectInstallFlagConfig & __type

ProjectInstallFlag

ProjectInstallFlag: keyof ProjectInstallFlagConfig

ProjectInstallFlagConfig

ProjectInstallFlagConfig: object

Type declaration

  • dryRun: boolean
  • verbose: boolean

Variables

Const ValidPackageFlags

ValidPackageFlags: Set<string> = new Set<string>(['dev','exact','noSave','bundle','verbose',])

Const ValidProjectInstallFlags

ValidProjectInstallFlags: Set<string> = new Set<string>(['dryRun', 'verbose'])

Object literals

Const defaultInstallConfig

defaultInstallConfig: object

Default options for install and installSync

bundle

bundle: false = false

Saves dependency as bundled dependency (only available for npm)

cwd

cwd: string = process.cwd()

Working directory in which to run the package manager

dev

dev: false = false

Installs the passed dependencies as dev dependencies

exact

exact: false = false

Uses the save exact functionality of pkg manager

global

global: false = false

Installs packages globally

noSave

noSave: false = false

Does not write the dependency to package.json (only available for npm)

prefer

prefer: null = null

Allows you to "force" package manager if available

stdio

stdio: "pipe" | "ignore" | "inherit" = 'pipe' as StdioOption

Passes to execa in which way the I/O should be passed

verbose

verbose: false = false

Runs package manager in verbose mode

Generated using TypeDoc