Home Reference Source

Typedef

Static Public Summary
public	DevMiddlewareGetDirectory: string: function
public	DevMiddlewareGetFileSystem: Promise<FileSystem, Error>: function
public	MiddlewaresInformation: Object
public	ProjextWebpackBundleRunnerOptions: Object
public	ProjextWebpackOpenDevServerOptions: Object
public	ProjextWebpackRuntimeDefinitionsOptions: Object
public	Provider: Object
public	ProviderRegisterMethod(app: Jimple): function
public	TargetDevServerProxiedSettings: Object
public	TargetDevServerSSLSettings: Object
public	TargetDevServerSettings: Object
public	WebpackConfigurationParams: Object
public	WebpackConfigurationTargetOutput: Object
public	WebpackConfigurations: Object
public	WebpackConfigurationsByEnvironment: Object
public	WebpackPluginInfo: Object

Static Public

public DevMiddlewareGetDirectory: string: function source

Return:

The build directory of the target implementing the dev middleware.

public DevMiddlewareGetFileSystem: Promise<FileSystem, Error>: function source

Return:

Promise<FileSystem, Error>

The reason this is resolved on a promise is to avoid trying to accessing files before they are generated.

public MiddlewaresInformation: Object source

Properties:

Name	Type	Attribute	Description
middlewares	Array		A list of functions that when executed return a Node middleware.
getDirectory	DevMiddlewareGetDirectory		To access the target implementing the middleware build directory.
getFileSystem	DevMiddlewareGetFileSystem		To access the webpack dev middleware "virtual filesystem".

public ProjextWebpackBundleRunnerOptions: Object source

Properties:

Name	Type	Attribute	Description
entry	string	nullable: true	The name of the webpack entry to execute. If not specified will fallback to the first one on the list provided by webpack.
name	string	nullable: true	The "instance name", used to register the listeners on the webpack event hooks. Its default value is `projext-webpack-plugin-bundle-runner`.
logger	Logger	nullable: true	A custom logger to output the plugin's information messages.
inspect	NodeInspectorSettings	nullable: true	The custom settings for the Node Inspector.

public ProjextWebpackOpenDevServerOptions: Object source

Properties:

Name	Type	Attribute	Description
openBrowser	boolean		Whether or not to open the browser when the bundle is ready. Its default value is `true`.
name	string	nullable: true	The "instance name", used to register the listeners on the webpack event hooks. Its default value is `projext-webpack-plugin-open-dev-server`.
logger	Logger	nullable: true	A custom logger to output the plugin's information messages.

public ProjextWebpackRuntimeDefinitionsOptions: Object source

Properties:

Name	Type	Attribute	Description
name	string	nullable: true	The "instance name", used to register the listeners on the webpack event hooks. Its default value is `projext-webpack-plugin-runtime-definitions`.

public Provider: Object source

Properties:

Name	Type	Attribute	Description
register	ProviderRegisterMethod		The method that gets called when registering the provider.

public ProviderRegisterMethod(app: Jimple): function source

Params:

Name	Type	Attribute	Description
app	Jimple		A reference to the dependency injection container.

public TargetDevServerProxiedSettings: Object source

Properties:

Name	Type	Attribute	Description
enabled	boolean		Whether or not the dev server is being proxied.
host	string		The host used to proxy the dev server.
https	boolean		Whether or not the proxied host uses `https`.
url	string		The complete URL being used to proxy the dev server.

public TargetDevServerSSLSettings: Object source

Properties:

Name	Type	Attribute	Description
key	string		The path to the SSL key (`.key`).
cert	string		The path to the SSL certificate (`.crt`).
ca	string		The path to the SSL public file (`.pem`).

public TargetDevServerSettings: Object source

Properties:

Name	Type	Attribute	Description
port	number		The server port.
host	string		The dev server hostname.
url	string		The complete URL for the dev server.
reload	boolean		Whether or not to reload the server when the code changes.
ssl	TargetDevServerSSLSettings	nullable: true	The paths to the files to enable SSL on the dev server.
proxied	TargetDevServerProxiedSettings	optional nullable: true	When the dev server is being proxied (using `nginx` for example), there are certain functionalities, like hot module replacement and live reload, that need to be aware of this.

public WebpackConfigurationParams: Object source

Properties:

Name	Type	Attribute	Description
target	Target		The target information.
targetRules	TargetFileRules		The rules to find the different file types a target may use.
entry	Object		A dictionary with the `entry` setting for a webpack configuration, generated with the target information.
output	WebpackConfigurationTargetOutput		A dictionary with the filenames formats and paths of the different files the bundle can generate.
definitions	Function():Object		A function that generates a dictionary of variables that will be replaced on the bundled code.
buildType	string		The intended built type: `development` or `production`.
copy	Array		A list of TargetExtraFile with the information of files that need to be copied during the bundling process.
additionalWatch	Array		A list of additional paths webpack should watch for in order to restart the bundle.
analyze	boolean		Whether or not the target bundle should be analyzed.

public WebpackConfigurationTargetOutput: Object source

Properties:

Name	Type	Attribute	Description
js	string		The filename format and path for the bundle, on the distribution directory.
css	string		The filename format and path for the generated stylesheet, on the distribution directory.
images	string		The filename format and path for the images that are going to be copied to the distribution directory.
fonts	string		The filename format and path for the font files that are going to be copied to the distribution directory.

public WebpackConfigurations: Object source

Properties:

Name	Type	Attribute	Description
node	WebpackConfigurationsByEnvironment		The build types configurations for a Node target.
browser	WebpackConfigurationsByEnvironment		The build types configurations for a browser target.

public WebpackConfigurationsByEnvironment: Object source

Properties:

Name	Type	Attribute	Description
production	ConfigurationFile		The configuration service for a the target type production build.
development	ConfigurationFile		The configuration service for a the target type development build.

public WebpackPluginInfo: Object source

Properties:

Name	Type	Attribute	Description
name	string		The name of the plugin.
configuration	string		The path to the `webpack.config.js` file.
external	Array		The list of subpaths the plugin exposes and that should be handled as external dependencies, in order to avoid bundling them.