com.liferay.frontend.js.loader.modules.extender.npm

Interface JSPackage

All Superinterfaces:

JSBundleObject

public interface JSPackage
extends JSBundleObject

Represents an NPM package inside a JSBundle.

JSModules belong to a JSPackage and JSPackages belong to a JSBundle.

Method Summary

Modifier and Type	Method and Description
JSBundle	getJSBundle() Returns the NPM package's bundle.
java.util.Collection<JSModuleAlias>	getJSModuleAliases()
java.util.Collection<JSModule>	getJSModules() Returns the NPM modules contained inside the NPM package.
java.util.Collection<JSPackageDependency>	getJSPackageDependencies() Returns the dependencies (i.e., other NPM packages) declared by the NPM package.
JSPackageDependency	getJSPackageDependency(java.lang.String packageName) Returns the NPM package's dependency (i.e., another NPM package) with the package name.
java.lang.String	getMainModuleName() Returns the default module's name declared by the NPM package.
java.lang.String	getResolvedId()
java.net.URL	getResourceURL(java.lang.String location) Returns the resource's URL residing in the NPM package.
java.lang.String	getVersion() Returns the package's NPM version.

Methods inherited from interface com.liferay.frontend.js.loader.modules.extender.npm.JSBundleObject

getId, getName

Method Detail

getJSBundle

JSBundle getJSBundle()

Returns the NPM package's bundle.

Returns:

the NPM package's bundle

getJSModuleAliases

java.util.Collection<JSModuleAlias> getJSModuleAliases()

getJSModules

java.util.Collection<JSModule> getJSModules()

Returns the NPM modules contained inside the NPM package.

Returns:

the NPM modules

getJSPackageDependencies

java.util.Collection<JSPackageDependency> getJSPackageDependencies()

Returns the dependencies (i.e., other NPM packages) declared by the NPM package.

Returns:

the NPM package dependencies

getJSPackageDependency

JSPackageDependency getJSPackageDependency(java.lang.String packageName)

Returns the NPM package's dependency (i.e., another NPM package) with the package name.

Parameters:

packageName - the package name

Returns:

the package dependency or null if no dependency with the name exists

getMainModuleName

java.lang.String getMainModuleName()

Returns the default module's name declared by the NPM package.

Returns:

the default module's name

getResolvedId

java.lang.String getResolvedId()

getResourceURL

java.net.URL getResourceURL(java.lang.String location)

Returns the resource's URL residing in the NPM package.

Parameters:

location - the resource's path

Returns:

the resource's URL

getVersion

java.lang.String getVersion()

Returns the package's NPM version.

Returns:

the package's NPM version