Class WpPackage

Represents a WordPress package that can be installed and configured.

Hierarchy

Package
- WpPackage

Index

Constructors

Properties

destFolder packageType pkgInfo tempDir

Methods

cloneRepo downloadPackage execDownload getDestFolder getInfo install installWordPress setupWordPressConfig

Constructors

constructor

new WpPackage(pkgConfig, packageType, paths): WpPackage
Constructs a new instance of the class.
Parameters
- pkgConfig: WordpressPkg
  the configuration object
- packageType: string
  the type of package
- paths: WPMMpaths
  the object containing the paths
Returns WpPackage
Overrides Package.constructor
- Defined in WpPackage.ts:27

Properties

`Protected` destFolder

destFolder: string

the destination folder

`Protected` packageType

packageType: string

the package type

pkgInfo

pkgInfo: WordpressPkg

the package info

`Protected` tempDir

tempDir: string

the temporary directory

Methods

cloneRepo

cloneRepo(packageUrl): Promise<unknown>
Asynchronously clones a repository from a given URL to a specified directory.
Parameters
- packageUrl: string
  The URL of the repository to clone.
Returns Promise<unknown>
A promise that resolves to the path of the cloned package on success, or rejects with an error on failure.
Inherited from Package.cloneRepo
- Defined in Package.ts:103

downloadPackage

downloadPackage(packageUrl): Promise<void>
Downloads a package from a given URL and saves it to the target directory.
Parameters
- packageUrl: string
  The URL of the package to download.
Returns Promise<void>
A promise that resolves when the package is successfully downloaded and saved, or rejects with an error.
Inherited from Package.downloadPackage
- Defined in Package.ts:130

execDownload

execDownload(filename, downloadUrl): Promise<string>
Downloads a file from a given URL and extracts it to a specified destination.
Parameters
- filename: string
  The name of the file to be downloaded.
- downloadUrl: string
  The URL from which the file will be downloaded.
Returns Promise<string>
A promise that resolves when the file is downloaded and extracted successfully.
Inherited from Package.execDownload
- Defined in Package.ts:83

getDestFolder

getDestFolder(paths, packageType): string
Gets the destination folder based on the package type.
Parameters
- paths: WPMMpaths
  An array of paths.
- packageType: string
  The type of package ('plugin' or 'theme').
Returns string
The destination folder path.
Inherited from Package.getDestFolder
- Defined in Package.ts:67

getInfo

getInfo(): {
version: undefined | string;
}
This is a method that retrieves the version of the current package.

No parameters are needed for this method.

Returns {
version: undefined | string;
}
Returns an object with the version of the current package.
- version: undefined | string
Inherited from Package.getInfo
- Defined in Package.ts:53

install

install(): Promise<void>
Installs WordPress and sets up the WordPress configuration.

Returns Promise<void>
A Promise that resolves when the installation and configuration are complete.
Overrides Package.install
- Defined in WpPackage.ts:158

installWordPress

installWordPress(version?, language?): Promise<void>
Installs WordPress with the specified version and language.
Parameters
- version: undefined | string = 'latest'
  The version of WordPress to install.
- language: undefined | string = 'en_US'
  The language of WordPress to install.
Returns Promise<void>
- Defined in WpPackage.ts:42

setupWordPressConfig

setupWordPressConfig(): Promise<void>
Sets up the WordPress configuration by copying the sample config file, replacing the placeholder values with the actual configuration values, and saving the updated config file.

Returns Promise<void>
This function does not return anything.
- Defined in WpPackage.ts:89

Generated using TypeDoc