Class: WpwWaitPlugin

new WpwWaitPlugin()

Since: 1.3.0
Source: plugins/wait.js, line 16

Extends

WpwPlugin

Members

(protected) _arr_

Utility shortcut to @spmhome/type-utils/array set of functions

Inherited From: WpwBase#_arr_
Source: core/base.js, line 180

(protected) _async_

Utility shortcut to @spmhome/cmn-utils/path set of functions

Inherited From: WpwBase#_async_
Source: core/base.js, line 122

(protected) _cmn_

Utility shortcut to @spmhome/cmn-utils/path set of functions

Inherited From: WpwBase#_cmn_
Source: core/base.js, line 128

(protected) _crypto_

Utility shortcut to @spmhome/type-utils/crypto set of functions

Inherited From: WpwBase#_crypto_
Source: core/base.js, line 186

(protected) _date_

Utility shortcut to @spmhome/type-utils/date set of functions

Inherited From: WpwBase#_date_
Source: core/base.js, line 192

(protected) _fs_

Utility shortcut to @spmhome/cmn-utils/fs set of functions

Inherited From: WpwBase#_fs_
Source: core/base.js, line 141

(protected) _io_

Utility shortcut to @spmhome/cmn-utils/io set of functions

Inherited From: WpwBase#_io_
Source: core/base.js, line 198

(protected) _json_

Utility shortcut to @spmhome/type-utils/json set of functions

Inherited From: WpwBase#_json_
Source: core/base.js, line 204

(protected) _mime_

Utility shortcut to @spmhome/type-utils/mime set of functions

Inherited From: WpwBase#_mime_
Source: core/base.js, line 210

(protected) _node_

Utility shortcut to @spmhome/cmn-utils/node set of functions

Inherited From: WpwBase#_node_
Source: core/base.js, line 147

(protected) _num_

Utility shortcut to @spmhome/type-utils/number set of functions

Inherited From: WpwBase#_num_
Source: core/base.js, line 216

(protected) _obj_

Utility shortcut to @spmhome/type-utils/object set of functions

Inherited From: WpwBase#_obj_
Source: core/base.js, line 222

(protected) _path_

Utility shortcut to @spmhome/cmn-utils/path set of functions

Inherited From: WpwBase#_path_
Source: core/base.js, line 135

(protected) _pms_

Utility shortcut to @spmhome/type-utils/promise set of functions

Inherited From: WpwBase#_pms_
Source: core/base.js, line 228

(protected) _rgx_

Utility shortcut to @spmhome/type-utils/regex set of functions

Inherited From: WpwBase#_rgx_
Source: core/base.js, line 234

(protected) _str_

Utility shortcut to @spmhome/type-utils/string set of functions

Inherited From: WpwBase#_str_
Source: core/base.js, line 240

(protected) _ts_

Utility shortcut to @spmhome/cmn-utils/ts set of functions

Inherited From: WpwBase#_ts_
Source: core/base.js, line 153

(protected) _types_

Utility shortcut to @spmhome/type-utils/type set of functions

Inherited From: WpwBase#_types_
Source: core/base.js, line 246

(protected) _ver_

Utility shortcut to @spmhome/cmn-utils/version set of functions

Inherited From: WpwBase#_ver_
Source: core/base.js, line 159

(protected) _www_

Utility shortcut to @spmhome/cmn-utils/fetch set of functions

Inherited From: WpwBase#_www_
Source: core/base.js, line 165

build :WpwBuild

Type:

WpwBuild

Inherited From: WpwModule#build
Source: core/module.js, line 35

buildOptions :WpwBuildOptionsPluginConfig.<"wait">

Type:

WpwBuildOptionsPluginConfig.<"wait">

Overrides: WpwPlugin#buildOptions
Source: plugins/wait.js, line 48

cacheMap :Record.<WpwBuildOptionsKey, WpwCache>

Type:

Record.<WpwBuildOptionsKey, WpwCache>

Inherited From: WpwModule#cacheMap
Source: core/module.js, line 31

compilation :WebpackCompilation

Type:

WebpackCompilation

Inherited From: WpwModule#compilation
Source: core/module.js, line 47

compiler :WebpackCompiler

Type:

WebpackCompiler

Inherited From: WpwModule#compiler
Source: core/module.js, line 43

(protected) create

Overrides: WpwPlugin#create
Source: plugins/wait.js, line 55

(protected) ctor

Inherited From: WpwPlugin#ctor
Source: plugins/base.js, line 79

(protected) disposables :Array.<IDisposable>

Type:

Array.<IDisposable>

Inherited From: WpwBase#disposables
Source: core/base.js, line 27

(protected) disposed :boolean

Type:

boolean

Inherited From: WpwBase#disposed
Source: core/base.js, line 22

global

Inherited From: WpwBase#global
Source: core/base.js, line 71

hookCurrent :string|undefined

Type:

string | undefined

Inherited From: WpwModule#hookCurrent
Source: core/module.js, line 56

hookMessages :Record.<string, {start: string, done: string, fail: string}>

Type:

Record.<string, {start: string, done: string, fail: string}>

Inherited From: WpwModule#hookMessages
Source: core/module.js, line 60

(readonly) initMsg :string

Type:

string

Inherited From: WpwPlugin#initMsg
Source: plugins/base.js, line 58

(protected) initialConfig :any

cloned initial configuration object prior to any runtime modifications

Type:

Inherited From: WpwBase#initialConfig
Source: core/base.js, line 33

(protected) name :string

module name

Type:

string

Inherited From: WpwBase#name
Source: core/base.js, line 39

onPluginEvent :SpmhEventEmitter

Type:

SpmhEventEmitter

Source: plugins/wait.js, line 27

(protected) slug :string

url/path friendly module name

Type:

string

Inherited From: WpwBase#slug
Source: core/base.js, line 45

(protected) spmh

Top level export of spmh shared library packages ...{ cls, type, util }...

Inherited From: WpwBase#spmh
Source: core/base.js, line 102

(protected) store :WpwCache

Type:

WpwCache

Inherited From: WpwModule#store
Source: core/module.js, line 52

subtype :WpwModuleSubType

Type:

WpwModuleSubType

Inherited From: WpwModule#subtype
Source: core/module.js, line 68

(protected) wpc

Inherited From: WpwPlugin#wpc
Source: plugins/base.js, line 84

Methods

addMessage(info, ifFirstopt) → {SpmhError}

Parameters:

Name	Type	Attributes	Description
`info`	Partial.<SpmhMessageInfo> \| SpmhError
`ifFirst`	boolean \| undefined	<optional>

Inherited From: WpwModule#addMessage
Source: core/module.js, line 254

Returns:

Type:: SpmhError

apply(compiler) → {void|SpmhError}

Main webpack plugin initialization handler, called by webpack runtime to initialize this plugin.

Parameters:

Name	Type	Description
`compiler`	WebpackCompiler

Inherited From: WpwPlugin#apply
Source: plugins/base.js, line 93

Returns:

Type:: void | SpmhError

emitEventToWaitingBuilds(hook, state)

Parameters:

Name	Type	Description
`hook`	"done" \| "failed" \| "shutdown"
`state`	"done" \| "failed"

Source: plugins/wait.js, line 133

(async) emitRawAsset(path, tag, emitPathopt, immutableopt, noStatCheckopt) → {Promise.<string>}

Parameters:

Name	Type	Attributes	Description
`path`	string		path to source asset
`tag`	string		assset stats tag
`emitPath`	string	<optional>	relative path emitted to dist, defaults to 'path' relative to ctx dir
`immutable`	boolean	<optional>
`noStatCheck`	boolean	<optional>

Inherited From: WpwPlugin#emitRawAsset
Source: plugins/base.js, line 175

Throws:

Error

Returns:

Type:: Promise.<string>

exec(command, program, asyncopt, optionsopt) → {WpwExecResultKind.}

Parameters:

Name	Type	Attributes
`command`	string
`program`	string
`async`	P	<optional>
`options`	WpwModuleExecOptions	<optional>

Inherited From: WpwModule#exec
Source: core/module.js, line 287

Returns:

Type:: WpwExecResultKind.

exec2(async, options) → {WpwExecResultKind.}

Parameters:

Name	Type	Description
`async`	P
`options`	WpwExecOptions

Inherited From: WpwModule#exec2
Source: core/module.js, line 306

Returns:

Type:: WpwExecResultKind.

(async) execScriptsAsync(defs, lPad) → {Promise.<({result: WpwExecResult, results: Array.<WpwExecResult>}|void)>}

All of the exec utility functions are executed in the context of a runtime build
instance, i.e.

All of the exec utility functions are executed in the context of a runtime build
instance, i.e. 'this' is of type InstanceType

Parameters:

Name	Type	Description
`defs`	WpwPluginConfigRunScripts \| WpwPluginConfigScript
`lPad`	string

Since: 1.6.0
Inherited From: WpwPlugin#execScriptsAsync
Source: plugins/base.js, line 247

Returns:

Type:: Promise.<({result: WpwExecResult, results: Array.<WpwExecResult>}|void)>

execScriptsSync(scriptDef, lPad) → {Object|void}

All of the exec utility functions are executed in the context of a runtime plugin
instance, i.e.

All of the exec utility functions are executed in the context of a runtime plugin
instance, i.e. 'this' is of type InstanceType<WpwPlugin|WpwTaskPlugin>

Parameters:

Name	Type	Default	Description
`scriptDef`	WpwPluginConfigRunScripts
`lPad`	string

Since: 1.6.0
Inherited From: WpwPlugin#execScriptsSync
Source: plugins/base.js, line 347

Returns:

Type:: Object | void

fileNameStrip(file, rmvExtopt) → {string}

Parameters:

Name	Type	Attributes	Description
`file`	string
`rmvExt`	boolean	<optional>	remove file extension

Inherited From: WpwPlugin#fileNameStrip
Source: plugins/base.js, line 385

Returns:

Type:: string

(protected) getErrorMessageCfg(message, codeopt, exceptionopt) → {WpwBaseMessageInfo}

Parameters:

Name	Type	Attributes
`message`	string
`code`	SpmhMessageCode \| null	<optional>
`exception`	SpmhError \| WebpackError \| Error \| undefined	<optional>

Inherited From: WpwModule#getErrorMessageCfg
Source: core/module.js, line 337

Returns:

Type:: WpwBaseMessageInfo

getStore(moduleKeyopt) → {WpwCache}

Parameters:

Name	Type	Attributes	Description
`moduleKey`	WpwBuildOptionsKey	<optional>

Inherited From: WpwModule#getStore
Source: core/module.js, line 356

Returns:

Type:: WpwCache

(abstract, protected) getVendorPlugin(_compiler, _applyFirstopt) → {WebpackPluginInstance|Array.<WebpackPluginInstanceOrUndef>}

Parameters:

Name	Type	Attributes	Description
`_compiler`	WebpackCompiler
`_applyFirst`	boolean	<optional>

Inherited From: WpwPlugin#getVendorPlugin
Source: plugins/base.js, line 417

Returns:

Type:: WebpackPluginInstance | Array.<WebpackPluginInstanceOrUndef>

hashLength() → {number}

Since: 1.10.1
Inherited From: WpwModule#hashLength
Source: core/module.js, line 423

Returns:

Type:: number

hookdone(msgopt, rtnopt) → {T}

Parameters:

Name	Type	Attributes	Description
`msg`	string \| number	<optional>
`rtn`	T	<optional>

Since: 1.11.0
Inherited From: WpwModule#hookdone
Source: core/module.js, line 436

Returns:

Type:: T

hookstart(msgopt, writePluginOptsopt) → {WpwLogger}

Parameters:

Name	Type	Attributes	Description
`msg`	string \| number	<optional>
`writePluginOpts`	boolean	<optional>

Since: 1.11.0
Inherited From: WpwModule#hookstart
Source: core/module.js, line 455

Returns:

Type:: WpwLogger

(protected) invalidHookConfig(hookName, hookType, configDsc) → {SpmhMessage}

Parameters:

Name	Type	Default
`hookName`	string
`hookType`	"compiler" \| "compilation"	compilation
`configDsc`	string	async/sync

Inherited From: WpwModule#invalidHookConfig
Source: core/module.js, line 480

Returns:

Type:: SpmhMessage

isAsyncHook(hook)

Parameters:

Name	Type	Description
`hook`	any

Inherited From: WpwModule#isAsyncHook
Source: core/module.js, line 494

(protected) isCompilationHook(hook)

Parameters:

Name	Type	Description
`hook`	any

Inherited From: WpwModule#isCompilationHook
Source: core/module.js, line 521

(protected) isOutputAsset(name, isEntryopt, chkDbgopt, chkExtopt, chkHashedopt, noCacheGrpopt) → {boolean}

Parameters:

Name	Type	Attributes	Description
`name`	string
`isEntry`	boolean	<optional>
`chkDbg`	boolean	<optional>
`chkExt`	boolean	<optional>	include file extension in comparisons, defaults to `false`
`chkHashed`	boolean	<optional>
`noCacheGrp`	boolean	<optional>

Inherited From: WpwPlugin#isOutputAsset
Source: plugins/base.js, line 430

Returns:

boolean

Type:: boolean

(protected) isSyncHook(hook, strictopt)

Parameters:

Name	Type	Attributes	Description
`hook`	any
`strict`	boolean	<optional>

Inherited From: WpwModule#isSyncHook
Source: core/module.js, line 508

(protected) isTapableHook(hook) → {boolean}

Parameters:

Name	Type	Description
`hook`	WpwWebpackCompilerHook \| WebpackCompilationHookName

Inherited From: WpwModule#isTapableHook
Source: core/module.js, line 535

Returns:

hook is WebpackHook

Type:: boolean

(protected) onApply(_compiler) → {WpwPluginTapOptions.<any, any, boolean>|undefined|void}

May be implemented by extending WpwPlugin if internal hooks are to be set up.

May be implemented by extending WpwPlugin if internal hooks are to be set up.
All plugins either (1) have internal hooks, (2) wrap a vendor plugin, or (3) both.

Parameters:

Name	Type	Description
`_compiler`	WebpackCompiler

Overrides: WpwPlugin#onApply
Source: plugins/wait.js, line 62

Returns:

Type:: WpwPluginTapOptions.<any, any, boolean> | undefined | void

outputAssetRegex(chkDbgopt, chkExtopt, chkHashedopt) → {RegExp}

Parameters:

Name	Type	Attributes
`chkDbg`	boolean	<optional>
`chkExt`	boolean	<optional>
`chkHashed`	boolean	<optional>

Inherited From: WpwPlugin#outputAssetRegex
Source: plugins/base.js, line 509

Returns:

Type:: RegExp

printAssetList(i, pPfx, paths, lPad) → {string}

Prints an array of paths as they are processed, including only a specific # of lines
as determined by the log level verbosity, e.g.

Prints an array of paths as they are processed, including only a specific # of lines
as determined by the log level verbosity, e.g. log level 2 will print only the first 8
assets fo,lowed by a generalized message "+ ... additional assets"

Parameters:

Name	Type	Description
`i`	number \| null	0-based index of current asset in the array parameter 'paths'
`pPfx`	string	asset path type / value prefix
`paths`	Array.<string>	array of abs paths indexed by parameter 'i'
`lPad`	string

Inherited From: WpwPlugin#printAssetList
Source: plugins/base.js, line 578

Returns:

Type:: string

(protected) tapCompilationHooks(optionsArray)

Parameters:

Name	Type	Description
`optionsArray`	Array.<WpwPluginCompilationTapOptionsPair.<any, any, boolean>>

Inherited From: WpwModule#tapCompilationHooks
Source: core/module.js, line 543

waitForBuildDone() → {Promise.<void>}

Source: plugins/wait.js, line 223

Returns:

Type:: Promise.<void>

new WpwWaitPlugin(options)

Parameters:

Name	Type	Description
`options`	WpwPluginOptions	Plugin options to be applied

Source: plugins/wait.js, line 45

Members

(protected) ErrorCode

Inherited From: WpwBase#ErrorCode
Source: core/base.js, line 85

(protected) InfoCode

Inherited From: WpwBase#InfoCode
Source: core/base.js, line 89

(protected) Msg

Inherited From: WpwBase#Msg
Source: core/base.js, line 77

(protected) MsgCode

Inherited From: WpwBase#MsgCode
Source: core/base.js, line 81

(protected) WarningCode

Inherited From: WpwBase#WarningCode
Source: core/base.js, line 93

(protected) _arr_

Utility shortcut to @spmhome/type-utils/array set of functions

Inherited From: WpwBase#_arr_
Source: core/base.js, line 180

(protected) _async_

Utility shortcut to @spmhome/cmn-utils/path set of functions

Inherited From: WpwBase#_async_
Source: core/base.js, line 122

(protected) _cmn_

Utility shortcut to @spmhome/cmn-utils/path set of functions

Inherited From: WpwBase#_cmn_
Source: core/base.js, line 128

(protected) _crypto_

Utility shortcut to @spmhome/type-utils/crypto set of functions

Inherited From: WpwBase#_crypto_
Source: core/base.js, line 186

(protected) _date_

Utility shortcut to @spmhome/type-utils/date set of functions

Inherited From: WpwBase#_date_
Source: core/base.js, line 192

(protected) _fs_

Utility shortcut to @spmhome/cmn-utils/fs set of functions

Inherited From: WpwBase#_fs_
Source: core/base.js, line 141

(protected) _io_

Utility shortcut to @spmhome/cmn-utils/io set of functions

Inherited From: WpwBase#_io_
Source: core/base.js, line 198

(protected) _json_

Utility shortcut to @spmhome/type-utils/json set of functions

Inherited From: WpwBase#_json_
Source: core/base.js, line 204

(protected) _mime_

Utility shortcut to @spmhome/type-utils/mime set of functions

Inherited From: WpwBase#_mime_
Source: core/base.js, line 210

(protected) _node_

Utility shortcut to @spmhome/cmn-utils/node set of functions

Inherited From: WpwBase#_node_
Source: core/base.js, line 147

(protected) _num_

Utility shortcut to @spmhome/type-utils/number set of functions

Inherited From: WpwBase#_num_
Source: core/base.js, line 216

(protected) _obj_

Utility shortcut to @spmhome/type-utils/object set of functions

Inherited From: WpwBase#_obj_
Source: core/base.js, line 222

(protected) _path_

Utility shortcut to @spmhome/cmn-utils/path set of functions

Inherited From: WpwBase#_path_
Source: core/base.js, line 135

(protected) _pms_

Utility shortcut to @spmhome/type-utils/promise set of functions

Inherited From: WpwBase#_pms_
Source: core/base.js, line 228

(protected) _rgx_

Utility shortcut to @spmhome/type-utils/regex set of functions

Inherited From: WpwBase#_rgx_
Source: core/base.js, line 234

(protected) _str_

Utility shortcut to @spmhome/type-utils/string set of functions

Inherited From: WpwBase#_str_
Source: core/base.js, line 240

(protected) _ts_

Utility shortcut to @spmhome/cmn-utils/ts set of functions

Inherited From: WpwBase#_ts_
Source: core/base.js, line 153

(protected) _types_

Utility shortcut to @spmhome/type-utils/type set of functions

Inherited From: WpwBase#_types_
Source: core/base.js, line 246

(protected) _ver_

Utility shortcut to @spmhome/cmn-utils/version set of functions

Inherited From: WpwBase#_ver_
Source: core/base.js, line 159

(protected) _www_

Utility shortcut to @spmhome/cmn-utils/fetch set of functions

Inherited From: WpwBase#_www_
Source: core/base.js, line 165

build :WpwBuild

Type:

WpwBuild

Inherited From: WpwModule#build
Source: core/module.js, line 35

buildOptions :WpwBuildOptionsPluginConfig.<"wait">

Type:

WpwBuildOptionsPluginConfig.<"wait">

Overrides: WpwPlugin#buildOptions
Source: plugins/wait.js, line 48

cacheMap :Record.<WpwBuildOptionsKey, WpwCache>

Type:

Record.<WpwBuildOptionsKey, WpwCache>

Inherited From: WpwModule#cacheMap
Source: core/module.js, line 31

compilation :WebpackCompilation

Type:

WebpackCompilation

Inherited From: WpwModule#compilation
Source: core/module.js, line 47

compiler :WebpackCompiler

Type:

WebpackCompiler

Inherited From: WpwModule#compiler
Source: core/module.js, line 43

(protected) create

Overrides: WpwPlugin#create
Source: plugins/wait.js, line 55

(protected) ctor

Inherited From: WpwPlugin#ctor
Source: plugins/base.js, line 79

(protected) disposables :Array.<IDisposable>

Type:

Array.<IDisposable>

Inherited From: WpwBase#disposables
Source: core/base.js, line 27

(protected) disposed :boolean

Type:

boolean

Inherited From: WpwBase#disposed
Source: core/base.js, line 22

global

Inherited From: WpwBase#global
Source: core/base.js, line 71

hookCurrent :string|undefined

Type:

string | undefined

Inherited From: WpwModule#hookCurrent
Source: core/module.js, line 56

hookMessages :Record.<string, {start: string, done: string, fail: string}>

Type:

Record.<string, {start: string, done: string, fail: string}>

Inherited From: WpwModule#hookMessages
Source: core/module.js, line 60

(readonly) initMsg :string

Type:

string

Inherited From: WpwPlugin#initMsg
Source: plugins/base.js, line 58

(protected) initialConfig :any

cloned initial configuration object prior to any runtime modifications

Type:

Inherited From: WpwBase#initialConfig
Source: core/base.js, line 33

(protected) name :string

module name

Type:

string

Inherited From: WpwBase#name
Source: core/base.js, line 39

onPluginEvent :SpmhEventEmitter

Type:

SpmhEventEmitter

Source: plugins/wait.js, line 27

(protected) slug :string

url/path friendly module name

Type:

string

Inherited From: WpwBase#slug
Source: core/base.js, line 45

(protected) spmh

Top level export of spmh shared library packages ...{ cls, type, util }...

Inherited From: WpwBase#spmh
Source: core/base.js, line 102

(protected) store :WpwCache

Type:

WpwCache

Inherited From: WpwModule#store
Source: core/module.js, line 52

subtype :WpwModuleSubType

Type:

WpwModuleSubType

Inherited From: WpwModule#subtype
Source: core/module.js, line 68

(protected) wpc

Inherited From: WpwPlugin#wpc
Source: plugins/base.js, line 84

Methods

addMessage(info, ifFirstopt) → {SpmhError}

Parameters:

Name	Type	Attributes	Description
`info`	Partial.<SpmhMessageInfo> \| SpmhError
`ifFirst`	boolean \| undefined	<optional>

Inherited From: WpwModule#addMessage
Source: core/module.js, line 254

Returns:

Type:: SpmhError

apply(compiler) → {void|SpmhError}

Main webpack plugin initialization handler, called by webpack runtime to initialize this plugin.

Parameters:

Name	Type	Description
`compiler`	WebpackCompiler

Inherited From: WpwPlugin#apply
Source: plugins/base.js, line 93

Returns:

Type:: void | SpmhError

emitEventToWaitingBuilds(hook, state)

Parameters:

Name	Type	Description
`hook`	"done" \| "failed" \| "shutdown"
`state`	"done" \| "failed"

Source: plugins/wait.js, line 133

(async) emitRawAsset(path, tag, emitPathopt, immutableopt, noStatCheckopt) → {Promise.<string>}

Parameters:

Name	Type	Attributes	Description
`path`	string		path to source asset
`tag`	string		assset stats tag
`emitPath`	string	<optional>	relative path emitted to dist, defaults to 'path' relative to ctx dir
`immutable`	boolean	<optional>
`noStatCheck`	boolean	<optional>

Inherited From: WpwPlugin#emitRawAsset
Source: plugins/base.js, line 175

Throws:

Error

Returns:

Type:: Promise.<string>

exec(command, program, asyncopt, optionsopt) → {WpwExecResultKind.}

Parameters:

Name	Type	Attributes
`command`	string
`program`	string
`async`	P	<optional>
`options`	WpwModuleExecOptions	<optional>

Inherited From: WpwModule#exec
Source: core/module.js, line 287

Returns:

Type:: WpwExecResultKind.

exec2(async, options) → {WpwExecResultKind.}

Parameters:

Name	Type	Description
`async`	P
`options`	WpwExecOptions

Inherited From: WpwModule#exec2
Source: core/module.js, line 306

Returns:

Type:: WpwExecResultKind.

(async) execScriptsAsync(defs, lPad) → {Promise.<({result: WpwExecResult, results: Array.<WpwExecResult>}|void)>}

All of the exec utility functions are executed in the context of a runtime build
instance, i.e.

All of the exec utility functions are executed in the context of a runtime build
instance, i.e. 'this' is of type InstanceType

Parameters:

Name	Type	Description
`defs`	WpwPluginConfigRunScripts \| WpwPluginConfigScript
`lPad`	string

Since: 1.6.0
Inherited From: WpwPlugin#execScriptsAsync
Source: plugins/base.js, line 247

Returns:

Type:: Promise.<({result: WpwExecResult, results: Array.<WpwExecResult>}|void)>

execScriptsSync(scriptDef, lPad) → {Object|void}

All of the exec utility functions are executed in the context of a runtime plugin
instance, i.e.

All of the exec utility functions are executed in the context of a runtime plugin
instance, i.e. 'this' is of type InstanceType<WpwPlugin|WpwTaskPlugin>

Parameters:

Name	Type	Default	Description
`scriptDef`	WpwPluginConfigRunScripts
`lPad`	string

Since: 1.6.0
Inherited From: WpwPlugin#execScriptsSync
Source: plugins/base.js, line 347

Returns:

Type:: Object | void

fileNameStrip(file, rmvExtopt) → {string}

Parameters:

Name	Type	Attributes	Description
`file`	string
`rmvExt`	boolean	<optional>	remove file extension

Inherited From: WpwPlugin#fileNameStrip
Source: plugins/base.js, line 385

Returns:

Type:: string

(protected) getErrorMessageCfg(message, codeopt, exceptionopt) → {WpwBaseMessageInfo}

Parameters:

Name	Type	Attributes
`message`	string
`code`	SpmhMessageCode \| null	<optional>
`exception`	SpmhError \| WebpackError \| Error \| undefined	<optional>

Inherited From: WpwModule#getErrorMessageCfg
Source: core/module.js, line 337

Returns:

Type:: WpwBaseMessageInfo

getStore(moduleKeyopt) → {WpwCache}

Parameters:

Name	Type	Attributes	Description
`moduleKey`	WpwBuildOptionsKey	<optional>

Inherited From: WpwModule#getStore
Source: core/module.js, line 356

Returns:

Type:: WpwCache

(abstract, protected) getVendorPlugin(_compiler, _applyFirstopt) → {WebpackPluginInstance|Array.<WebpackPluginInstanceOrUndef>}

Parameters:

Name	Type	Attributes	Description
`_compiler`	WebpackCompiler
`_applyFirst`	boolean	<optional>

Inherited From: WpwPlugin#getVendorPlugin
Source: plugins/base.js, line 417

Returns:

Type:: WebpackPluginInstance | Array.<WebpackPluginInstanceOrUndef>

hashLength() → {number}

Since: 1.10.1
Inherited From: WpwModule#hashLength
Source: core/module.js, line 423

Returns:

Type:: number

hookdone(msgopt, rtnopt) → {T}

Parameters:

Name	Type	Attributes	Description
`msg`	string \| number	<optional>
`rtn`	T	<optional>

Since: 1.11.0
Inherited From: WpwModule#hookdone
Source: core/module.js, line 436

Returns:

Type:: T

hookstart(msgopt, writePluginOptsopt) → {WpwLogger}

Parameters:

Name	Type	Attributes	Description
`msg`	string \| number	<optional>
`writePluginOpts`	boolean	<optional>

Since: 1.11.0
Inherited From: WpwModule#hookstart
Source: core/module.js, line 455

Returns:

Type:: WpwLogger

(protected) invalidHookConfig(hookName, hookType, configDsc) → {SpmhMessage}

Parameters:

Name	Type	Default
`hookName`	string
`hookType`	"compiler" \| "compilation"	compilation
`configDsc`	string	async/sync

Inherited From: WpwModule#invalidHookConfig
Source: core/module.js, line 480

Returns:

Type:: SpmhMessage

isAsyncHook(hook)

Parameters:

Name	Type	Description
`hook`	any

Inherited From: WpwModule#isAsyncHook
Source: core/module.js, line 494

(protected) isCompilationHook(hook)

Parameters:

Name	Type	Description
`hook`	any

Inherited From: WpwModule#isCompilationHook
Source: core/module.js, line 521

(protected) isOutputAsset(name, isEntryopt, chkDbgopt, chkExtopt, chkHashedopt, noCacheGrpopt) → {boolean}

Parameters:

Name	Type	Attributes	Description
`name`	string
`isEntry`	boolean	<optional>
`chkDbg`	boolean	<optional>
`chkExt`	boolean	<optional>	include file extension in comparisons, defaults to `false`
`chkHashed`	boolean	<optional>
`noCacheGrp`	boolean	<optional>

Inherited From: WpwPlugin#isOutputAsset
Source: plugins/base.js, line 430

Returns:

boolean

Type:: boolean

(protected) isSyncHook(hook, strictopt)

Parameters:

Name	Type	Attributes	Description
`hook`	any
`strict`	boolean	<optional>

Inherited From: WpwModule#isSyncHook
Source: core/module.js, line 508

(protected) isTapableHook(hook) → {boolean}

Parameters:

Name	Type	Description
`hook`	WpwWebpackCompilerHook \| WebpackCompilationHookName

Inherited From: WpwModule#isTapableHook
Source: core/module.js, line 535

Returns:

hook is WebpackHook

Type:: boolean

(protected) onApply(_compiler) → {WpwPluginTapOptions.<any, any, boolean>|undefined|void}

May be implemented by extending WpwPlugin if internal hooks are to be set up.

May be implemented by extending WpwPlugin if internal hooks are to be set up.
All plugins either (1) have internal hooks, (2) wrap a vendor plugin, or (3) both.

Parameters:

Name	Type	Description
`_compiler`	WebpackCompiler

Overrides: WpwPlugin#onApply
Source: plugins/wait.js, line 62

Returns:

Type:: WpwPluginTapOptions.<any, any, boolean> | undefined | void

outputAssetRegex(chkDbgopt, chkExtopt, chkHashedopt) → {RegExp}

Parameters:

Name	Type	Attributes
`chkDbg`	boolean	<optional>
`chkExt`	boolean	<optional>
`chkHashed`	boolean	<optional>

Inherited From: WpwPlugin#outputAssetRegex
Source: plugins/base.js, line 509

Returns:

Type:: RegExp

printAssetList(i, pPfx, paths, lPad) → {string}

Prints an array of paths as they are processed, including only a specific # of lines
as determined by the log level verbosity, e.g.

Parameters:

Name	Type	Description
`i`	number \| null	0-based index of current asset in the array parameter 'paths'
`pPfx`	string	asset path type / value prefix
`paths`	Array.<string>	array of abs paths indexed by parameter 'i'
`lPad`	string

Inherited From: WpwPlugin#printAssetList
Source: plugins/base.js, line 578

Returns:

Type:: string

(protected) tapCompilationHooks(optionsArray)

Parameters:

Name	Type	Description
`optionsArray`	Array.<WpwPluginCompilationTapOptionsPair.<any, any, boolean>>

Inherited From: WpwModule#tapCompilationHooks
Source: core/module.js, line 543

waitForBuildDone() → {Promise.<void>}

Source: plugins/wait.js, line 223

Returns:

Type:: Promise.<void>

new WpwWaitPlugin()

Extends

Members

(protected) ErrorCode

(protected) InfoCode

(protected) Msg

(protected) MsgCode

(protected) WarningCode

(protected) _arr_

(protected) _async_

(protected) _cmn_

(protected) _crypto_

(protected) _date_

(protected) _fs_

(protected) _io_

(protected) _json_

(protected) _mime_

(protected) _node_

(protected) _num_

(protected) _obj_

(protected) _path_

(protected) _pms_

(protected) _rgx_

(protected) _str_

(protected) _ts_

(protected) _types_

(protected) _ver_

(protected) _www_

build :WpwBuild

buildOptions :WpwBuildOptionsPluginConfig.<"wait">

cacheMap :Record.<WpwBuildOptionsKey, WpwCache>

compilation :WebpackCompilation

compiler :WebpackCompiler

(protected) create

(protected) ctor

(protected) disposables :Array.<IDisposable>

(protected) disposed :boolean

global

hookCurrent :string|undefined

hookMessages :Record.<string, {start: string, done: string, fail: string}>

(readonly) initMsg :string

(protected) initialConfig :any

(protected) name :string

onPluginEvent :SpmhEventEmitter

(protected) slug :string

(protected) spmh

(protected) store :WpwCache

subtype :WpwModuleSubType

(protected) wpc

Methods

addMessage(info, ifFirstopt) → {SpmhError}

apply(compiler) → {void|SpmhError}

emitEventToWaitingBuilds(hook, state)

(async) emitRawAsset(path, tag, emitPathopt, immutableopt, noStatCheckopt) → {Promise.<string>}

exec(command, program, asyncopt, optionsopt) → {WpwExecResultKind.<P>}

exec2(async, options) → {WpwExecResultKind.<P>}

(async) execScriptsAsync(defs, lPad) → {Promise.<({result: WpwExecResult, results: Array.<WpwExecResult>}|void)>}

execScriptsSync(scriptDef, lPad) → {Object|void}

fileNameStrip(file, rmvExtopt) → {string}

(protected) getErrorMessageCfg(message, codeopt, exceptionopt) → {WpwBaseMessageInfo}

getStore(moduleKeyopt) → {WpwCache}

(abstract, protected) getVendorPlugin(_compiler, _applyFirstopt) → {WebpackPluginInstance|Array.<WebpackPluginInstanceOrUndef>}

hashLength() → {number}

hookdone(msgopt, rtnopt) → {T}

hookstart(msgopt, writePluginOptsopt) → {WpwLogger}

(protected) invalidHookConfig(hookName, hookType, configDsc) → {SpmhMessage}

isAsyncHook(hook)

(protected) isCompilationHook(hook)

(protected) isOutputAsset(name, isEntryopt, chkDbgopt, chkExtopt, chkHashedopt, noCacheGrpopt) → {boolean}

(protected) isSyncHook(hook, strictopt)

(protected) isTapableHook(hook) → {boolean}

(protected) onApply(_compiler) → {WpwPluginTapOptions.<any, any, boolean>|undefined|void}

outputAssetRegex(chkDbgopt, chkExtopt, chkHashedopt) → {RegExp}

printAssetList(i, pPfx, paths, lPad) → {string}

(protected) tapCompilationHooks(optionsArray)

waitForBuildDone() → {Promise.<void>}

new WpwWaitPlugin(options)

Members

(protected) ErrorCode

(protected) InfoCode