External module pkg-install

Index

Type aliases

InstallResult

Variables

access

Functions

Type aliases

InstallResult

InstallResult: ExecaReturns & object

Variables

Const access

access: __promisify__ = promisify(fsAccess)

Functions

getCurrentPackageManager

getCurrentPackageManager(): SupportedPackageManagers | null

- Defined in utils/package-manager-utils.ts:51
Returns SupportedPackageManagers | null

getPackageManager

getPackageManager(config: InstallConfig): Promise<SupportedPackageManagers>

- Defined in package-manager.ts:21
Parameters
- config: InstallConfig
Returns Promise<SupportedPackageManagers>

getPackageManagerFromLockfile

getPackageManagerFromLockfile(config: InstallConfig): Promise<SupportedPackageManagers | null>

- Defined in utils/package-manager-utils.ts:75
Parameters
- config: InstallConfig
Returns Promise<SupportedPackageManagers | null>

getPackageManagerFromLockfileSync

getPackageManagerFromLockfileSync(config: InstallConfig): SupportedPackageManagers | null

- Defined in utils/package-manager-utils.ts:100
Parameters
- config: InstallConfig
Returns SupportedPackageManagers | null

getPackageManagerSync

getPackageManagerSync(config: InstallConfig): SupportedPackageManagers

- Defined in package-manager.ts:53
Parameters
- config: InstallConfig
Returns SupportedPackageManagers

install

install(packages: Packages, options?: Partial<InstallConfig>): Promise<InstallResult>

- Defined in install.ts:30
Parameters
- packages: Packages
- Default value options: Partial<InstallConfig> = defaultInstallConfig
Returns Promise<InstallResult>

installSync

installSync(packages: PackageList, options?: Partial<InstallConfig>): InstallResult

- Defined in install.ts:62
Parameters
- packages: PackageList
- Default value options: Partial<InstallConfig> = defaultInstallConfig
Returns InstallResult

isManagerInstalled

isManagerInstalled(manager: SupportedPackageManagers): Promise<boolean>

- Defined in utils/package-manager-utils.ts:19
Parameters
- manager: SupportedPackageManagers
Returns Promise<boolean>

isManagerInstalledSync

isManagerInstalledSync(manager: SupportedPackageManagers): boolean

- Defined in utils/package-manager-utils.ts:33
Parameters
- manager: SupportedPackageManagers
Returns boolean

projectInstall

projectInstall(options?: Partial<InstallConfig>): Promise<ExecaReturns>

- Defined in install.ts:93
Parameters
- Default value options: Partial<InstallConfig> = defaultInstallConfig
Returns Promise<ExecaReturns>

projectInstallSync

projectInstallSync(options?: Partial<InstallConfig>): ExecaReturns

- Defined in install.ts:117
Parameters
- Default value options: Partial<InstallConfig> = defaultInstallConfig
Returns ExecaReturns

Generated using TypeDoc