Regenerate API docs; add Heft and module-minifier-plugin
This commit is contained in:
Родитель
56a3c57367
Коммит
94c75092b8
|
@ -1120,6 +1120,8 @@ api_nav:
|
|||
url: /pages/api/rush-lib.commonversionsconfiguration.filepath
|
||||
- title: getAllPreferredVersions
|
||||
url: /pages/api/rush-lib.commonversionsconfiguration.getallpreferredversions
|
||||
- title: getPreferredVersionsHash
|
||||
url: /pages/api/rush-lib.commonversionsconfiguration.getpreferredversionshash
|
||||
- title: implicitlyPreferredVersions
|
||||
url: /pages/api/rush-lib.commonversionsconfiguration.implicitlypreferredversions
|
||||
- title: loadFromFile
|
||||
|
@ -1282,8 +1284,23 @@ api_nav:
|
|||
url: /pages/api/rush-lib.pnpmoptionsconfiguration.resolutionstrategy
|
||||
- title: strictPeerDependencies
|
||||
url: /pages/api/rush-lib.pnpmoptionsconfiguration.strictpeerdependencies
|
||||
- title: useWorkspaces
|
||||
url: /pages/api/rush-lib.pnpmoptionsconfiguration.useworkspaces
|
||||
- title: PnpmStoreOptions
|
||||
url: /pages/api/rush-lib.pnpmstoreoptions
|
||||
- title: RepoStateFile
|
||||
url: /pages/api/rush-lib.repostatefile
|
||||
subitems:
|
||||
- title: filePath
|
||||
url: /pages/api/rush-lib.repostatefile.filepath
|
||||
- title: loadFromFile
|
||||
url: /pages/api/rush-lib.repostatefile.loadfromfile
|
||||
- title: pnpmShrinkwrapHash
|
||||
url: /pages/api/rush-lib.repostatefile.pnpmshrinkwraphash
|
||||
- title: preferredVersionsHash
|
||||
url: /pages/api/rush-lib.repostatefile.preferredversionshash
|
||||
- title: refreshState
|
||||
url: /pages/api/rush-lib.repostatefile.refreshstate
|
||||
- title: ResolutionStrategy
|
||||
url: /pages/api/rush-lib.resolutionstrategy
|
||||
- title: Rush
|
||||
|
@ -1306,6 +1323,8 @@ api_nav:
|
|||
url: /pages/api/rush-lib.rushconfiguration.changesfolder
|
||||
- title: committedShrinkwrapFilename
|
||||
url: /pages/api/rush-lib.rushconfiguration.committedshrinkwrapfilename
|
||||
- title: commonAutoinstallersFolder
|
||||
url: /pages/api/rush-lib.rushconfiguration.commonautoinstallersfolder
|
||||
- title: commonFolder
|
||||
url: /pages/api/rush-lib.rushconfiguration.commonfolder
|
||||
- title: commonRushConfigFolder
|
||||
|
@ -1340,6 +1359,10 @@ api_nav:
|
|||
url: /pages/api/rush-lib.rushconfiguration.getpnpmfilepath
|
||||
- title: getProjectByName
|
||||
url: /pages/api/rush-lib.rushconfiguration.getprojectbyname
|
||||
- title: getRepoState
|
||||
url: /pages/api/rush-lib.rushconfiguration.getrepostate
|
||||
- title: getRepoStateFilePath
|
||||
url: /pages/api/rush-lib.rushconfiguration.getrepostatefilepath
|
||||
- title: gitAllowedEmailRegExps
|
||||
url: /pages/api/rush-lib.rushconfiguration.gitallowedemailregexps
|
||||
- title: gitSampleEmail
|
||||
|
@ -1524,6 +1547,288 @@ api_nav:
|
|||
url: /pages/api/debug-certificate-manager.icertificate.pemcertificate
|
||||
- title: pemKey
|
||||
url: /pages/api/debug-certificate-manager.icertificate.pemkey
|
||||
- title: '@rushstack/heft'
|
||||
url: /pages/api/heft
|
||||
subitems:
|
||||
- title: ActionHooksBase
|
||||
url: /pages/api/heft.actionhooksbase
|
||||
subitems:
|
||||
- title: afterLoadActionConfiguration
|
||||
url: /pages/api/heft.actionhooksbase.afterloadactionconfiguration
|
||||
- title: loadActionConfiguration
|
||||
url: /pages/api/heft.actionhooksbase.loadactionconfiguration
|
||||
- title: overrideAction
|
||||
url: /pages/api/heft.actionhooksbase.overrideaction
|
||||
- title: BuildHooks
|
||||
url: /pages/api/heft.buildhooks
|
||||
subitems:
|
||||
- title: bundle
|
||||
url: /pages/api/heft.buildhooks.bundle
|
||||
- title: compile
|
||||
url: /pages/api/heft.buildhooks.compile
|
||||
- title: postBuild
|
||||
url: /pages/api/heft.buildhooks.postbuild
|
||||
- title: preCompile
|
||||
url: /pages/api/heft.buildhooks.precompile
|
||||
- title: BuildStageHooksBase
|
||||
url: /pages/api/heft.buildstagehooksbase
|
||||
subitems:
|
||||
- title: run
|
||||
url: /pages/api/heft.buildstagehooksbase.run
|
||||
- title: BundleStageHooks
|
||||
url: /pages/api/heft.bundlestagehooks
|
||||
subitems:
|
||||
- title: afterConfigureWebpack
|
||||
url: /pages/api/heft.bundlestagehooks.afterconfigurewebpack
|
||||
- title: configureWebpack
|
||||
url: /pages/api/heft.bundlestagehooks.configurewebpack
|
||||
- title: CleanHooks
|
||||
url: /pages/api/heft.cleanhooks
|
||||
subitems:
|
||||
- title: deletePath
|
||||
url: /pages/api/heft.cleanhooks.deletepath
|
||||
- title: CompileStageHooks
|
||||
url: /pages/api/heft.compilestagehooks
|
||||
subitems:
|
||||
- title: afterConfigureCopyStaticAssets
|
||||
url: /pages/api/heft.compilestagehooks.afterconfigurecopystaticassets
|
||||
- title: afterConfigureTypeScript
|
||||
url: /pages/api/heft.compilestagehooks.afterconfiguretypescript
|
||||
- title: configureCopyStaticAssets
|
||||
url: /pages/api/heft.compilestagehooks.configurecopystaticassets
|
||||
- title: configureTypeScript
|
||||
url: /pages/api/heft.compilestagehooks.configuretypescript
|
||||
- title: CopyFromCacheMode
|
||||
url: /pages/api/heft.copyfromcachemode
|
||||
- title: DevDeployHooks
|
||||
url: /pages/api/heft.devdeployhooks
|
||||
- title: HeftConfiguration
|
||||
url: /pages/api/heft.heftconfiguration
|
||||
subitems:
|
||||
- title: buildCacheFolder
|
||||
url: /pages/api/heft.heftconfiguration.buildcachefolder
|
||||
- title: buildFolder
|
||||
url: /pages/api/heft.heftconfiguration.buildfolder
|
||||
- title: compilerPackage
|
||||
url: /pages/api/heft.heftconfiguration.compilerpackage
|
||||
- title: heftPackageJson
|
||||
url: /pages/api/heft.heftconfiguration.heftpackagejson
|
||||
- title: projectHeftDataFolder
|
||||
url: /pages/api/heft.heftconfiguration.projectheftdatafolder
|
||||
- title: projectPackageJson
|
||||
url: /pages/api/heft.heftconfiguration.projectpackagejson
|
||||
- title: terminal
|
||||
url: /pages/api/heft.heftconfiguration.terminal
|
||||
- title: terminalProvider
|
||||
url: /pages/api/heft.heftconfiguration.terminalprovider
|
||||
- title: HeftSession
|
||||
url: /pages/api/heft.heftsession
|
||||
subitems:
|
||||
- title: debugMode
|
||||
url: /pages/api/heft.heftsession.debugmode
|
||||
- title: hooks
|
||||
url: /pages/api/heft.heftsession.hooks
|
||||
- title: IActionContext
|
||||
url: /pages/api/heft.iactioncontext
|
||||
subitems:
|
||||
- title: hooks
|
||||
url: /pages/api/heft.iactioncontext.hooks
|
||||
- title: properties
|
||||
url: /pages/api/heft.iactioncontext.properties
|
||||
- title: IBuildActionContext
|
||||
url: /pages/api/heft.ibuildactioncontext
|
||||
- title: IBuildActionProperties
|
||||
url: /pages/api/heft.ibuildactionproperties
|
||||
subitems:
|
||||
- title: cleanFlag
|
||||
url: /pages/api/heft.ibuildactionproperties.cleanflag
|
||||
- title: liteFlag
|
||||
url: /pages/api/heft.ibuildactionproperties.liteflag
|
||||
- title: locale
|
||||
url: /pages/api/heft.ibuildactionproperties.locale
|
||||
- title: maxOldSpaceSize
|
||||
url: /pages/api/heft.ibuildactionproperties.maxoldspacesize
|
||||
- title: noTest
|
||||
url: /pages/api/heft.ibuildactionproperties.notest
|
||||
- title: productionFlag
|
||||
url: /pages/api/heft.ibuildactionproperties.productionflag
|
||||
- title: verboseFlag
|
||||
url: /pages/api/heft.ibuildactionproperties.verboseflag
|
||||
- title: watchMode
|
||||
url: /pages/api/heft.ibuildactionproperties.watchmode
|
||||
- title: webpackStats
|
||||
url: /pages/api/heft.ibuildactionproperties.webpackstats
|
||||
- title: IBuildStage
|
||||
url: /pages/api/heft.ibuildstage
|
||||
subitems:
|
||||
- title: hooks
|
||||
url: /pages/api/heft.ibuildstage.hooks
|
||||
- title: properties
|
||||
url: /pages/api/heft.ibuildstage.properties
|
||||
- title: IBundleStage
|
||||
url: /pages/api/heft.ibundlestage
|
||||
- title: IBundleStageProperties
|
||||
url: /pages/api/heft.ibundlestageproperties
|
||||
subitems:
|
||||
- title: webpackConfigFilePath
|
||||
url: /pages/api/heft.ibundlestageproperties.webpackconfigfilepath
|
||||
- title: webpackConfiguration
|
||||
url: /pages/api/heft.ibundlestageproperties.webpackconfiguration
|
||||
- title: ICleanActionContext
|
||||
url: /pages/api/heft.icleanactioncontext
|
||||
- title: ICleanActionProperties
|
||||
url: /pages/api/heft.icleanactionproperties
|
||||
subitems:
|
||||
- title: deleteCache
|
||||
url: /pages/api/heft.icleanactionproperties.deletecache
|
||||
- title: pathsToDelete
|
||||
url: /pages/api/heft.icleanactionproperties.pathstodelete
|
||||
- title: ICompilerPackage
|
||||
url: /pages/api/heft.icompilerpackage
|
||||
subitems:
|
||||
- title: apiExtractorPackagePath
|
||||
url: /pages/api/heft.icompilerpackage.apiextractorpackagepath
|
||||
- title: eslintPackagePath
|
||||
url: /pages/api/heft.icompilerpackage.eslintpackagepath
|
||||
- title: tslintPackagePath
|
||||
url: /pages/api/heft.icompilerpackage.tslintpackagepath
|
||||
- title: typeScriptPackagePath
|
||||
url: /pages/api/heft.icompilerpackage.typescriptpackagepath
|
||||
- title: ICompileStage
|
||||
url: /pages/api/heft.icompilestage
|
||||
- title: ICompileStageProperties
|
||||
url: /pages/api/heft.icompilestageproperties
|
||||
subitems:
|
||||
- title: copyStaticAssetsConfiguration
|
||||
url: /pages/api/heft.icompilestageproperties.copystaticassetsconfiguration
|
||||
- title: typeScriptConfiguration
|
||||
url: /pages/api/heft.icompilestageproperties.typescriptconfiguration
|
||||
- title: ICopyStaticAssetsConfiguration
|
||||
url: /pages/api/heft.icopystaticassetsconfiguration
|
||||
subitems:
|
||||
- title: destinationFolderNames
|
||||
url: /pages/api/heft.icopystaticassetsconfiguration.destinationfoldernames
|
||||
- title: sourceFolderName
|
||||
url: /pages/api/heft.icopystaticassetsconfiguration.sourcefoldername
|
||||
- title: IDevDeployActionContext
|
||||
url: /pages/api/heft.idevdeployactioncontext
|
||||
- title: IDevDeployActionProperties
|
||||
url: /pages/api/heft.idevdeployactionproperties
|
||||
- title: IEmitModuleKind
|
||||
url: /pages/api/heft.iemitmodulekind
|
||||
- title: IEmitModuleKindBase
|
||||
url: /pages/api/heft.iemitmodulekindbase
|
||||
subitems:
|
||||
- title: moduleKind
|
||||
url: /pages/api/heft.iemitmodulekindbase.modulekind
|
||||
- title: outFolderPath
|
||||
url: /pages/api/heft.iemitmodulekindbase.outfolderpath
|
||||
- title: IHeftActionConfiguration
|
||||
url: /pages/api/heft.iheftactionconfiguration
|
||||
- title: IHeftActionConfigurationOptions
|
||||
url: /pages/api/heft.iheftactionconfigurationoptions
|
||||
subitems:
|
||||
- title: mergeArrays
|
||||
url: /pages/api/heft.iheftactionconfigurationoptions.mergearrays
|
||||
- title: IHeftPlugin
|
||||
url: /pages/api/heft.iheftplugin
|
||||
subitems:
|
||||
- title: apply
|
||||
url: /pages/api/heft.iheftplugin.apply
|
||||
- title: displayName
|
||||
url: /pages/api/heft.iheftplugin.displayname
|
||||
- title: IHeftSessionHooks
|
||||
url: /pages/api/heft.iheftsessionhooks
|
||||
subitems:
|
||||
- title: build
|
||||
url: /pages/api/heft.iheftsessionhooks.build
|
||||
- title: clean
|
||||
url: /pages/api/heft.iheftsessionhooks.clean
|
||||
- title: devDeploy
|
||||
url: /pages/api/heft.iheftsessionhooks.devdeploy
|
||||
- title: metricsCollector
|
||||
url: /pages/api/heft.iheftsessionhooks.metricscollector
|
||||
- title: start
|
||||
url: /pages/api/heft.iheftsessionhooks.start
|
||||
- title: test
|
||||
url: /pages/api/heft.iheftsessionhooks.test
|
||||
- title: IMetricsData
|
||||
url: /pages/api/heft.imetricsdata
|
||||
subitems:
|
||||
- title: command
|
||||
url: /pages/api/heft.imetricsdata.command
|
||||
- title: machineArch
|
||||
url: /pages/api/heft.imetricsdata.machinearch
|
||||
- title: machineCores
|
||||
url: /pages/api/heft.imetricsdata.machinecores
|
||||
- title: machineOs
|
||||
url: /pages/api/heft.imetricsdata.machineos
|
||||
- title: machineProcessor
|
||||
url: /pages/api/heft.imetricsdata.machineprocessor
|
||||
- title: machineTotalMemoryMB
|
||||
url: /pages/api/heft.imetricsdata.machinetotalmemorymb
|
||||
- title: taskTotalExecutionMs
|
||||
url: /pages/api/heft.imetricsdata.tasktotalexecutionms
|
||||
- title: IPostBuildStage
|
||||
url: /pages/api/heft.ipostbuildstage
|
||||
- title: IPreCompileStage
|
||||
url: /pages/api/heft.iprecompilestage
|
||||
- title: ISharedCopyStaticAssetsConfiguration
|
||||
url: /pages/api/heft.isharedcopystaticassetsconfiguration
|
||||
subitems:
|
||||
- title: excludeGlobs
|
||||
url: /pages/api/heft.isharedcopystaticassetsconfiguration.excludeglobs
|
||||
- title: fileExtensions
|
||||
url: /pages/api/heft.isharedcopystaticassetsconfiguration.fileextensions
|
||||
- title: includeGlobs
|
||||
url: /pages/api/heft.isharedcopystaticassetsconfiguration.includeglobs
|
||||
- title: ISharedTypeScriptConfiguration
|
||||
url: /pages/api/heft.isharedtypescriptconfiguration
|
||||
subitems:
|
||||
- title: additionalModuleKindsToEmit
|
||||
url: /pages/api/heft.isharedtypescriptconfiguration.additionalmodulekindstoemit
|
||||
- title: copyFromCacheMode
|
||||
url: /pages/api/heft.isharedtypescriptconfiguration.copyfromcachemode
|
||||
- title: maxWriteParallelism
|
||||
url: /pages/api/heft.isharedtypescriptconfiguration.maxwriteparallelism
|
||||
- title: IStartActionContext
|
||||
url: /pages/api/heft.istartactioncontext
|
||||
- title: IStartActionProperties
|
||||
url: /pages/api/heft.istartactionproperties
|
||||
- title: ITestActionContext
|
||||
url: /pages/api/heft.itestactioncontext
|
||||
- title: ITestActionProperties
|
||||
url: /pages/api/heft.itestactionproperties
|
||||
subitems:
|
||||
- title: productionFlag
|
||||
url: /pages/api/heft.itestactionproperties.productionflag
|
||||
- title: watchMode
|
||||
url: /pages/api/heft.itestactionproperties.watchmode
|
||||
- title: ITypeScriptConfiguration
|
||||
url: /pages/api/heft.itypescriptconfiguration
|
||||
subitems:
|
||||
- title: isLintingEnabled
|
||||
url: /pages/api/heft.itypescriptconfiguration.islintingenabled
|
||||
- title: tsconfigPaths
|
||||
url: /pages/api/heft.itypescriptconfiguration.tsconfigpaths
|
||||
- title: MetricsCollectorHooks
|
||||
url: /pages/api/heft.metricscollectorhooks
|
||||
subitems:
|
||||
- title: flush
|
||||
url: /pages/api/heft.metricscollectorhooks.flush
|
||||
- title: flushAndTeardown
|
||||
url: /pages/api/heft.metricscollectorhooks.flushandteardown
|
||||
- title: recordMetric
|
||||
url: /pages/api/heft.metricscollectorhooks.recordmetric
|
||||
- title: StartHooks
|
||||
url: /pages/api/heft.starthooks
|
||||
- title: TestHooks
|
||||
url: /pages/api/heft.testhooks
|
||||
subitems:
|
||||
- title: configureTest
|
||||
url: /pages/api/heft.testhooks.configuretest
|
||||
- title: run
|
||||
url: /pages/api/heft.testhooks.run
|
||||
- title: '@rushstack/localization-plugin'
|
||||
url: /pages/api/localization-plugin
|
||||
subitems:
|
||||
|
@ -1663,6 +1968,194 @@ api_nav:
|
|||
subitems:
|
||||
- title: (constructor)
|
||||
url: /pages/api/localization-plugin.typingsgenerator._constructor_
|
||||
- title: '@rushstack/module-minifier-plugin'
|
||||
url: /pages/api/module-minifier-plugin
|
||||
subitems:
|
||||
- title: CHUNK_MODULES_TOKEN
|
||||
url: /pages/api/module-minifier-plugin.chunk_modules_token
|
||||
- title: generateLicenseFileForAsset
|
||||
url: /pages/api/module-minifier-plugin.generatelicensefileforasset
|
||||
- title: IAssetInfo
|
||||
url: /pages/api/module-minifier-plugin.iassetinfo
|
||||
subitems:
|
||||
- title: chunk
|
||||
url: /pages/api/module-minifier-plugin.iassetinfo.chunk
|
||||
- title: extractedComments
|
||||
url: /pages/api/module-minifier-plugin.iassetinfo.extractedcomments
|
||||
- title: fileName
|
||||
url: /pages/api/module-minifier-plugin.iassetinfo.filename
|
||||
- title: modules
|
||||
url: /pages/api/module-minifier-plugin.iassetinfo.modules
|
||||
- title: source
|
||||
url: /pages/api/module-minifier-plugin.iassetinfo.source
|
||||
- title: IAssetMap
|
||||
url: /pages/api/module-minifier-plugin.iassetmap
|
||||
- title: IDehydratedAssets
|
||||
url: /pages/api/module-minifier-plugin.idehydratedassets
|
||||
subitems:
|
||||
- title: assets
|
||||
url: /pages/api/module-minifier-plugin.idehydratedassets.assets
|
||||
- title: modules
|
||||
url: /pages/api/module-minifier-plugin.idehydratedassets.modules
|
||||
- title: IDENTIFIER_LEADING_DIGITS
|
||||
url: /pages/api/module-minifier-plugin.identifier_leading_digits
|
||||
- title: IDENTIFIER_TRAILING_DIGITS
|
||||
url: /pages/api/module-minifier-plugin.identifier_trailing_digits
|
||||
- title: IExtendedModule
|
||||
url: /pages/api/module-minifier-plugin.iextendedmodule
|
||||
subitems:
|
||||
- title: id
|
||||
url: /pages/api/module-minifier-plugin.iextendedmodule.id
|
||||
- title: identifier
|
||||
url: /pages/api/module-minifier-plugin.iextendedmodule.identifier
|
||||
- title: readableIdentifier
|
||||
url: /pages/api/module-minifier-plugin.iextendedmodule.readableidentifier
|
||||
- title: resource
|
||||
url: /pages/api/module-minifier-plugin.iextendedmodule.resource
|
||||
- title: skipMinification
|
||||
url: /pages/api/module-minifier-plugin.iextendedmodule.skipminification
|
||||
- title: IModuleInfo
|
||||
url: /pages/api/module-minifier-plugin.imoduleinfo
|
||||
subitems:
|
||||
- title: extractedComments
|
||||
url: /pages/api/module-minifier-plugin.imoduleinfo.extractedcomments
|
||||
- title: module
|
||||
url: /pages/api/module-minifier-plugin.imoduleinfo.module
|
||||
- title: source
|
||||
url: /pages/api/module-minifier-plugin.imoduleinfo.source
|
||||
- title: IModuleMap
|
||||
url: /pages/api/module-minifier-plugin.imodulemap
|
||||
- title: IModuleMinificationCallback
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationcallback
|
||||
- title: IModuleMinificationErrorResult
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationerrorresult
|
||||
subitems:
|
||||
- title: code
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationerrorresult.code
|
||||
- title: error
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationerrorresult.error
|
||||
- title: extractedComments
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationerrorresult.extractedcomments
|
||||
- title: hash
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationerrorresult.hash
|
||||
- title: map
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationerrorresult.map
|
||||
- title: IModuleMinificationRequest
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationrequest
|
||||
subitems:
|
||||
- title: code
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationrequest.code
|
||||
- title: hash
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationrequest.hash
|
||||
- title: nameForMap
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationrequest.nameformap
|
||||
- title: IModuleMinificationResult
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationresult
|
||||
- title: IModuleMinificationSuccessResult
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationsuccessresult
|
||||
subitems:
|
||||
- title: code
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationsuccessresult.code
|
||||
- title: error
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationsuccessresult.error
|
||||
- title: extractedComments
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationsuccessresult.extractedcomments
|
||||
- title: hash
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationsuccessresult.hash
|
||||
- title: map
|
||||
url: /pages/api/module-minifier-plugin.imoduleminificationsuccessresult.map
|
||||
- title: IModuleMinifier
|
||||
url: /pages/api/module-minifier-plugin.imoduleminifier
|
||||
subitems:
|
||||
- title: minify
|
||||
url: /pages/api/module-minifier-plugin.imoduleminifier.minify
|
||||
- title: ref
|
||||
url: /pages/api/module-minifier-plugin.imoduleminifier.ref
|
||||
- title: IModuleMinifierFunction
|
||||
url: /pages/api/module-minifier-plugin.imoduleminifierfunction
|
||||
- title: IModuleMinifierPluginHooks
|
||||
url: /pages/api/module-minifier-plugin.imoduleminifierpluginhooks
|
||||
subitems:
|
||||
- title: finalModuleId
|
||||
url: /pages/api/module-minifier-plugin.imoduleminifierpluginhooks.finalmoduleid
|
||||
- title: postProcessCodeFragment
|
||||
url: /pages/api/module-minifier-plugin.imoduleminifierpluginhooks.postprocesscodefragment
|
||||
- title: rehydrateAssets
|
||||
url: /pages/api/module-minifier-plugin.imoduleminifierpluginhooks.rehydrateassets
|
||||
- title: IModuleMinifierPluginOptions
|
||||
url: /pages/api/module-minifier-plugin.imoduleminifierpluginoptions
|
||||
subitems:
|
||||
- title: minifier
|
||||
url: /pages/api/module-minifier-plugin.imoduleminifierpluginoptions.minifier
|
||||
- title: sourceMap
|
||||
url: /pages/api/module-minifier-plugin.imoduleminifierpluginoptions.sourcemap
|
||||
- title: usePortableModules
|
||||
url: /pages/api/module-minifier-plugin.imoduleminifierpluginoptions.useportablemodules
|
||||
- title: ISynchronousMinifierOptions
|
||||
url: /pages/api/module-minifier-plugin.isynchronousminifieroptions
|
||||
subitems:
|
||||
- title: terserOptions
|
||||
url: /pages/api/module-minifier-plugin.isynchronousminifieroptions.terseroptions
|
||||
- title: IWorkerPoolMinifierOptions
|
||||
url: /pages/api/module-minifier-plugin.iworkerpoolminifieroptions
|
||||
subitems:
|
||||
- title: maxThreads
|
||||
url: /pages/api/module-minifier-plugin.iworkerpoolminifieroptions.maxthreads
|
||||
- title: terserOptions
|
||||
url: /pages/api/module-minifier-plugin.iworkerpoolminifieroptions.terseroptions
|
||||
- title: MODULE_WRAPPER_PREFIX
|
||||
url: /pages/api/module-minifier-plugin.module_wrapper_prefix
|
||||
- title: MODULE_WRAPPER_SUFFIX
|
||||
url: /pages/api/module-minifier-plugin.module_wrapper_suffix
|
||||
- title: ModuleMinifierPlugin
|
||||
url: /pages/api/module-minifier-plugin.moduleminifierplugin
|
||||
subitems:
|
||||
- title: (constructor)
|
||||
url: /pages/api/module-minifier-plugin.moduleminifierplugin._constructor_
|
||||
- title: apply
|
||||
url: /pages/api/module-minifier-plugin.moduleminifierplugin.apply
|
||||
- title: hooks
|
||||
url: /pages/api/module-minifier-plugin.moduleminifierplugin.hooks
|
||||
- title: minifier
|
||||
url: /pages/api/module-minifier-plugin.moduleminifierplugin.minifier
|
||||
- title: NoopMinifier
|
||||
url: /pages/api/module-minifier-plugin.noopminifier
|
||||
subitems:
|
||||
- title: minify
|
||||
url: /pages/api/module-minifier-plugin.noopminifier.minify
|
||||
- title: PortableMinifierModuleIdsPlugin
|
||||
url: /pages/api/module-minifier-plugin.portableminifiermoduleidsplugin
|
||||
subitems:
|
||||
- title: (constructor)
|
||||
url: /pages/api/module-minifier-plugin.portableminifiermoduleidsplugin._constructor_
|
||||
- title: apply
|
||||
url: /pages/api/module-minifier-plugin.portableminifiermoduleidsplugin.apply
|
||||
- title: rehydrateAsset
|
||||
url: /pages/api/module-minifier-plugin.rehydrateasset
|
||||
- title: STAGE_AFTER
|
||||
url: /pages/api/module-minifier-plugin.stage_after
|
||||
- title: STAGE_BEFORE
|
||||
url: /pages/api/module-minifier-plugin.stage_before
|
||||
- title: SynchronousMinifier
|
||||
url: /pages/api/module-minifier-plugin.synchronousminifier
|
||||
subitems:
|
||||
- title: (constructor)
|
||||
url: /pages/api/module-minifier-plugin.synchronousminifier._constructor_
|
||||
- title: minify
|
||||
url: /pages/api/module-minifier-plugin.synchronousminifier.minify
|
||||
- title: terserOptions
|
||||
url: /pages/api/module-minifier-plugin.synchronousminifier.terseroptions
|
||||
- title: WorkerPoolMinifier
|
||||
url: /pages/api/module-minifier-plugin.workerpoolminifier
|
||||
subitems:
|
||||
- title: (constructor)
|
||||
url: /pages/api/module-minifier-plugin.workerpoolminifier._constructor_
|
||||
- title: maxThreads
|
||||
url: /pages/api/module-minifier-plugin.workerpoolminifier.maxthreads
|
||||
- title: minify
|
||||
url: /pages/api/module-minifier-plugin.workerpoolminifier.minify
|
||||
- title: ref
|
||||
url: /pages/api/module-minifier-plugin.workerpoolminifier.ref
|
||||
- title: '@rushstack/node-core-library'
|
||||
url: /pages/api/node-core-library
|
||||
subitems:
|
||||
|
@ -2216,6 +2709,8 @@ api_nav:
|
|||
subitems:
|
||||
- title: mergeFromMap
|
||||
url: /pages/api/node-core-library.mapextensions.mergefrommap
|
||||
- title: toObject
|
||||
url: /pages/api/node-core-library.mapextensions.toobject
|
||||
- title: NewlineKind
|
||||
url: /pages/api/node-core-library.newlinekind
|
||||
- title: PackageJsonLookup
|
||||
|
|
|
@ -26,8 +26,10 @@ export declare const enum ConsoleMessageId
|
|||
| ApiReportFolderMissing | <code>"console-api-report-folder-missing"</code> | "Unable to create the API report file. Please make sure the target folder exists: \_\_\_" |
|
||||
| ApiReportNotCopied | <code>"console-api-report-not-copied"</code> | "You have changed the public API signature for this project. Please copy the file \_\_\_ to \_\_\_, or perform a local build (which does this automatically). See the Git repo documentation for more info."<!-- -->OR<!-- -->"The API report file is missing. Please copy the file \_\_\_ to \_\_\_, or perform a local build (which does this automatically). See the Git repo documentation for more info." |
|
||||
| ApiReportUnchanged | <code>"console-api-report-unchanged"</code> | "The API report is up to date: \_\_\_" |
|
||||
| CompilerVersionNotice | <code>"console-compiler-version-notice"</code> | "The target project appears to use TypeScript \_\_\_ which is newer than the bundled compiler engine; consider upgrading API Extractor." |
|
||||
| Diagnostics | <code>"console-diagnostics"</code> | Used for the information printed when the "--diagnostics" flag is enabled. |
|
||||
| FoundTSDocMetadata | <code>"console-found-tsdoc-metadata"</code> | "Found metadata in \_\_\_" |
|
||||
| Preamble | <code>"console-preamble"</code> | "Analysis will use the bundled TypeScript version \_\_\_" |
|
||||
| WritingDocModelFile | <code>"console-writing-doc-model-file"</code> | "Writing: \_\_\_" |
|
||||
| WritingDtsRollup | <code>"console-writing-dts-rollup"</code> | "Writing package typings: \_\_\_" |
|
||||
|
||||
|
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ActionHooksBase](./heft.actionhooksbase.md) > [afterLoadActionConfiguration](./heft.actionhooksbase.afterloadactionconfiguration.md)
|
||||
|
||||
## ActionHooksBase.afterLoadActionConfiguration property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly afterLoadActionConfiguration: AsyncSeriesHook;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ActionHooksBase](./heft.actionhooksbase.md) > [loadActionConfiguration](./heft.actionhooksbase.loadactionconfiguration.md)
|
||||
|
||||
## ActionHooksBase.loadActionConfiguration property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly loadActionConfiguration: AsyncSeriesHook;
|
||||
```
|
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ActionHooksBase](./heft.actionhooksbase.md)
|
||||
|
||||
## ActionHooksBase class
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare abstract class ActionHooksBase<TActionProperties extends object>
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [afterLoadActionConfiguration](./heft.actionhooksbase.afterloadactionconfiguration.md) | | AsyncSeriesHook | |
|
||||
| [loadActionConfiguration](./heft.actionhooksbase.loadactionconfiguration.md) | | AsyncSeriesHook | |
|
||||
| [overrideAction](./heft.actionhooksbase.overrideaction.md) | | AsyncSeriesBailHook<TActionProperties> | <b><i>(BETA)</i></b> This hook allows the action's execution to be completely overridden. Only the last-registered plugin with an override hook provided applies. |
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ActionHooksBase](./heft.actionhooksbase.md) > [overrideAction](./heft.actionhooksbase.overrideaction.md)
|
||||
|
||||
## ActionHooksBase.overrideAction property
|
||||
|
||||
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
|
||||
>
|
||||
|
||||
This hook allows the action's execution to be completely overridden. Only the last-registered plugin with an override hook provided applies.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly overrideAction: AsyncSeriesBailHook<TActionProperties>;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [BuildHooks](./heft.buildhooks.md) > [bundle](./heft.buildhooks.bundle.md)
|
||||
|
||||
## BuildHooks.bundle property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly bundle: SyncHook<IBundleStage>;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [BuildHooks](./heft.buildhooks.md) > [compile](./heft.buildhooks.compile.md)
|
||||
|
||||
## BuildHooks.compile property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly compile: SyncHook<ICompileStage>;
|
||||
```
|
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [BuildHooks](./heft.buildhooks.md)
|
||||
|
||||
## BuildHooks class
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare class BuildHooks extends ActionHooksBase<IBuildActionProperties>
|
||||
```
|
||||
<b>Extends:</b> [ActionHooksBase](./heft.actionhooksbase.md)<!-- --><[IBuildActionProperties](./heft.ibuildactionproperties.md)<!-- -->>
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [bundle](./heft.buildhooks.bundle.md) | | SyncHook<[IBundleStage](./heft.ibundlestage.md)<!-- -->> | |
|
||||
| [compile](./heft.buildhooks.compile.md) | | SyncHook<[ICompileStage](./heft.icompilestage.md)<!-- -->> | |
|
||||
| [postBuild](./heft.buildhooks.postbuild.md) | | SyncHook<[IPostBuildStage](./heft.ipostbuildstage.md)<!-- -->> | |
|
||||
| [preCompile](./heft.buildhooks.precompile.md) | | SyncHook<[IPreCompileStage](./heft.iprecompilestage.md)<!-- -->> | |
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [BuildHooks](./heft.buildhooks.md) > [postBuild](./heft.buildhooks.postbuild.md)
|
||||
|
||||
## BuildHooks.postBuild property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly postBuild: SyncHook<IPostBuildStage>;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [BuildHooks](./heft.buildhooks.md) > [preCompile](./heft.buildhooks.precompile.md)
|
||||
|
||||
## BuildHooks.preCompile property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly preCompile: SyncHook<IPreCompileStage>;
|
||||
```
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [BuildStageHooksBase](./heft.buildstagehooksbase.md)
|
||||
|
||||
## BuildStageHooksBase class
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare class BuildStageHooksBase
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [run](./heft.buildstagehooksbase.run.md) | | AsyncParallelHook | |
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [BuildStageHooksBase](./heft.buildstagehooksbase.md) > [run](./heft.buildstagehooksbase.run.md)
|
||||
|
||||
## BuildStageHooksBase.run property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly run: AsyncParallelHook;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [BundleStageHooks](./heft.bundlestagehooks.md) > [afterConfigureWebpack](./heft.bundlestagehooks.afterconfigurewebpack.md)
|
||||
|
||||
## BundleStageHooks.afterConfigureWebpack property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly afterConfigureWebpack: AsyncSeriesHook;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [BundleStageHooks](./heft.bundlestagehooks.md) > [configureWebpack](./heft.bundlestagehooks.configurewebpack.md)
|
||||
|
||||
## BundleStageHooks.configureWebpack property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly configureWebpack: AsyncSeriesHook;
|
||||
```
|
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [BundleStageHooks](./heft.bundlestagehooks.md)
|
||||
|
||||
## BundleStageHooks class
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare class BundleStageHooks extends BuildStageHooksBase
|
||||
```
|
||||
<b>Extends:</b> [BuildStageHooksBase](./heft.buildstagehooksbase.md)
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [afterConfigureWebpack](./heft.bundlestagehooks.afterconfigurewebpack.md) | | AsyncSeriesHook | |
|
||||
| [configureWebpack](./heft.bundlestagehooks.configurewebpack.md) | | AsyncSeriesHook | |
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [CleanHooks](./heft.cleanhooks.md) > [deletePath](./heft.cleanhooks.deletepath.md)
|
||||
|
||||
## CleanHooks.deletePath property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly deletePath: AsyncSeriesBailHook<string>;
|
||||
```
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [CleanHooks](./heft.cleanhooks.md)
|
||||
|
||||
## CleanHooks class
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare class CleanHooks extends ActionHooksBase<ICleanActionProperties>
|
||||
```
|
||||
<b>Extends:</b> [ActionHooksBase](./heft.actionhooksbase.md)<!-- --><[ICleanActionProperties](./heft.icleanactionproperties.md)<!-- -->>
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [deletePath](./heft.cleanhooks.deletepath.md) | | AsyncSeriesBailHook<string> | |
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [CompileStageHooks](./heft.compilestagehooks.md) > [afterConfigureCopyStaticAssets](./heft.compilestagehooks.afterconfigurecopystaticassets.md)
|
||||
|
||||
## CompileStageHooks.afterConfigureCopyStaticAssets property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly afterConfigureCopyStaticAssets: AsyncSeriesHook;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [CompileStageHooks](./heft.compilestagehooks.md) > [afterConfigureTypeScript](./heft.compilestagehooks.afterconfiguretypescript.md)
|
||||
|
||||
## CompileStageHooks.afterConfigureTypeScript property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly afterConfigureTypeScript: AsyncSeriesHook;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [CompileStageHooks](./heft.compilestagehooks.md) > [configureCopyStaticAssets](./heft.compilestagehooks.configurecopystaticassets.md)
|
||||
|
||||
## CompileStageHooks.configureCopyStaticAssets property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly configureCopyStaticAssets: AsyncSeriesHook;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [CompileStageHooks](./heft.compilestagehooks.md) > [configureTypeScript](./heft.compilestagehooks.configuretypescript.md)
|
||||
|
||||
## CompileStageHooks.configureTypeScript property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly configureTypeScript: AsyncSeriesHook;
|
||||
```
|
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [CompileStageHooks](./heft.compilestagehooks.md)
|
||||
|
||||
## CompileStageHooks class
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare class CompileStageHooks extends BuildStageHooksBase
|
||||
```
|
||||
<b>Extends:</b> [BuildStageHooksBase](./heft.buildstagehooksbase.md)
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [afterConfigureCopyStaticAssets](./heft.compilestagehooks.afterconfigurecopystaticassets.md) | | AsyncSeriesHook | |
|
||||
| [afterConfigureTypeScript](./heft.compilestagehooks.afterconfiguretypescript.md) | | AsyncSeriesHook | |
|
||||
| [configureCopyStaticAssets](./heft.compilestagehooks.configurecopystaticassets.md) | | AsyncSeriesHook | |
|
||||
| [configureTypeScript](./heft.compilestagehooks.configuretypescript.md) | | AsyncSeriesHook | |
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [CopyFromCacheMode](./heft.copyfromcachemode.md)
|
||||
|
||||
## CopyFromCacheMode type
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type CopyFromCacheMode = 'hardlink' | 'copy';
|
||||
```
|
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [DevDeployHooks](./heft.devdeployhooks.md)
|
||||
|
||||
## DevDeployHooks class
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare class DevDeployHooks extends ActionHooksBase<IDevDeployActionProperties>
|
||||
```
|
||||
<b>Extends:</b> [ActionHooksBase](./heft.actionhooksbase.md)<!-- --><[IDevDeployActionProperties](./heft.idevdeployactionproperties.md)<!-- -->>
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [HeftConfiguration](./heft.heftconfiguration.md) > [buildCacheFolder](./heft.heftconfiguration.buildcachefolder.md)
|
||||
|
||||
## HeftConfiguration.buildCacheFolder property
|
||||
|
||||
The project's build cache folder.
|
||||
|
||||
This folder exists at <<!-- -->project root<!-- -->><!-- -->/.heft/build-cache. TypeScript's output goes into this folder and then is either copied or linked to the final output folder
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
get buildCacheFolder(): string;
|
||||
```
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [HeftConfiguration](./heft.heftconfiguration.md) > [buildFolder](./heft.heftconfiguration.buildfolder.md)
|
||||
|
||||
## HeftConfiguration.buildFolder property
|
||||
|
||||
Project build folder. This is the folder containing the project's package.json file.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
get buildFolder(): string;
|
||||
```
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [HeftConfiguration](./heft.heftconfiguration.md) > [compilerPackage](./heft.heftconfiguration.compilerpackage.md)
|
||||
|
||||
## HeftConfiguration.compilerPackage property
|
||||
|
||||
If used by the project being built, the tool package paths exported from the rush-stack-compiler-\* package.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
get compilerPackage(): ICompilerPackage | undefined;
|
||||
```
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [HeftConfiguration](./heft.heftconfiguration.md) > [heftPackageJson](./heft.heftconfiguration.heftpackagejson.md)
|
||||
|
||||
## HeftConfiguration.heftPackageJson property
|
||||
|
||||
The Heft tool's package.json
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
get heftPackageJson(): IPackageJson;
|
||||
```
|
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [HeftConfiguration](./heft.heftconfiguration.md)
|
||||
|
||||
## HeftConfiguration class
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare class HeftConfiguration
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [buildCacheFolder](./heft.heftconfiguration.buildcachefolder.md) | | string | The project's build cache folder.<!-- -->This folder exists at <<!-- -->project root<!-- -->><!-- -->/.heft/build-cache. TypeScript's output goes into this folder and then is either copied or linked to the final output folder |
|
||||
| [buildFolder](./heft.heftconfiguration.buildfolder.md) | | string | Project build folder. This is the folder containing the project's package.json file. |
|
||||
| [compilerPackage](./heft.heftconfiguration.compilerpackage.md) | | [ICompilerPackage](./heft.icompilerpackage.md) \| undefined | If used by the project being built, the tool package paths exported from the rush-stack-compiler-\* package. |
|
||||
| [heftPackageJson](./heft.heftconfiguration.heftpackagejson.md) | | [IPackageJson](./node-core-library.ipackagejson.md) | The Heft tool's package.json |
|
||||
| [projectHeftDataFolder](./heft.heftconfiguration.projectheftdatafolder.md) | | string | The path to the project's ".heft" folder. |
|
||||
| [projectPackageJson](./heft.heftconfiguration.projectpackagejson.md) | | [IPackageJson](./node-core-library.ipackagejson.md) | The package.json of the project being built |
|
||||
| [terminal](./heft.heftconfiguration.terminal.md) | | [Terminal](./node-core-library.terminal.md) | Terminal instance to facilitate logging. |
|
||||
| [terminalProvider](./heft.heftconfiguration.terminalprovider.md) | | [ITerminalProvider](./node-core-library.iterminalprovider.md) | Terminal provider for the provided terminal. |
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [HeftConfiguration](./heft.heftconfiguration.md) > [projectHeftDataFolder](./heft.heftconfiguration.projectheftdatafolder.md)
|
||||
|
||||
## HeftConfiguration.projectHeftDataFolder property
|
||||
|
||||
The path to the project's ".heft" folder.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
get projectHeftDataFolder(): string;
|
||||
```
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [HeftConfiguration](./heft.heftconfiguration.md) > [projectPackageJson](./heft.heftconfiguration.projectpackagejson.md)
|
||||
|
||||
## HeftConfiguration.projectPackageJson property
|
||||
|
||||
The package.json of the project being built
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
get projectPackageJson(): IPackageJson;
|
||||
```
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [HeftConfiguration](./heft.heftconfiguration.md) > [terminal](./heft.heftconfiguration.terminal.md)
|
||||
|
||||
## HeftConfiguration.terminal property
|
||||
|
||||
Terminal instance to facilitate logging.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
get terminal(): Terminal;
|
||||
```
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [HeftConfiguration](./heft.heftconfiguration.md) > [terminalProvider](./heft.heftconfiguration.terminalprovider.md)
|
||||
|
||||
## HeftConfiguration.terminalProvider property
|
||||
|
||||
Terminal provider for the provided terminal.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
get terminalProvider(): ITerminalProvider;
|
||||
```
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [HeftSession](./heft.heftsession.md) > [debugMode](./heft.heftsession.debugmode.md)
|
||||
|
||||
## HeftSession.debugMode property
|
||||
|
||||
If set to true, the build is running with the --debug flag
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
get debugMode(): boolean;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [HeftSession](./heft.heftsession.md) > [hooks](./heft.heftsession.hooks.md)
|
||||
|
||||
## HeftSession.hooks property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly hooks: IHeftSessionHooks;
|
||||
```
|
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [HeftSession](./heft.heftsession.md)
|
||||
|
||||
## HeftSession class
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare class HeftSession
|
||||
```
|
||||
|
||||
## Remarks
|
||||
|
||||
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `HeftSession` class.
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [debugMode](./heft.heftsession.debugmode.md) | | boolean | If set to true, the build is running with the --debug flag |
|
||||
| [hooks](./heft.heftsession.hooks.md) | | [IHeftSessionHooks](./heft.iheftsessionhooks.md) | |
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IActionContext](./heft.iactioncontext.md) > [hooks](./heft.iactioncontext.hooks.md)
|
||||
|
||||
## IActionContext.hooks property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
hooks: THooks;
|
||||
```
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IActionContext](./heft.iactioncontext.md)
|
||||
|
||||
## IActionContext interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IActionContext<THooks extends ActionHooksBase<TActionProperties>, TActionProperties extends object>
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [hooks](./heft.iactioncontext.hooks.md) | THooks | |
|
||||
| [properties](./heft.iactioncontext.properties.md) | TActionProperties | |
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IActionContext](./heft.iactioncontext.md) > [properties](./heft.iactioncontext.properties.md)
|
||||
|
||||
## IActionContext.properties property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
properties: TActionProperties;
|
||||
```
|
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBuildActionContext](./heft.ibuildactioncontext.md)
|
||||
|
||||
## IBuildActionContext interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IBuildActionContext extends IActionContext<BuildHooks, IBuildActionProperties>
|
||||
```
|
||||
<b>Extends:</b> [IActionContext](./heft.iactioncontext.md)<!-- --><[BuildHooks](./heft.buildhooks.md)<!-- -->, [IBuildActionProperties](./heft.ibuildactionproperties.md)<!-- -->>
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBuildActionProperties](./heft.ibuildactionproperties.md) > [cleanFlag](./heft.ibuildactionproperties.cleanflag.md)
|
||||
|
||||
## IBuildActionProperties.cleanFlag property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
cleanFlag: boolean;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBuildActionProperties](./heft.ibuildactionproperties.md) > [liteFlag](./heft.ibuildactionproperties.liteflag.md)
|
||||
|
||||
## IBuildActionProperties.liteFlag property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
liteFlag: boolean;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBuildActionProperties](./heft.ibuildactionproperties.md) > [locale](./heft.ibuildactionproperties.locale.md)
|
||||
|
||||
## IBuildActionProperties.locale property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
locale?: string;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBuildActionProperties](./heft.ibuildactionproperties.md) > [maxOldSpaceSize](./heft.ibuildactionproperties.maxoldspacesize.md)
|
||||
|
||||
## IBuildActionProperties.maxOldSpaceSize property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
maxOldSpaceSize?: string;
|
||||
```
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBuildActionProperties](./heft.ibuildactionproperties.md)
|
||||
|
||||
## IBuildActionProperties interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IBuildActionProperties
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [cleanFlag](./heft.ibuildactionproperties.cleanflag.md) | boolean | |
|
||||
| [liteFlag](./heft.ibuildactionproperties.liteflag.md) | boolean | |
|
||||
| [locale](./heft.ibuildactionproperties.locale.md) | string | |
|
||||
| [maxOldSpaceSize](./heft.ibuildactionproperties.maxoldspacesize.md) | string | |
|
||||
| [noTest](./heft.ibuildactionproperties.notest.md) | boolean | |
|
||||
| [productionFlag](./heft.ibuildactionproperties.productionflag.md) | boolean | |
|
||||
| [verboseFlag](./heft.ibuildactionproperties.verboseflag.md) | boolean | |
|
||||
| [watchMode](./heft.ibuildactionproperties.watchmode.md) | boolean | |
|
||||
| [webpackStats](./heft.ibuildactionproperties.webpackstats.md) | webpack.Stats | |
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBuildActionProperties](./heft.ibuildactionproperties.md) > [noTest](./heft.ibuildactionproperties.notest.md)
|
||||
|
||||
## IBuildActionProperties.noTest property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
noTest: boolean;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBuildActionProperties](./heft.ibuildactionproperties.md) > [productionFlag](./heft.ibuildactionproperties.productionflag.md)
|
||||
|
||||
## IBuildActionProperties.productionFlag property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
productionFlag: boolean;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBuildActionProperties](./heft.ibuildactionproperties.md) > [verboseFlag](./heft.ibuildactionproperties.verboseflag.md)
|
||||
|
||||
## IBuildActionProperties.verboseFlag property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
verboseFlag: boolean;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBuildActionProperties](./heft.ibuildactionproperties.md) > [watchMode](./heft.ibuildactionproperties.watchmode.md)
|
||||
|
||||
## IBuildActionProperties.watchMode property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
watchMode: boolean;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBuildActionProperties](./heft.ibuildactionproperties.md) > [webpackStats](./heft.ibuildactionproperties.webpackstats.md)
|
||||
|
||||
## IBuildActionProperties.webpackStats property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
webpackStats?: webpack.Stats;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBuildStage](./heft.ibuildstage.md) > [hooks](./heft.ibuildstage.hooks.md)
|
||||
|
||||
## IBuildStage.hooks property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
hooks: TBuildStageHooks;
|
||||
```
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBuildStage](./heft.ibuildstage.md)
|
||||
|
||||
## IBuildStage interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IBuildStage<TBuildStageHooks extends BuildStageHooksBase, TBuildStageProperties extends object>
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [hooks](./heft.ibuildstage.hooks.md) | TBuildStageHooks | |
|
||||
| [properties](./heft.ibuildstage.properties.md) | TBuildStageProperties | |
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBuildStage](./heft.ibuildstage.md) > [properties](./heft.ibuildstage.properties.md)
|
||||
|
||||
## IBuildStage.properties property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
properties: TBuildStageProperties;
|
||||
```
|
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBundleStage](./heft.ibundlestage.md)
|
||||
|
||||
## IBundleStage interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IBundleStage extends IBuildStage<BundleStageHooks, IBundleStageProperties>
|
||||
```
|
||||
<b>Extends:</b> [IBuildStage](./heft.ibuildstage.md)<!-- --><[BundleStageHooks](./heft.bundlestagehooks.md)<!-- -->, [IBundleStageProperties](./heft.ibundlestageproperties.md)<!-- -->>
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBundleStageProperties](./heft.ibundlestageproperties.md)
|
||||
|
||||
## IBundleStageProperties interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IBundleStageProperties
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [webpackConfigFilePath](./heft.ibundlestageproperties.webpackconfigfilepath.md) | string | A path to a Webpack configuration JS file. If this isn't specified, and a Webpack configuration isn't specified via another plugin, Webpack won't be run. |
|
||||
| [webpackConfiguration](./heft.ibundlestageproperties.webpackconfiguration.md) | webpack.Configuration | The configuration used by the Webpack plugin. This must be populated for Webpack to run. If webpackConfigFilePath is specified, this will be populated automatically with the exports of the config file referenced in that property. |
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBundleStageProperties](./heft.ibundlestageproperties.md) > [webpackConfigFilePath](./heft.ibundlestageproperties.webpackconfigfilepath.md)
|
||||
|
||||
## IBundleStageProperties.webpackConfigFilePath property
|
||||
|
||||
A path to a Webpack configuration JS file. If this isn't specified, and a Webpack configuration isn't specified via another plugin, Webpack won't be run.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
webpackConfigFilePath?: string;
|
||||
```
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IBundleStageProperties](./heft.ibundlestageproperties.md) > [webpackConfiguration](./heft.ibundlestageproperties.webpackconfiguration.md)
|
||||
|
||||
## IBundleStageProperties.webpackConfiguration property
|
||||
|
||||
The configuration used by the Webpack plugin. This must be populated for Webpack to run. If webpackConfigFilePath is specified, this will be populated automatically with the exports of the config file referenced in that property.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
webpackConfiguration?: webpack.Configuration;
|
||||
```
|
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ICleanActionContext](./heft.icleanactioncontext.md)
|
||||
|
||||
## ICleanActionContext interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ICleanActionContext extends IActionContext<CleanHooks, ICleanActionProperties>
|
||||
```
|
||||
<b>Extends:</b> [IActionContext](./heft.iactioncontext.md)<!-- --><[CleanHooks](./heft.cleanhooks.md)<!-- -->, [ICleanActionProperties](./heft.icleanactionproperties.md)<!-- -->>
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ICleanActionProperties](./heft.icleanactionproperties.md) > [deleteCache](./heft.icleanactionproperties.deletecache.md)
|
||||
|
||||
## ICleanActionProperties.deleteCache property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
deleteCache: boolean;
|
||||
```
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ICleanActionProperties](./heft.icleanactionproperties.md)
|
||||
|
||||
## ICleanActionProperties interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ICleanActionProperties
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [deleteCache](./heft.icleanactionproperties.deletecache.md) | boolean | |
|
||||
| [pathsToDelete](./heft.icleanactionproperties.pathstodelete.md) | Set<string> | |
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ICleanActionProperties](./heft.icleanactionproperties.md) > [pathsToDelete](./heft.icleanactionproperties.pathstodelete.md)
|
||||
|
||||
## ICleanActionProperties.pathsToDelete property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
pathsToDelete: Set<string>;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ICompilerPackage](./heft.icompilerpackage.md) > [apiExtractorPackagePath](./heft.icompilerpackage.apiextractorpackagepath.md)
|
||||
|
||||
## ICompilerPackage.apiExtractorPackagePath property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
apiExtractorPackagePath: string;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ICompilerPackage](./heft.icompilerpackage.md) > [eslintPackagePath](./heft.icompilerpackage.eslintpackagepath.md)
|
||||
|
||||
## ICompilerPackage.eslintPackagePath property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
eslintPackagePath: string;
|
||||
```
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ICompilerPackage](./heft.icompilerpackage.md)
|
||||
|
||||
## ICompilerPackage interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ICompilerPackage
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [apiExtractorPackagePath](./heft.icompilerpackage.apiextractorpackagepath.md) | string | |
|
||||
| [eslintPackagePath](./heft.icompilerpackage.eslintpackagepath.md) | string | |
|
||||
| [tslintPackagePath](./heft.icompilerpackage.tslintpackagepath.md) | string | |
|
||||
| [typeScriptPackagePath](./heft.icompilerpackage.typescriptpackagepath.md) | string | |
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ICompilerPackage](./heft.icompilerpackage.md) > [tslintPackagePath](./heft.icompilerpackage.tslintpackagepath.md)
|
||||
|
||||
## ICompilerPackage.tslintPackagePath property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
tslintPackagePath: string;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ICompilerPackage](./heft.icompilerpackage.md) > [typeScriptPackagePath](./heft.icompilerpackage.typescriptpackagepath.md)
|
||||
|
||||
## ICompilerPackage.typeScriptPackagePath property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
typeScriptPackagePath: string;
|
||||
```
|
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ICompileStage](./heft.icompilestage.md)
|
||||
|
||||
## ICompileStage interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ICompileStage extends IBuildStage<CompileStageHooks, ICompileStageProperties>
|
||||
```
|
||||
<b>Extends:</b> [IBuildStage](./heft.ibuildstage.md)<!-- --><[CompileStageHooks](./heft.compilestagehooks.md)<!-- -->, [ICompileStageProperties](./heft.icompilestageproperties.md)<!-- -->>
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ICompileStageProperties](./heft.icompilestageproperties.md) > [copyStaticAssetsConfiguration](./heft.icompilestageproperties.copystaticassetsconfiguration.md)
|
||||
|
||||
## ICompileStageProperties.copyStaticAssetsConfiguration property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
copyStaticAssetsConfiguration: ICopyStaticAssetsConfiguration;
|
||||
```
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ICompileStageProperties](./heft.icompilestageproperties.md)
|
||||
|
||||
## ICompileStageProperties interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ICompileStageProperties
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [copyStaticAssetsConfiguration](./heft.icompilestageproperties.copystaticassetsconfiguration.md) | [ICopyStaticAssetsConfiguration](./heft.icopystaticassetsconfiguration.md) | |
|
||||
| [typeScriptConfiguration](./heft.icompilestageproperties.typescriptconfiguration.md) | [ITypeScriptConfiguration](./heft.itypescriptconfiguration.md) | |
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ICompileStageProperties](./heft.icompilestageproperties.md) > [typeScriptConfiguration](./heft.icompilestageproperties.typescriptconfiguration.md)
|
||||
|
||||
## ICompileStageProperties.typeScriptConfiguration property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
typeScriptConfiguration: ITypeScriptConfiguration;
|
||||
```
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ICopyStaticAssetsConfiguration](./heft.icopystaticassetsconfiguration.md) > [destinationFolderNames](./heft.icopystaticassetsconfiguration.destinationfoldernames.md)
|
||||
|
||||
## ICopyStaticAssetsConfiguration.destinationFolderNames property
|
||||
|
||||
The folder(s) to which assets should be copied. For example \["lib", "lib-cjs"\]. This defaults to \["lib"\]
|
||||
|
||||
These folders are directly under the folder containing the project's package.json file
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
destinationFolderNames: string[];
|
||||
```
|
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ICopyStaticAssetsConfiguration](./heft.icopystaticassetsconfiguration.md)
|
||||
|
||||
## ICopyStaticAssetsConfiguration interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ICopyStaticAssetsConfiguration extends ISharedCopyStaticAssetsConfiguration
|
||||
```
|
||||
<b>Extends:</b> [ISharedCopyStaticAssetsConfiguration](./heft.isharedcopystaticassetsconfiguration.md)
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [destinationFolderNames](./heft.icopystaticassetsconfiguration.destinationfoldernames.md) | string\[\] | The folder(s) to which assets should be copied. For example \["lib", "lib-cjs"\]. This defaults to \["lib"\]<!-- -->These folders are directly under the folder containing the project's package.json file |
|
||||
| [sourceFolderName](./heft.icopystaticassetsconfiguration.sourcefoldername.md) | string | The folder from which assets should be copied. For example, "src". This defaults to "src".<!-- -->This folder is directly under the folder containing the project's package.json file |
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [ICopyStaticAssetsConfiguration](./heft.icopystaticassetsconfiguration.md) > [sourceFolderName](./heft.icopystaticassetsconfiguration.sourcefoldername.md)
|
||||
|
||||
## ICopyStaticAssetsConfiguration.sourceFolderName property
|
||||
|
||||
The folder from which assets should be copied. For example, "src". This defaults to "src".
|
||||
|
||||
This folder is directly under the folder containing the project's package.json file
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
sourceFolderName: string;
|
||||
```
|
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IDevDeployActionContext](./heft.idevdeployactioncontext.md)
|
||||
|
||||
## IDevDeployActionContext interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IDevDeployActionContext extends IActionContext<DevDeployHooks, IDevDeployActionProperties>
|
||||
```
|
||||
<b>Extends:</b> [IActionContext](./heft.iactioncontext.md)<!-- --><[DevDeployHooks](./heft.devdeployhooks.md)<!-- -->, [IDevDeployActionProperties](./heft.idevdeployactionproperties.md)<!-- -->>
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IDevDeployActionProperties](./heft.idevdeployactionproperties.md)
|
||||
|
||||
## IDevDeployActionProperties interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IDevDeployActionProperties
|
||||
```
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IEmitModuleKind](./heft.iemitmodulekind.md)
|
||||
|
||||
## IEmitModuleKind type
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type IEmitModuleKind = IEmitModuleKindBase<'commonjs' | 'amd' | 'umd' | 'system' | 'es2015' | 'esnext'>;
|
||||
```
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IEmitModuleKindBase](./heft.iemitmodulekindbase.md)
|
||||
|
||||
## IEmitModuleKindBase interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IEmitModuleKindBase<TModuleKind>
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [moduleKind](./heft.iemitmodulekindbase.modulekind.md) | TModuleKind | |
|
||||
| [outFolderPath](./heft.iemitmodulekindbase.outfolderpath.md) | string | |
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IEmitModuleKindBase](./heft.iemitmodulekindbase.md) > [moduleKind](./heft.iemitmodulekindbase.modulekind.md)
|
||||
|
||||
## IEmitModuleKindBase.moduleKind property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
moduleKind: TModuleKind;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IEmitModuleKindBase](./heft.iemitmodulekindbase.md) > [outFolderPath](./heft.iemitmodulekindbase.outfolderpath.md)
|
||||
|
||||
## IEmitModuleKindBase.outFolderPath property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
outFolderPath: string;
|
||||
```
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IHeftActionConfiguration](./heft.iheftactionconfiguration.md)
|
||||
|
||||
## IHeftActionConfiguration interface
|
||||
|
||||
The base action configuration that all custom action configuration files should inherit from.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IHeftActionConfiguration
|
||||
```
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IHeftActionConfigurationOptions](./heft.iheftactionconfigurationoptions.md)
|
||||
|
||||
## IHeftActionConfigurationOptions interface
|
||||
|
||||
Options to be used when retrieving the action configuration.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IHeftActionConfigurationOptions
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [mergeArrays](./heft.iheftactionconfigurationoptions.mergearrays.md) | boolean | Whether or not arrays should be merged across Heft action configuration files. |
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IHeftActionConfigurationOptions](./heft.iheftactionconfigurationoptions.md) > [mergeArrays](./heft.iheftactionconfigurationoptions.mergearrays.md)
|
||||
|
||||
## IHeftActionConfigurationOptions.mergeArrays property
|
||||
|
||||
Whether or not arrays should be merged across Heft action configuration files.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
mergeArrays?: boolean;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IHeftPlugin](./heft.iheftplugin.md) > [apply](./heft.iheftplugin.apply.md)
|
||||
|
||||
## IHeftPlugin.apply property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
apply: (heftSession: HeftSession, heftConfiguration: HeftConfiguration, options?: TOptions) => void;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IHeftPlugin](./heft.iheftplugin.md) > [displayName](./heft.iheftplugin.displayname.md)
|
||||
|
||||
## IHeftPlugin.displayName property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
displayName: string;
|
||||
```
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IHeftPlugin](./heft.iheftplugin.md)
|
||||
|
||||
## IHeftPlugin interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IHeftPlugin<TOptions = void>
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [apply](./heft.iheftplugin.apply.md) | (heftSession: [HeftSession](./heft.heftsession.md)<!-- -->, heftConfiguration: [HeftConfiguration](./heft.heftconfiguration.md)<!-- -->, options?: TOptions) => void | |
|
||||
| [displayName](./heft.iheftplugin.displayname.md) | string | |
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IHeftSessionHooks](./heft.iheftsessionhooks.md) > [build](./heft.iheftsessionhooks.build.md)
|
||||
|
||||
## IHeftSessionHooks.build property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
build: SyncHook<IBuildActionContext>;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IHeftSessionHooks](./heft.iheftsessionhooks.md) > [clean](./heft.iheftsessionhooks.clean.md)
|
||||
|
||||
## IHeftSessionHooks.clean property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
clean: SyncHook<ICleanActionContext>;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IHeftSessionHooks](./heft.iheftsessionhooks.md) > [devDeploy](./heft.iheftsessionhooks.devdeploy.md)
|
||||
|
||||
## IHeftSessionHooks.devDeploy property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
devDeploy: SyncHook<IDevDeployActionContext>;
|
||||
```
|
|
@ -0,0 +1,29 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IHeftSessionHooks](./heft.iheftsessionhooks.md)
|
||||
|
||||
## IHeftSessionHooks interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IHeftSessionHooks
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [build](./heft.iheftsessionhooks.build.md) | SyncHook<[IBuildActionContext](./heft.ibuildactioncontext.md)<!-- -->> | |
|
||||
| [clean](./heft.iheftsessionhooks.clean.md) | SyncHook<[ICleanActionContext](./heft.icleanactioncontext.md)<!-- -->> | |
|
||||
| [devDeploy](./heft.iheftsessionhooks.devdeploy.md) | SyncHook<[IDevDeployActionContext](./heft.idevdeployactioncontext.md)<!-- -->> | |
|
||||
| [metricsCollector](./heft.iheftsessionhooks.metricscollector.md) | [MetricsCollectorHooks](./heft.metricscollectorhooks.md) | |
|
||||
| [start](./heft.iheftsessionhooks.start.md) | SyncHook<[IStartActionContext](./heft.istartactioncontext.md)<!-- -->> | |
|
||||
| [test](./heft.iheftsessionhooks.test.md) | SyncHook<[ITestActionContext](./heft.itestactioncontext.md)<!-- -->> | |
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IHeftSessionHooks](./heft.iheftsessionhooks.md) > [metricsCollector](./heft.iheftsessionhooks.metricscollector.md)
|
||||
|
||||
## IHeftSessionHooks.metricsCollector property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
metricsCollector: MetricsCollectorHooks;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IHeftSessionHooks](./heft.iheftsessionhooks.md) > [start](./heft.iheftsessionhooks.start.md)
|
||||
|
||||
## IHeftSessionHooks.start property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
start: SyncHook<IStartActionContext>;
|
||||
```
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IHeftSessionHooks](./heft.iheftsessionhooks.md) > [test](./heft.iheftsessionhooks.test.md)
|
||||
|
||||
## IHeftSessionHooks.test property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
test: SyncHook<ITestActionContext>;
|
||||
```
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IMetricsData](./heft.imetricsdata.md) > [command](./heft.imetricsdata.command.md)
|
||||
|
||||
## IMetricsData.command property
|
||||
|
||||
The command that was executed.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
command: string;
|
||||
```
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IMetricsData](./heft.imetricsdata.md) > [machineArch](./heft.imetricsdata.machinearch.md)
|
||||
|
||||
## IMetricsData.machineArch property
|
||||
|
||||
The processor's architecture.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
machineArch: string;
|
||||
```
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IMetricsData](./heft.imetricsdata.md) > [machineCores](./heft.imetricsdata.machinecores.md)
|
||||
|
||||
## IMetricsData.machineCores property
|
||||
|
||||
The number of processor cores.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
machineCores: number;
|
||||
```
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IMetricsData](./heft.imetricsdata.md) > [machineOs](./heft.imetricsdata.machineos.md)
|
||||
|
||||
## IMetricsData.machineOs property
|
||||
|
||||
The name of the operating system provided by NodeJS.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
machineOs: string;
|
||||
```
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IMetricsData](./heft.imetricsdata.md) > [machineProcessor](./heft.imetricsdata.machineprocessor.md)
|
||||
|
||||
## IMetricsData.machineProcessor property
|
||||
|
||||
The processor's model name.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
machineProcessor: string;
|
||||
```
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IMetricsData](./heft.imetricsdata.md) > [machineTotalMemoryMB](./heft.imetricsdata.machinetotalmemorymb.md)
|
||||
|
||||
## IMetricsData.machineTotalMemoryMB property
|
||||
|
||||
The total amount of memory the machine has, in megabytes.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
machineTotalMemoryMB: number;
|
||||
```
|
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
layout: page
|
||||
navigation_source: api_nav
|
||||
improve_this_button: false
|
||||
---
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@rushstack/heft](./heft.md) > [IMetricsData](./heft.imetricsdata.md)
|
||||
|
||||
## IMetricsData interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IMetricsData
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [command](./heft.imetricsdata.command.md) | string | The command that was executed. |
|
||||
| [machineArch](./heft.imetricsdata.machinearch.md) | string | The processor's architecture. |
|
||||
| [machineCores](./heft.imetricsdata.machinecores.md) | number | The number of processor cores. |
|
||||
| [machineOs](./heft.imetricsdata.machineos.md) | string | The name of the operating system provided by NodeJS. |
|
||||
| [machineProcessor](./heft.imetricsdata.machineprocessor.md) | string | The processor's model name. |
|
||||
| [machineTotalMemoryMB](./heft.imetricsdata.machinetotalmemorymb.md) | number | The total amount of memory the machine has, in megabytes. |
|
||||
| [taskTotalExecutionMs](./heft.imetricsdata.tasktotalexecutionms.md) | number | The amount of time the command took to execute, in milliseconds. |
|
||||
|
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче