Regenerate API docs
This commit is contained in:
Родитель
425d3f2dcc
Коммит
0d6d76b4d2
|
@ -151,6 +151,10 @@ api_nav:
|
|||
url: /pages/api/api-extractor.extractorconfig.tryloadforfolder
|
||||
- title: tsconfigFilePath
|
||||
url: /pages/api/api-extractor.extractorconfig.tsconfigfilepath
|
||||
- title: tsdocConfigFile
|
||||
url: /pages/api/api-extractor.extractorconfig.tsdocconfigfile
|
||||
- title: tsdocConfiguration
|
||||
url: /pages/api/api-extractor.extractorconfig.tsdocconfiguration
|
||||
- title: tsdocMetadataEnabled
|
||||
url: /pages/api/api-extractor.extractorconfig.tsdocmetadataenabled
|
||||
- title: tsdocMetadataFilePath
|
||||
|
@ -315,6 +319,8 @@ api_nav:
|
|||
url: /pages/api/api-extractor.iextractorconfigprepareoptions.packagejsonfullpath
|
||||
- title: projectFolderLookupToken
|
||||
url: /pages/api/api-extractor.iextractorconfigprepareoptions.projectfolderlookuptoken
|
||||
- title: tsdocConfigFile
|
||||
url: /pages/api/api-extractor.iextractorconfigprepareoptions.tsdocconfigfile
|
||||
- title: IExtractorInvokeOptions
|
||||
url: /pages/api/api-extractor.iextractorinvokeoptions
|
||||
subitems:
|
||||
|
@ -658,6 +664,20 @@ api_nav:
|
|||
url: /pages/api/api-extractor-model.apinamespace.getcontainerkey
|
||||
- title: kind
|
||||
url: /pages/api/api-extractor-model.apinamespace.kind
|
||||
- title: ApiOptionalMixin
|
||||
url: /pages/api/api-extractor-model.apioptionalmixin
|
||||
- title: ApiOptionalMixin
|
||||
url: /pages/api/api-extractor-model.apioptionalmixin
|
||||
subitems:
|
||||
- title: isOptional
|
||||
url: /pages/api/api-extractor-model.apioptionalmixin.isoptional
|
||||
- title: serializeInto
|
||||
url: /pages/api/api-extractor-model.apioptionalmixin.serializeinto
|
||||
- title: ApiOptionalMixin
|
||||
url: /pages/api/api-extractor-model.apioptionalmixin
|
||||
subitems:
|
||||
- title: isBaseClassOf
|
||||
url: /pages/api/api-extractor-model.apioptionalmixin.isbaseclassof
|
||||
- title: ApiPackage
|
||||
url: /pages/api/api-extractor-model.apipackage
|
||||
subitems:
|
||||
|
@ -679,6 +699,8 @@ api_nav:
|
|||
url: /pages/api/api-extractor-model.apipackage.loadfromjsonfile
|
||||
- title: saveToJsonFile
|
||||
url: /pages/api/api-extractor-model.apipackage.savetojsonfile
|
||||
- title: tsdocConfiguration
|
||||
url: /pages/api/api-extractor-model.apipackage.tsdocconfiguration
|
||||
- title: ApiParameterListMixin
|
||||
url: /pages/api/api-extractor-model.apiparameterlistmixin
|
||||
- title: ApiParameterListMixin
|
||||
|
@ -715,8 +737,6 @@ api_nav:
|
|||
url: /pages/api/api-extractor-model.apipropertyitem._constructor_
|
||||
- title: isEventProperty
|
||||
url: /pages/api/api-extractor-model.apipropertyitem.iseventproperty
|
||||
- title: isOptional
|
||||
url: /pages/api/api-extractor-model.apipropertyitem.isoptional
|
||||
- title: onDeserializeInto
|
||||
url: /pages/api/api-extractor-model.apipropertyitem.ondeserializeinto
|
||||
- title: propertyTypeExcerpt
|
||||
|
@ -928,8 +948,16 @@ api_nav:
|
|||
url: /pages/api/api-extractor-model.iapinamemixinoptions.name
|
||||
- title: IApiNamespaceOptions
|
||||
url: /pages/api/api-extractor-model.iapinamespaceoptions
|
||||
- title: IApiOptionalMixinOptions
|
||||
url: /pages/api/api-extractor-model.iapioptionalmixinoptions
|
||||
subitems:
|
||||
- title: isOptional
|
||||
url: /pages/api/api-extractor-model.iapioptionalmixinoptions.isoptional
|
||||
- title: IApiPackageOptions
|
||||
url: /pages/api/api-extractor-model.iapipackageoptions
|
||||
subitems:
|
||||
- title: tsdocConfiguration
|
||||
url: /pages/api/api-extractor-model.iapipackageoptions.tsdocconfiguration
|
||||
- title: IApiPackageSaveOptions
|
||||
url: /pages/api/api-extractor-model.iapipackagesaveoptions
|
||||
subitems:
|
||||
|
@ -956,8 +984,6 @@ api_nav:
|
|||
- title: IApiPropertyItemOptions
|
||||
url: /pages/api/api-extractor-model.iapipropertyitemoptions
|
||||
subitems:
|
||||
- title: isOptional
|
||||
url: /pages/api/api-extractor-model.iapipropertyitemoptions.isoptional
|
||||
- title: propertyTypeTokenRange
|
||||
url: /pages/api/api-extractor-model.iapipropertyitemoptions.propertytypetokenrange
|
||||
- title: IApiPropertyOptions
|
||||
|
@ -1179,12 +1205,14 @@ api_nav:
|
|||
- title: IExperimentsJson
|
||||
url: /pages/api/rush-lib.iexperimentsjson
|
||||
subitems:
|
||||
- title: legacyIncrementalBuildDependencyDetection
|
||||
url: /pages/api/rush-lib.iexperimentsjson.legacyincrementalbuilddependencydetection
|
||||
- title: noChmodFieldInTarHeaderNormalization
|
||||
url: /pages/api/rush-lib.iexperimentsjson.nochmodfieldintarheadernormalization
|
||||
- title: omitImportersFromPreventManualShrinkwrapChanges
|
||||
url: /pages/api/rush-lib.iexperimentsjson.omitimportersfrompreventmanualshrinkwrapchanges
|
||||
- title: usePnpmFrozenLockfileForRushInstall
|
||||
url: /pages/api/rush-lib.iexperimentsjson.usepnpmfrozenlockfileforrushinstall
|
||||
- title: usePnpmPreferFrozenLockfileForRushUpdate
|
||||
url: /pages/api/rush-lib.iexperimentsjson.usepnpmpreferfrozenlockfileforrushupdate
|
||||
- title: ILaunchOptions
|
||||
url: /pages/api/rush-lib.ilaunchoptions
|
||||
subitems:
|
||||
|
@ -1264,8 +1292,12 @@ api_nav:
|
|||
url: /pages/api/rush-lib.packagejsoneditor.load
|
||||
- title: name
|
||||
url: /pages/api/rush-lib.packagejsoneditor.name
|
||||
- title: resolutionsList
|
||||
url: /pages/api/rush-lib.packagejsoneditor.resolutionslist
|
||||
- title: saveIfModified
|
||||
url: /pages/api/rush-lib.packagejsoneditor.saveifmodified
|
||||
- title: saveToObject
|
||||
url: /pages/api/rush-lib.packagejsoneditor.savetoobject
|
||||
- title: tryGetDependency
|
||||
url: /pages/api/rush-lib.packagejsoneditor.trygetdependency
|
||||
- title: tryGetDevDependency
|
||||
|
@ -1299,8 +1331,6 @@ api_nav:
|
|||
url: /pages/api/rush-lib.pnpmoptionsconfiguration.pnpmstorepath
|
||||
- title: preventManualShrinkwrapChanges
|
||||
url: /pages/api/rush-lib.pnpmoptionsconfiguration.preventmanualshrinkwrapchanges
|
||||
- title: resolutionStrategy
|
||||
url: /pages/api/rush-lib.pnpmoptionsconfiguration.resolutionstrategy
|
||||
- title: strictPeerDependencies
|
||||
url: /pages/api/rush-lib.pnpmoptionsconfiguration.strictpeerdependencies
|
||||
- title: useWorkspaces
|
||||
|
@ -1312,6 +1342,8 @@ api_nav:
|
|||
subitems:
|
||||
- title: filePath
|
||||
url: /pages/api/rush-lib.repostatefile.filepath
|
||||
- title: isValid
|
||||
url: /pages/api/rush-lib.repostatefile.isvalid
|
||||
- title: loadFromFile
|
||||
url: /pages/api/rush-lib.repostatefile.loadfromfile
|
||||
- title: pnpmShrinkwrapHash
|
||||
|
@ -1320,8 +1352,6 @@ api_nav:
|
|||
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
|
||||
url: /pages/api/rush-lib.rush
|
||||
subitems:
|
||||
|
@ -1368,12 +1398,16 @@ api_nav:
|
|||
url: /pages/api/rush-lib.rushconfiguration.findprojectbyshorthandname
|
||||
- title: findProjectByTempName
|
||||
url: /pages/api/rush-lib.rushconfiguration.findprojectbytempname
|
||||
- title: findProjectForPosixRelativePath
|
||||
url: /pages/api/rush-lib.rushconfiguration.findprojectforposixrelativepath
|
||||
- title: getCommittedShrinkwrapFilename
|
||||
url: /pages/api/rush-lib.rushconfiguration.getcommittedshrinkwrapfilename
|
||||
- title: getCommonVersions
|
||||
url: /pages/api/rush-lib.rushconfiguration.getcommonversions
|
||||
- title: getCommonVersionsFilePath
|
||||
url: /pages/api/rush-lib.rushconfiguration.getcommonversionsfilepath
|
||||
- title: getImplicitlyPreferredVersions
|
||||
url: /pages/api/rush-lib.rushconfiguration.getimplicitlypreferredversions
|
||||
- title: getPnpmfilePath
|
||||
url: /pages/api/rush-lib.rushconfiguration.getpnpmfilepath
|
||||
- title: getProjectByName
|
||||
|
@ -1384,6 +1418,8 @@ api_nav:
|
|||
url: /pages/api/rush-lib.rushconfiguration.getrepostatefilepath
|
||||
- title: gitAllowedEmailRegExps
|
||||
url: /pages/api/rush-lib.rushconfiguration.gitallowedemailregexps
|
||||
- title: gitChangeLogUpdateCommitMessage
|
||||
url: /pages/api/rush-lib.rushconfiguration.gitchangelogupdatecommitmessage
|
||||
- title: gitSampleEmail
|
||||
url: /pages/api/rush-lib.rushconfiguration.gitsampleemail
|
||||
- title: gitVersionBumpCommitMessage
|
||||
|
@ -1463,8 +1499,12 @@ api_nav:
|
|||
- title: RushConfigurationProject
|
||||
url: /pages/api/rush-lib.rushconfigurationproject
|
||||
subitems:
|
||||
- title: consumingProjects
|
||||
url: /pages/api/rush-lib.rushconfigurationproject.consumingprojects
|
||||
- title: cyclicDependencyProjects
|
||||
url: /pages/api/rush-lib.rushconfigurationproject.cyclicdependencyprojects
|
||||
- title: dependencyProjects
|
||||
url: /pages/api/rush-lib.rushconfigurationproject.dependencyprojects
|
||||
- title: downstreamDependencyProjects
|
||||
url: /pages/api/rush-lib.rushconfigurationproject.downstreamdependencyprojects
|
||||
- title: isMainProject
|
||||
|
@ -1481,8 +1521,12 @@ api_nav:
|
|||
url: /pages/api/rush-lib.rushconfigurationproject.projectfolder
|
||||
- title: projectRelativeFolder
|
||||
url: /pages/api/rush-lib.rushconfigurationproject.projectrelativefolder
|
||||
- title: projectRushConfigFolder
|
||||
url: /pages/api/rush-lib.rushconfigurationproject.projectrushconfigfolder
|
||||
- title: projectRushTempFolder
|
||||
url: /pages/api/rush-lib.rushconfigurationproject.projectrushtempfolder
|
||||
- title: publishFolder
|
||||
url: /pages/api/rush-lib.rushconfigurationproject.publishfolder
|
||||
- title: reviewCategory
|
||||
url: /pages/api/rush-lib.rushconfigurationproject.reviewcategory
|
||||
- title: rushConfiguration
|
||||
|
@ -1548,10 +1592,10 @@ api_nav:
|
|||
subitems:
|
||||
- title: (constructor)
|
||||
url: /pages/api/debug-certificate-manager.certificatemanager._constructor_
|
||||
- title: ensureCertificate
|
||||
url: /pages/api/debug-certificate-manager.certificatemanager.ensurecertificate
|
||||
- title: untrustCertificate
|
||||
url: /pages/api/debug-certificate-manager.certificatemanager.untrustcertificate
|
||||
- title: ensureCertificateAsync
|
||||
url: /pages/api/debug-certificate-manager.certificatemanager.ensurecertificateasync
|
||||
- title: untrustCertificateAsync
|
||||
url: /pages/api/debug-certificate-manager.certificatemanager.untrustcertificateasync
|
||||
- title: CertificateStore
|
||||
url: /pages/api/debug-certificate-manager.certificatestore
|
||||
subitems:
|
||||
|
@ -1603,6 +1647,11 @@ api_nav:
|
|||
url: /pages/api/heft.cleanstagehooks.run
|
||||
- title: CompileSubstageHooks
|
||||
url: /pages/api/heft.compilesubstagehooks
|
||||
subitems:
|
||||
- title: afterCompile
|
||||
url: /pages/api/heft.compilesubstagehooks.aftercompile
|
||||
- title: afterEachIteration
|
||||
url: /pages/api/heft.compilesubstagehooks.aftereachiteration
|
||||
- title: CopyFromCacheMode
|
||||
url: /pages/api/heft.copyfromcachemode
|
||||
- title: CustomActionParameterType
|
||||
|
@ -1614,8 +1663,6 @@ api_nav:
|
|||
url: /pages/api/heft.heftconfiguration.buildcachefolder
|
||||
- title: buildFolder
|
||||
url: /pages/api/heft.heftconfiguration.buildfolder
|
||||
- title: compilerPackage
|
||||
url: /pages/api/heft.heftconfiguration.compilerpackage
|
||||
- title: globalTerminal
|
||||
url: /pages/api/heft.heftconfiguration.globalterminal
|
||||
- title: heftPackageJson
|
||||
|
@ -1648,6 +1695,12 @@ api_nav:
|
|||
- title: IBuildStageProperties
|
||||
url: /pages/api/heft.ibuildstageproperties
|
||||
subitems:
|
||||
- title: emitExtensionForTests
|
||||
url: /pages/api/heft.ibuildstageproperties.emitextensionfortests
|
||||
- title: emitFolderNameForTests
|
||||
url: /pages/api/heft.ibuildstageproperties.emitfoldernamefortests
|
||||
- title: isTypeScriptProject
|
||||
url: /pages/api/heft.ibuildstageproperties.istypescriptproject
|
||||
- title: lite
|
||||
url: /pages/api/heft.ibuildstageproperties.lite
|
||||
- title: locale
|
||||
|
@ -1676,6 +1729,10 @@ api_nav:
|
|||
subitems:
|
||||
- title: webpackConfiguration
|
||||
url: /pages/api/heft.ibundlesubstageproperties.webpackconfiguration
|
||||
- title: webpackDevServerVersion
|
||||
url: /pages/api/heft.ibundlesubstageproperties.webpackdevserverversion
|
||||
- title: webpackVersion
|
||||
url: /pages/api/heft.ibundlesubstageproperties.webpackversion
|
||||
- title: ICleanStageContext
|
||||
url: /pages/api/heft.icleanstagecontext
|
||||
- title: ICleanStageProperties
|
||||
|
@ -1685,17 +1742,6 @@ api_nav:
|
|||
url: /pages/api/heft.icleanstageproperties.deletecache
|
||||
- title: pathsToDelete
|
||||
url: /pages/api/heft.icleanstageproperties.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: ICompileSubstage
|
||||
url: /pages/api/heft.icompilesubstage
|
||||
- title: ICompileSubstageProperties
|
||||
|
@ -1725,8 +1771,8 @@ api_nav:
|
|||
url: /pages/api/heft.icustomactionparameterbase.description
|
||||
- title: kind
|
||||
url: /pages/api/heft.icustomactionparameterbase.kind
|
||||
- title: paramterLongName
|
||||
url: /pages/api/heft.icustomactionparameterbase.paramterlongname
|
||||
- title: parameterLongName
|
||||
url: /pages/api/heft.icustomactionparameterbase.parameterlongname
|
||||
- title: ICustomActionParameterFlag
|
||||
url: /pages/api/heft.icustomactionparameterflag
|
||||
subitems:
|
||||
|
@ -1761,6 +1807,8 @@ api_nav:
|
|||
url: /pages/api/heft.iheftplugin.accessor
|
||||
- title: apply
|
||||
url: /pages/api/heft.iheftplugin.apply
|
||||
- title: optionsSchema
|
||||
url: /pages/api/heft.iheftplugin.optionsschema
|
||||
- title: pluginName
|
||||
url: /pages/api/heft.iheftplugin.pluginname
|
||||
- title: IHeftSessionHooks
|
||||
|
@ -1818,10 +1866,14 @@ api_nav:
|
|||
subitems:
|
||||
- title: debugHeftReporter
|
||||
url: /pages/api/heft.iteststageproperties.debugheftreporter
|
||||
- title: detectOpenHandles
|
||||
url: /pages/api/heft.iteststageproperties.detectopenhandles
|
||||
- title: findRelatedTests
|
||||
url: /pages/api/heft.iteststageproperties.findrelatedtests
|
||||
- title: maxWorkers
|
||||
url: /pages/api/heft.iteststageproperties.maxworkers
|
||||
- title: passWithNoTests
|
||||
url: /pages/api/heft.iteststageproperties.passwithnotests
|
||||
- title: silent
|
||||
url: /pages/api/heft.iteststageproperties.silent
|
||||
- title: testNamePattern
|
||||
|
@ -1834,13 +1886,6 @@ api_nav:
|
|||
url: /pages/api/heft.iteststageproperties.updatesnapshots
|
||||
- title: watchMode
|
||||
url: /pages/api/heft.iteststageproperties.watchmode
|
||||
- title: IWebpackConfiguration
|
||||
url: /pages/api/heft.iwebpackconfiguration
|
||||
- title: IWebpackConfigurationWithDevServer
|
||||
url: /pages/api/heft.iwebpackconfigurationwithdevserver
|
||||
subitems:
|
||||
- title: devServer
|
||||
url: /pages/api/heft.iwebpackconfigurationwithdevserver.devserver
|
||||
- title: MetricsCollectorHooks
|
||||
url: /pages/api/heft.metricscollectorhooks
|
||||
subitems:
|
||||
|
@ -1901,6 +1946,8 @@ api_nav:
|
|||
url: /pages/api/heft-config-file.configurationfile.getpropertyoriginalvalue
|
||||
- title: loadConfigurationFileForProjectAsync
|
||||
url: /pages/api/heft-config-file.configurationfile.loadconfigurationfileforprojectasync
|
||||
- title: projectRelativeFilePath
|
||||
url: /pages/api/heft-config-file.configurationfile.projectrelativefilepath
|
||||
- title: tryLoadConfigurationFileForProjectAsync
|
||||
url: /pages/api/heft-config-file.configurationfile.tryloadconfigurationfileforprojectasync
|
||||
- title: IConfigurationFileOptions
|
||||
|
@ -1924,6 +1971,8 @@ api_nav:
|
|||
subitems:
|
||||
- title: pathResolutionMethod
|
||||
url: /pages/api/heft-config-file.ijsonpathmetadata.pathresolutionmethod
|
||||
- title: preresolve
|
||||
url: /pages/api/heft-config-file.ijsonpathmetadata.preresolve
|
||||
- title: IJsonPathsMetadata
|
||||
url: /pages/api/heft-config-file.ijsonpathsmetadata
|
||||
- title: InheritanceType
|
||||
|
@ -2298,6 +2347,15 @@ api_nav:
|
|||
url: /pages/api/node-core-library.ansiescape.formatfortests
|
||||
- title: removeCodes
|
||||
url: /pages/api/node-core-library.ansiescape.removecodes
|
||||
- title: Async
|
||||
url: /pages/api/node-core-library.async
|
||||
subitems:
|
||||
- title: forEachAsync
|
||||
url: /pages/api/node-core-library.async.foreachasync
|
||||
- title: mapAsync
|
||||
url: /pages/api/node-core-library.async.mapasync
|
||||
- title: sleep
|
||||
url: /pages/api/node-core-library.async.sleep
|
||||
- title: Brand
|
||||
url: /pages/api/node-core-library.brand
|
||||
- title: Colors
|
||||
|
@ -2379,9 +2437,36 @@ api_nav:
|
|||
url: /pages/api/node-core-library.enum.trygetkeybynumber
|
||||
- title: tryGetValueByKey
|
||||
url: /pages/api/node-core-library.enum.trygetvaluebykey
|
||||
- title: EnvironmentMap
|
||||
url: /pages/api/node-core-library.environmentmap
|
||||
subitems:
|
||||
- title: (constructor)
|
||||
url: /pages/api/node-core-library.environmentmap._constructor_
|
||||
- title: caseSensitive
|
||||
url: /pages/api/node-core-library.environmentmap.casesensitive
|
||||
- title: clear
|
||||
url: /pages/api/node-core-library.environmentmap.clear
|
||||
- title: entries
|
||||
url: /pages/api/node-core-library.environmentmap.entries
|
||||
- title: get
|
||||
url: /pages/api/node-core-library.environmentmap.get
|
||||
- title: mergeFrom
|
||||
url: /pages/api/node-core-library.environmentmap.mergefrom
|
||||
- title: mergeFromObject
|
||||
url: /pages/api/node-core-library.environmentmap.mergefromobject
|
||||
- title: names
|
||||
url: /pages/api/node-core-library.environmentmap.names
|
||||
- title: set
|
||||
url: /pages/api/node-core-library.environmentmap.set
|
||||
- title: toObject
|
||||
url: /pages/api/node-core-library.environmentmap.toobject
|
||||
- title: unset
|
||||
url: /pages/api/node-core-library.environmentmap.unset
|
||||
- title: Executable
|
||||
url: /pages/api/node-core-library.executable
|
||||
subitems:
|
||||
- title: spawn
|
||||
url: /pages/api/node-core-library.executable.spawn
|
||||
- title: spawnSync
|
||||
url: /pages/api/node-core-library.executable.spawnsync
|
||||
- title: tryResolve
|
||||
|
@ -2411,8 +2496,6 @@ api_nav:
|
|||
url: /pages/api/node-core-library.filesystem.copyfiles
|
||||
- title: copyFilesAsync
|
||||
url: /pages/api/node-core-library.filesystem.copyfilesasync
|
||||
- title: copyFileToManyAsync
|
||||
url: /pages/api/node-core-library.filesystem.copyfiletomanyasync
|
||||
- title: createHardLink
|
||||
url: /pages/api/node-core-library.filesystem.createhardlink
|
||||
- title: createHardLinkAsync
|
||||
|
@ -2527,6 +2610,11 @@ api_nav:
|
|||
subitems:
|
||||
- title: encodeNewlines
|
||||
url: /pages/api/node-core-library.iansiescapeconvertfortestsoptions.encodenewlines
|
||||
- title: IAsyncParallelismOptions
|
||||
url: /pages/api/node-core-library.iasyncparallelismoptions
|
||||
subitems:
|
||||
- title: concurrency
|
||||
url: /pages/api/node-core-library.iasyncparallelismoptions.concurrency
|
||||
- title: IColorableSequence
|
||||
url: /pages/api/node-core-library.icolorablesequence
|
||||
subitems:
|
||||
|
@ -2545,6 +2633,13 @@ api_nav:
|
|||
subitems:
|
||||
- title: verboseEnabled
|
||||
url: /pages/api/node-core-library.iconsoleterminalprovideroptions.verboseenabled
|
||||
- title: IEnvironmentEntry
|
||||
url: /pages/api/node-core-library.ienvironmententry
|
||||
subitems:
|
||||
- title: name
|
||||
url: /pages/api/node-core-library.ienvironmententry.name
|
||||
- title: value
|
||||
url: /pages/api/node-core-library.ienvironmententry.value
|
||||
- title: IExecutableResolveOptions
|
||||
url: /pages/api/node-core-library.iexecutableresolveoptions
|
||||
subitems:
|
||||
|
@ -2552,6 +2647,13 @@ api_nav:
|
|||
url: /pages/api/node-core-library.iexecutableresolveoptions.currentworkingdirectory
|
||||
- title: environment
|
||||
url: /pages/api/node-core-library.iexecutableresolveoptions.environment
|
||||
- title: environmentMap
|
||||
url: /pages/api/node-core-library.iexecutableresolveoptions.environmentmap
|
||||
- title: IExecutableSpawnOptions
|
||||
url: /pages/api/node-core-library.iexecutablespawnoptions
|
||||
subitems:
|
||||
- title: stdio
|
||||
url: /pages/api/node-core-library.iexecutablespawnoptions.stdio
|
||||
- title: IExecutableSpawnSyncOptions
|
||||
url: /pages/api/node-core-library.iexecutablespawnsyncoptions
|
||||
subitems:
|
||||
|
@ -2595,11 +2697,6 @@ api_nav:
|
|||
subitems:
|
||||
- title: filter
|
||||
url: /pages/api/node-core-library.ifilesystemcopyfilesoptions.filter
|
||||
- title: IFileSystemCopyFileToManyOptions
|
||||
url: /pages/api/node-core-library.ifilesystemcopyfiletomanyoptions
|
||||
subitems:
|
||||
- title: destinationPaths
|
||||
url: /pages/api/node-core-library.ifilesystemcopyfiletomanyoptions.destinationpaths
|
||||
- title: IFileSystemCreateLinkOptions
|
||||
url: /pages/api/node-core-library.ifilesystemcreatelinkoptions
|
||||
subitems:
|
||||
|
@ -2693,6 +2790,8 @@ api_nav:
|
|||
subitems:
|
||||
- title: headerComment
|
||||
url: /pages/api/node-core-library.ijsonfilestringifyoptions.headercomment
|
||||
- title: ignoreUndefinedValues
|
||||
url: /pages/api/node-core-library.ijsonfilestringifyoptions.ignoreundefinedvalues
|
||||
- title: newlineConversion
|
||||
url: /pages/api/node-core-library.ijsonfilestringifyoptions.newlineconversion
|
||||
- title: prettyFormatting
|
||||
|
@ -2748,6 +2847,8 @@ api_nav:
|
|||
url: /pages/api/node-core-library.inodepackagejson.private
|
||||
- title: repository
|
||||
url: /pages/api/node-core-library.inodepackagejson.repository
|
||||
- title: resolutions
|
||||
url: /pages/api/node-core-library.inodepackagejson.resolutions
|
||||
- title: scripts
|
||||
url: /pages/api/node-core-library.inodepackagejson.scripts
|
||||
- title: tsdocMetadata
|
||||
|
@ -3136,13 +3237,6 @@ api_nav:
|
|||
url: /pages/api/package-deps-hash.getgithashforfiles
|
||||
- title: getPackageDeps
|
||||
url: /pages/api/package-deps-hash.getpackagedeps
|
||||
- title: IPackageDeps
|
||||
url: /pages/api/package-deps-hash.ipackagedeps
|
||||
subitems:
|
||||
- title: arguments
|
||||
url: /pages/api/package-deps-hash.ipackagedeps.arguments
|
||||
- title: files
|
||||
url: /pages/api/package-deps-hash.ipackagedeps.files
|
||||
- title: '@rushstack/rig-package'
|
||||
url: /pages/api/rig-package
|
||||
subitems:
|
||||
|
|
|
@ -35,6 +35,7 @@ This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of c
|
|||
| [containerKey](./api-extractor-model.apipackage.containerkey.md) | | string | |
|
||||
| [entryPoints](./api-extractor-model.apipackage.entrypoints.md) | | ReadonlyArray<[ApiEntryPoint](./api-extractor-model.apientrypoint.md)<!-- -->> | |
|
||||
| [kind](./api-extractor-model.apipackage.kind.md) | | [ApiItemKind](./api-extractor-model.apiitemkind.md) | |
|
||||
| [tsdocConfiguration](./api-extractor-model.apipackage.tsdocconfiguration.md) | | TSDocConfiguration | The TSDoc configuration that was used when analyzing the API for this package. |
|
||||
|
||||
## Methods
|
||||
|
||||
|
|
|
@ -1,31 +0,0 @@
|
|||
---
|
||||
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) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPropertyItem](./api-extractor-model.apipropertyitem.md) > [isOptional](./api-extractor-model.apipropertyitem.isoptional.md)
|
||||
|
||||
## ApiPropertyItem.isOptional property
|
||||
|
||||
True if this is an optional property.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly isOptional: boolean;
|
||||
```
|
||||
|
||||
## Remarks
|
||||
|
||||
For example:
|
||||
|
||||
```ts
|
||||
interface X {
|
||||
y: string; // not optional
|
||||
z?: string; // optional
|
||||
}
|
||||
|
||||
```
|
||||
|
|
@ -29,7 +29,6 @@ export declare class ApiPropertyItem extends ApiPropertyItem_base
|
|||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [isEventProperty](./api-extractor-model.apipropertyitem.iseventproperty.md) | | boolean | Returns true if this property should be documented as an event. |
|
||||
| [isOptional](./api-extractor-model.apipropertyitem.isoptional.md) | | boolean | True if this is an optional property. |
|
||||
| [propertyTypeExcerpt](./api-extractor-model.apipropertyitem.propertytypeexcerpt.md) | | [Excerpt](./api-extractor-model.excerpt.md) | An [Excerpt](./api-extractor-model.excerpt.md) that describes the type of the property. |
|
||||
|
||||
## Methods
|
||||
|
|
|
@ -14,7 +14,7 @@ Constructor options for [ApiMethod](./api-extractor-model.apimethod.md)<!-- -->.
|
|||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IApiMethodOptions extends IApiNameMixinOptions, IApiTypeParameterListMixinOptions, IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiStaticMixinOptions, IApiDeclaredItemOptions
|
||||
export interface IApiMethodOptions extends IApiNameMixinOptions, IApiTypeParameterListMixinOptions, IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiStaticMixinOptions, IApiOptionalMixinOptions, IApiDeclaredItemOptions
|
||||
```
|
||||
<b>Extends:</b> [IApiNameMixinOptions](./api-extractor-model.iapinamemixinoptions.md)<!-- -->, [IApiTypeParameterListMixinOptions](./api-extractor-model.iapitypeparameterlistmixinoptions.md)<!-- -->, [IApiParameterListMixinOptions](./api-extractor-model.iapiparameterlistmixinoptions.md)<!-- -->, [IApiReleaseTagMixinOptions](./api-extractor-model.iapireleasetagmixinoptions.md)<!-- -->, [IApiReturnTypeMixinOptions](./api-extractor-model.iapireturntypemixinoptions.md)<!-- -->, [IApiStaticMixinOptions](./api-extractor-model.iapistaticmixinoptions.md)<!-- -->, [IApiDeclaredItemOptions](./api-extractor-model.iapideclareditemoptions.md)
|
||||
<b>Extends:</b> [IApiNameMixinOptions](./api-extractor-model.iapinamemixinoptions.md)<!-- -->, [IApiTypeParameterListMixinOptions](./api-extractor-model.iapitypeparameterlistmixinoptions.md)<!-- -->, [IApiParameterListMixinOptions](./api-extractor-model.iapiparameterlistmixinoptions.md)<!-- -->, [IApiReleaseTagMixinOptions](./api-extractor-model.iapireleasetagmixinoptions.md)<!-- -->, [IApiReturnTypeMixinOptions](./api-extractor-model.iapireturntypemixinoptions.md)<!-- -->, [IApiStaticMixinOptions](./api-extractor-model.iapistaticmixinoptions.md)<!-- -->, [IApiOptionalMixinOptions](./api-extractor-model.iapioptionalmixinoptions.md)<!-- -->, [IApiDeclaredItemOptions](./api-extractor-model.iapideclareditemoptions.md)
|
||||
|
||||
|
|
|
@ -13,7 +13,7 @@ improve_this_button: false
|
|||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IApiMethodSignatureOptions extends IApiNameMixinOptions, IApiTypeParameterListMixinOptions, IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiDeclaredItemOptions
|
||||
export interface IApiMethodSignatureOptions extends IApiNameMixinOptions, IApiTypeParameterListMixinOptions, IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiOptionalMixinOptions, IApiDeclaredItemOptions
|
||||
```
|
||||
<b>Extends:</b> [IApiNameMixinOptions](./api-extractor-model.iapinamemixinoptions.md)<!-- -->, [IApiTypeParameterListMixinOptions](./api-extractor-model.iapitypeparameterlistmixinoptions.md)<!-- -->, [IApiParameterListMixinOptions](./api-extractor-model.iapiparameterlistmixinoptions.md)<!-- -->, [IApiReleaseTagMixinOptions](./api-extractor-model.iapireleasetagmixinoptions.md)<!-- -->, [IApiReturnTypeMixinOptions](./api-extractor-model.iapireturntypemixinoptions.md)<!-- -->, [IApiDeclaredItemOptions](./api-extractor-model.iapideclareditemoptions.md)
|
||||
<b>Extends:</b> [IApiNameMixinOptions](./api-extractor-model.iapinamemixinoptions.md)<!-- -->, [IApiTypeParameterListMixinOptions](./api-extractor-model.iapitypeparameterlistmixinoptions.md)<!-- -->, [IApiParameterListMixinOptions](./api-extractor-model.iapiparameterlistmixinoptions.md)<!-- -->, [IApiReleaseTagMixinOptions](./api-extractor-model.iapireleasetagmixinoptions.md)<!-- -->, [IApiReturnTypeMixinOptions](./api-extractor-model.iapireturntypemixinoptions.md)<!-- -->, [IApiOptionalMixinOptions](./api-extractor-model.iapioptionalmixinoptions.md)<!-- -->, [IApiDeclaredItemOptions](./api-extractor-model.iapideclareditemoptions.md)
|
||||
|
||||
|
|
|
@ -18,3 +18,9 @@ export interface IApiPackageOptions extends IApiItemContainerMixinOptions, IApiN
|
|||
```
|
||||
<b>Extends:</b> [IApiItemContainerMixinOptions](./api-extractor-model.iapiitemcontainermixinoptions.md)<!-- -->, [IApiNameMixinOptions](./api-extractor-model.iapinamemixinoptions.md)<!-- -->, [IApiDocumentedItemOptions](./api-extractor-model.iapidocumenteditemoptions.md)
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [tsdocConfiguration](./api-extractor-model.iapipackageoptions.tsdocconfiguration.md) | TSDocConfiguration | |
|
||||
|
||||
|
|
|
@ -1,16 +0,0 @@
|
|||
---
|
||||
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) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiPropertyItemOptions](./api-extractor-model.iapipropertyitemoptions.md) > [isOptional](./api-extractor-model.iapipropertyitemoptions.isoptional.md)
|
||||
|
||||
## IApiPropertyItemOptions.isOptional property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
isOptional?: boolean;
|
||||
```
|
|
@ -14,14 +14,13 @@ Constructor options for [ApiPropertyItem](./api-extractor-model.apipropertyitem.
|
|||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IApiPropertyItemOptions extends IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions
|
||||
export interface IApiPropertyItemOptions extends IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiOptionalMixinOptions, IApiDeclaredItemOptions
|
||||
```
|
||||
<b>Extends:</b> [IApiNameMixinOptions](./api-extractor-model.iapinamemixinoptions.md)<!-- -->, [IApiReleaseTagMixinOptions](./api-extractor-model.iapireleasetagmixinoptions.md)<!-- -->, [IApiDeclaredItemOptions](./api-extractor-model.iapideclareditemoptions.md)
|
||||
<b>Extends:</b> [IApiNameMixinOptions](./api-extractor-model.iapinamemixinoptions.md)<!-- -->, [IApiReleaseTagMixinOptions](./api-extractor-model.iapireleasetagmixinoptions.md)<!-- -->, [IApiOptionalMixinOptions](./api-extractor-model.iapioptionalmixinoptions.md)<!-- -->, [IApiDeclaredItemOptions](./api-extractor-model.iapideclareditemoptions.md)
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [isOptional?](./api-extractor-model.iapipropertyitemoptions.isoptional.md) | boolean | <i>(Optional)</i> |
|
||||
| [propertyTypeTokenRange](./api-extractor-model.iapipropertyitemoptions.propertytypetokenrange.md) | [IExcerptTokenRange](./api-extractor-model.iexcerpttokenrange.md) | |
|
||||
|
||||
|
|
|
@ -58,6 +58,7 @@ Use this library to read and write \*.api.json files as defined by the [API Extr
|
|||
| --- | --- |
|
||||
| [ApiItemContainerMixin(baseClass)](./api-extractor-model.apiitemcontainermixin.md) | Mixin function for [ApiDeclaredItem](./api-extractor-model.apideclareditem.md)<!-- -->. |
|
||||
| [ApiNameMixin(baseClass)](./api-extractor-model.apinamemixin.md) | Mixin function for [ApiNameMixin](./api-extractor-model.apinamemixin.md)<!-- -->. |
|
||||
| [ApiOptionalMixin(baseClass)](./api-extractor-model.apioptionalmixin.md) | Mixin function for [ApiOptionalMixin](./api-extractor-model.apioptionalmixin.md)<!-- -->. |
|
||||
| [ApiParameterListMixin(baseClass)](./api-extractor-model.apiparameterlistmixin.md) | Mixin function for [ApiParameterListMixin](./api-extractor-model.apiparameterlistmixin.md)<!-- -->. |
|
||||
| [ApiReleaseTagMixin(baseClass)](./api-extractor-model.apireleasetagmixin.md) | Mixin function for [ApiReleaseTagMixin](./api-extractor-model.apireleasetagmixin.md)<!-- -->. |
|
||||
| [ApiReturnTypeMixin(baseClass)](./api-extractor-model.apireturntypemixin.md) | Mixin function for [ApiReturnTypeMixin](./api-extractor-model.apireturntypemixin.md)<!-- -->. |
|
||||
|
@ -70,6 +71,7 @@ Use this library to read and write \*.api.json files as defined by the [API Extr
|
|||
| --- | --- |
|
||||
| [ApiItemContainerMixin](./api-extractor-model.apiitemcontainermixin.md) | The mixin base class for API items that act as containers for other child items. |
|
||||
| [ApiNameMixin](./api-extractor-model.apinamemixin.md) | The mixin base class for API items that have a name. For example, a class has a name, but a class constructor does not. |
|
||||
| [ApiOptionalMixin](./api-extractor-model.apioptionalmixin.md) | The mixin base class for API items that can be marked as optional by appending a <code>?</code> to them. For example, a property of an interface can be optional. |
|
||||
| [ApiParameterListMixin](./api-extractor-model.apiparameterlistmixin.md) | The mixin base class for API items that can have function parameters (but not necessarily a return value). |
|
||||
| [ApiReleaseTagMixin](./api-extractor-model.apireleasetagmixin.md) | The mixin base class for API items that can be attributed with a TSDoc tag such as <code>@internal</code>, <code>@alpha</code>, <code>@beta</code>, or <code>@public</code>. These "release tags" indicate the support level for an API. |
|
||||
| [ApiReturnTypeMixin](./api-extractor-model.apireturntypemixin.md) | The mixin base class for API items that are functions that return a value. |
|
||||
|
@ -94,6 +96,7 @@ Use this library to read and write \*.api.json files as defined by the [API Extr
|
|||
| [IApiMethodSignatureOptions](./api-extractor-model.iapimethodsignatureoptions.md) | |
|
||||
| [IApiNameMixinOptions](./api-extractor-model.iapinamemixinoptions.md) | Constructor options for [IApiNameMixinOptions](./api-extractor-model.iapinamemixinoptions.md)<!-- -->. |
|
||||
| [IApiNamespaceOptions](./api-extractor-model.iapinamespaceoptions.md) | Constructor options for [ApiClass](./api-extractor-model.apiclass.md)<!-- -->. |
|
||||
| [IApiOptionalMixinOptions](./api-extractor-model.iapioptionalmixinoptions.md) | Constructor options for [IApiOptionalMixinOptions](./api-extractor-model.iapioptionalmixinoptions.md)<!-- -->. |
|
||||
| [IApiPackageOptions](./api-extractor-model.iapipackageoptions.md) | Constructor options for [ApiPackage](./api-extractor-model.apipackage.md)<!-- -->. |
|
||||
| [IApiPackageSaveOptions](./api-extractor-model.iapipackagesaveoptions.md) | Options for [ApiPackage.saveToJsonFile()](./api-extractor-model.apipackage.savetojsonfile.md)<!-- -->. |
|
||||
| [IApiParameterListMixinOptions](./api-extractor-model.iapiparameterlistmixinoptions.md) | Constructor options for [ApiParameterListMixin](./api-extractor-model.apiparameterlistmixin.md)<!-- -->. |
|
||||
|
@ -120,6 +123,7 @@ Use this library to read and write \*.api.json files as defined by the [API Extr
|
|||
| --- | --- |
|
||||
| [ApiItemContainerMixin](./api-extractor-model.apiitemcontainermixin.md) | Static members for [ApiItemContainerMixin](./api-extractor-model.apiitemcontainermixin.md)<!-- -->. |
|
||||
| [ApiNameMixin](./api-extractor-model.apinamemixin.md) | Static members for [ApiNameMixin](./api-extractor-model.apinamemixin.md)<!-- -->. |
|
||||
| [ApiOptionalMixin](./api-extractor-model.apioptionalmixin.md) | Optional members for [ApiOptionalMixin](./api-extractor-model.apioptionalmixin.md)<!-- -->. |
|
||||
| [ApiParameterListMixin](./api-extractor-model.apiparameterlistmixin.md) | Static members for [ApiParameterListMixin](./api-extractor-model.apiparameterlistmixin.md)<!-- -->. |
|
||||
| [ApiReleaseTagMixin](./api-extractor-model.apireleasetagmixin.md) | Static members for [ApiReleaseTagMixin](./api-extractor-model.apireleasetagmixin.md)<!-- -->. |
|
||||
| [ApiReturnTypeMixin](./api-extractor-model.apireturntypemixin.md) | Static members for [ApiReturnTypeMixin](./api-extractor-model.apireturntypemixin.md)<!-- -->. |
|
||||
|
|
|
@ -30,6 +30,7 @@ export declare const enum ConsoleMessageId
|
|||
| 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 \_\_\_" |
|
||||
| UsingCustomTSDocConfig | <code>"console-using-custom-tsdoc-config"</code> | "Using custom TSDoc config from \_\_\_" |
|
||||
| WritingDocModelFile | <code>"console-writing-doc-model-file"</code> | "Writing: \_\_\_" |
|
||||
| WritingDtsRollup | <code>"console-writing-dts-rollup"</code> | "Writing package typings: \_\_\_" |
|
||||
|
||||
|
|
|
@ -43,6 +43,8 @@ export declare class ExtractorConfig
|
|||
| [skipLibCheck](./api-extractor.extractorconfig.skiplibcheck.md) | | boolean | This option causes the compiler to be invoked with the <code>--skipLibCheck</code> option. |
|
||||
| [testMode](./api-extractor.extractorconfig.testmode.md) | | boolean | Set to true when invoking API Extractor's test harness. |
|
||||
| [tsconfigFilePath](./api-extractor.extractorconfig.tsconfigfilepath.md) | | string | Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project. |
|
||||
| [tsdocConfigFile](./api-extractor.extractorconfig.tsdocconfigfile.md) | | TSDocConfigFile | The tsdoc.json configuration that will be used when parsing doc comments. |
|
||||
| [tsdocConfiguration](./api-extractor.extractorconfig.tsdocconfiguration.md) | | TSDocConfiguration | The <code>TSDocConfiguration</code> loaded from [ExtractorConfig.tsdocConfigFile](./api-extractor.extractorconfig.tsdocconfigfile.md)<!-- -->. |
|
||||
| [tsdocMetadataEnabled](./api-extractor.extractorconfig.tsdocmetadataenabled.md) | | boolean | Whether to generate the tsdoc-metadata.json file. |
|
||||
| [tsdocMetadataFilePath](./api-extractor.extractorconfig.tsdocmetadatafilepath.md) | | string | Specifies where the TSDoc metadata file should be written. |
|
||||
| [untrimmedFilePath](./api-extractor.extractorconfig.untrimmedfilepath.md) | | string | Specifies the output path for a .d.ts rollup file to be generated without any trimming. |
|
||||
|
|
|
@ -26,4 +26,5 @@ export interface IExtractorConfigPrepareOptions
|
|||
| [packageJson?](./api-extractor.iextractorconfigprepareoptions.packagejson.md) | [INodePackageJson](./node-core-library.inodepackagejson.md) \| undefined | <i>(Optional)</i> The parsed package.json file for the working package, or undefined if API Extractor was invoked without a package.json file. |
|
||||
| [packageJsonFullPath](./api-extractor.iextractorconfigprepareoptions.packagejsonfullpath.md) | string \| undefined | The absolute path of the file that the <code>packageJson</code> object was loaded from, or undefined if API Extractor was invoked without a package.json file. |
|
||||
| [projectFolderLookupToken?](./api-extractor.iextractorconfigprepareoptions.projectfolderlookuptoken.md) | string | <i>(Optional)</i> The default value for the <code>projectFolder</code> setting is the <code><lookup></code> token, which uses a heuristic to guess an appropriate project folder. Use <code>projectFolderLookupValue</code> to manually specify the <code><lookup></code> token value instead. |
|
||||
| [tsdocConfigFile?](./api-extractor.iextractorconfigprepareoptions.tsdocconfigfile.md) | TSDocConfigFile | <i>(Optional)</i> Allow customization of the tsdoc.json config file. If omitted, this file will be loaded from its default location. If the file does not exist, then the standard definitions will be used from <code>@microsoft/api-extractor/extends/tsdoc-base.json</code>. |
|
||||
|
||||
|
|
|
@ -1,30 +0,0 @@
|
|||
---
|
||||
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/debug-certificate-manager](./debug-certificate-manager.md) > [CertificateManager](./debug-certificate-manager.certificatemanager.md) > [ensureCertificate](./debug-certificate-manager.certificatemanager.ensurecertificate.md)
|
||||
|
||||
## CertificateManager.ensureCertificate() method
|
||||
|
||||
Get a dev certificate from the store, or optionally, generate a new one and trust it if one doesn't exist in the store.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
ensureCertificate(canGenerateNewCertificate: boolean, terminal: Terminal): ICertificate;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| canGenerateNewCertificate | boolean | |
|
||||
| terminal | [Terminal](./node-core-library.terminal.md) | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[ICertificate](./debug-certificate-manager.icertificate.md)
|
||||
|
|
@ -27,6 +27,6 @@ export declare class CertificateManager
|
|||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [ensureCertificate(canGenerateNewCertificate, terminal)](./debug-certificate-manager.certificatemanager.ensurecertificate.md) | | Get a dev certificate from the store, or optionally, generate a new one and trust it if one doesn't exist in the store. |
|
||||
| [untrustCertificate(terminal)](./debug-certificate-manager.certificatemanager.untrustcertificate.md) | | Attempt to locate a previously generated debug certificate and untrust it. |
|
||||
| [ensureCertificateAsync(canGenerateNewCertificate, terminal)](./debug-certificate-manager.certificatemanager.ensurecertificateasync.md) | | Get a dev certificate from the store, or optionally, generate a new one and trust it if one doesn't exist in the store. |
|
||||
| [untrustCertificateAsync(terminal)](./debug-certificate-manager.certificatemanager.untrustcertificateasync.md) | | Attempt to locate a previously generated debug certificate and untrust it. |
|
||||
|
||||
|
|
|
@ -1,29 +0,0 @@
|
|||
---
|
||||
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/debug-certificate-manager](./debug-certificate-manager.md) > [CertificateManager](./debug-certificate-manager.certificatemanager.md) > [untrustCertificate](./debug-certificate-manager.certificatemanager.untrustcertificate.md)
|
||||
|
||||
## CertificateManager.untrustCertificate() method
|
||||
|
||||
Attempt to locate a previously generated debug certificate and untrust it.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
untrustCertificate(terminal: Terminal): boolean;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| terminal | [Terminal](./node-core-library.terminal.md) | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
boolean
|
||||
|
|
@ -12,6 +12,8 @@ improve_this_button: false
|
|||
> 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.
|
||||
>
|
||||
|
||||
Find and return a configuration file for the specified project, automatically resolving `extends` properties and handling rigged configuration files. Will throw an error if a configuration file cannot be found in the rig or project config folder.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
|
|
|
@ -25,12 +25,18 @@ export declare class ConfigurationFile<TConfigurationFile>
|
|||
| --- | --- | --- |
|
||||
| [(constructor)(options)](./heft-config-file.configurationfile._constructor_.md) | | <b><i>(BETA)</i></b> Constructs a new instance of the <code>ConfigurationFile</code> class |
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [projectRelativeFilePath](./heft-config-file.configurationfile.projectrelativefilepath.md) | | string | <b><i>(BETA)</i></b> A project root-relative path to the configuration file that should be loaded. |
|
||||
|
||||
## Methods
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [getObjectSourceFilePath(obj)](./heft-config-file.configurationfile.getobjectsourcefilepath.md) | | <b><i>(BETA)</i></b> Get the path to the source file that the referenced property was originally loaded from. |
|
||||
| [getPropertyOriginalValue(options)](./heft-config-file.configurationfile.getpropertyoriginalvalue.md) | | <b><i>(BETA)</i></b> Get the value of the specified property on the specified object that was originally loaded from a configuration file. |
|
||||
| [loadConfigurationFileForProjectAsync(terminal, projectPath, rigConfig)](./heft-config-file.configurationfile.loadconfigurationfileforprojectasync.md) | | <b><i>(BETA)</i></b> |
|
||||
| [tryLoadConfigurationFileForProjectAsync(terminal, projectPath, rigConfig)](./heft-config-file.configurationfile.tryloadconfigurationfileforprojectasync.md) | | <b><i>(BETA)</i></b> This function is identical to [ConfigurationFile.loadConfigurationFileForProjectAsync()](./heft-config-file.configurationfile.loadconfigurationfileforprojectasync.md)<!-- -->, except that a preliminary file existence check is performed and this function returns <code>undefined</code> if the configuration file doesn't exist. |
|
||||
| [loadConfigurationFileForProjectAsync(terminal, projectPath, rigConfig)](./heft-config-file.configurationfile.loadconfigurationfileforprojectasync.md) | | <b><i>(BETA)</i></b> Find and return a configuration file for the specified project, automatically resolving <code>extends</code> properties and handling rigged configuration files. Will throw an error if a configuration file cannot be found in the rig or project config folder. |
|
||||
| [tryLoadConfigurationFileForProjectAsync(terminal, projectPath, rigConfig)](./heft-config-file.configurationfile.tryloadconfigurationfileforprojectasync.md) | | <b><i>(BETA)</i></b> This function is identical to [ConfigurationFile.loadConfigurationFileForProjectAsync()](./heft-config-file.configurationfile.loadconfigurationfileforprojectasync.md)<!-- -->, except that it returns <code>undefined</code> instead of throwing an error if the configuration file cannot be found. |
|
||||
|
||||
|
|
|
@ -12,7 +12,7 @@ improve_this_button: false
|
|||
> 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 function is identical to [ConfigurationFile.loadConfigurationFileForProjectAsync()](./heft-config-file.configurationfile.loadconfigurationfileforprojectasync.md)<!-- -->, except that a preliminary file existence check is performed and this function returns `undefined` if the configuration file doesn't exist.
|
||||
This function is identical to [ConfigurationFile.loadConfigurationFileForProjectAsync()](./heft-config-file.configurationfile.loadconfigurationfileforprojectasync.md)<!-- -->, except that it returns `undefined` instead of throwing an error if the configuration file cannot be found.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
|
|
|
@ -25,4 +25,5 @@ export interface IJsonPathMetadata
|
|||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [pathResolutionMethod?](./heft-config-file.ijsonpathmetadata.pathresolutionmethod.md) | [PathResolutionMethod](./heft-config-file.pathresolutionmethod.md) | <b><i>(BETA)</i></b> <i>(Optional)</i> If this property describes a filesystem path, use this property to describe how the path should be resolved. |
|
||||
| [preresolve?](./heft-config-file.ijsonpathmetadata.preresolve.md) | (path: string) => string | <b><i>(BETA)</i></b> <i>(Optional)</i> If this property is set, it will be used for manual path modification before the specified <code>IJsonPathMetadata.pathResolutionMethod</code> is executed. |
|
||||
|
||||
|
|
|
@ -12,5 +12,5 @@ improve_this_button: false
|
|||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly configureWebpack: AsyncSeriesWaterfallHook<IWebpackConfiguration>;
|
||||
readonly configureWebpack: AsyncSeriesWaterfallHook<unknown>;
|
||||
```
|
||||
|
|
|
@ -22,5 +22,5 @@ export declare class BundleSubstageHooks extends BuildSubstageHooksBase
|
|||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [afterConfigureWebpack](./heft.bundlesubstagehooks.afterconfigurewebpack.md) | | AsyncSeriesHook | |
|
||||
| [configureWebpack](./heft.bundlesubstagehooks.configurewebpack.md) | | AsyncSeriesWaterfallHook<[IWebpackConfiguration](./heft.iwebpackconfiguration.md)<!-- -->> | |
|
||||
| [configureWebpack](./heft.bundlesubstagehooks.configurewebpack.md) | | AsyncSeriesWaterfallHook<unknown> | |
|
||||
|
||||
|
|
|
@ -17,3 +17,10 @@ export declare class CompileSubstageHooks extends BuildSubstageHooksBase
|
|||
```
|
||||
<b>Extends:</b> [BuildSubstageHooksBase](./heft.buildsubstagehooksbase.md)
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [afterCompile](./heft.compilesubstagehooks.aftercompile.md) | | AsyncParallelHook | |
|
||||
| [afterEachIteration](./heft.compilesubstagehooks.aftereachiteration.md) | | SyncHook | |
|
||||
|
||||
|
|
|
@ -1,18 +0,0 @@
|
|||
---
|
||||
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;
|
||||
```
|
|
@ -22,7 +22,6 @@ export declare class HeftConfiguration
|
|||
| --- | --- | --- | --- |
|
||||
| [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. |
|
||||
| [globalTerminal](./heft.heftconfiguration.globalterminal.md) | | [Terminal](./node-core-library.terminal.md) | Terminal instance to facilitate logging. |
|
||||
| [heftPackageJson](./heft.heftconfiguration.heftpackagejson.md) | | [IPackageJson](./node-core-library.ipackagejson.md) | The Heft tool's package.json |
|
||||
| [projectConfigFolder](./heft.heftconfiguration.projectconfigfolder.md) | | string | The path to the project's "config" folder. |
|
||||
|
|
|
@ -20,11 +20,14 @@ export interface IBuildStageProperties
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [emitExtensionForTests?](./heft.ibuildstageproperties.emitextensionfortests.md) | '.js' \| '.cjs' \| '.mjs' | <b><i>(BETA)</i></b> <i>(Optional)</i> |
|
||||
| [emitFolderNameForTests?](./heft.ibuildstageproperties.emitfoldernamefortests.md) | string | <b><i>(BETA)</i></b> <i>(Optional)</i> |
|
||||
| [isTypeScriptProject?](./heft.ibuildstageproperties.istypescriptproject.md) | boolean | <b><i>(BETA)</i></b> <i>(Optional)</i> |
|
||||
| [lite](./heft.ibuildstageproperties.lite.md) | boolean | |
|
||||
| [locale?](./heft.ibuildstageproperties.locale.md) | string | <i>(Optional)</i> |
|
||||
| [maxOldSpaceSize?](./heft.ibuildstageproperties.maxoldspacesize.md) | string | <i>(Optional)</i> |
|
||||
| [production](./heft.ibuildstageproperties.production.md) | boolean | |
|
||||
| [serveMode](./heft.ibuildstageproperties.servemode.md) | boolean | |
|
||||
| [watchMode](./heft.ibuildstageproperties.watchmode.md) | boolean | |
|
||||
| [webpackStats?](./heft.ibuildstageproperties.webpackstats.md) | webpack.Stats \| webpack.compilation.MultiStats | <i>(Optional)</i> |
|
||||
| [webpackStats?](./heft.ibuildstageproperties.webpackstats.md) | unknown | <i>(Optional)</i> |
|
||||
|
||||
|
|
|
@ -12,5 +12,5 @@ improve_this_button: false
|
|||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
webpackStats?: webpack.Stats | webpack.compilation.MultiStats;
|
||||
webpackStats?: unknown;
|
||||
```
|
||||
|
|
|
@ -20,5 +20,7 @@ export interface IBundleSubstageProperties
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [webpackConfiguration?](./heft.ibundlesubstageproperties.webpackconfiguration.md) | webpack.Configuration \| webpack.Configuration\[\] | <i>(Optional)</i> 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. |
|
||||
| [webpackConfiguration?](./heft.ibundlesubstageproperties.webpackconfiguration.md) | unknown | <i>(Optional)</i> 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. |
|
||||
| [webpackDevServerVersion?](./heft.ibundlesubstageproperties.webpackdevserverversion.md) | string \| undefined | <i>(Optional)</i> If webpack is used, this will be set to the version of the webpack-dev-server package |
|
||||
| [webpackVersion?](./heft.ibundlesubstageproperties.webpackversion.md) | string \| undefined | <i>(Optional)</i> If webpack is used, this will be set to the version of the webpack package |
|
||||
|
||||
|
|
|
@ -14,5 +14,5 @@ The configuration used by the Webpack plugin. This must be populated for Webpack
|
|||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
webpackConfiguration?: webpack.Configuration | webpack.Configuration[];
|
||||
webpackConfiguration?: unknown;
|
||||
```
|
||||
|
|
|
@ -1,16 +0,0 @@
|
|||
---
|
||||
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 | undefined;
|
||||
```
|
|
@ -1,16 +0,0 @@
|
|||
---
|
||||
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 | undefined;
|
||||
```
|
|
@ -1,27 +0,0 @@
|
|||
---
|
||||
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 \| undefined | |
|
||||
| [eslintPackagePath](./heft.icompilerpackage.eslintpackagepath.md) | string \| undefined | |
|
||||
| [tslintPackagePath](./heft.icompilerpackage.tslintpackagepath.md) | string \| undefined | |
|
||||
| [typeScriptPackagePath](./heft.icompilerpackage.typescriptpackagepath.md) | string | |
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
---
|
||||
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 | undefined;
|
||||
```
|
|
@ -1,16 +0,0 @@
|
|||
---
|
||||
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;
|
||||
```
|
|
@ -25,5 +25,5 @@ export interface ICustomActionParameterBase<TParameter extends CustomActionParam
|
|||
| --- | --- | --- |
|
||||
| [description](./heft.icustomactionparameterbase.description.md) | string | <b><i>(BETA)</i></b> |
|
||||
| [kind](./heft.icustomactionparameterbase.kind.md) | 'flag' \| 'integer' \| 'string' \| 'stringList' | <b><i>(BETA)</i></b> |
|
||||
| [paramterLongName](./heft.icustomactionparameterbase.paramterlongname.md) | string | <b><i>(BETA)</i></b> |
|
||||
| [parameterLongName](./heft.icustomactionparameterbase.parameterlongname.md) | string | <b><i>(BETA)</i></b> |
|
||||
|
||||
|
|
|
@ -1,19 +0,0 @@
|
|||
---
|
||||
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) > [ICustomActionParameterBase](./heft.icustomactionparameterbase.md) > [paramterLongName](./heft.icustomactionparameterbase.paramterlongname.md)
|
||||
|
||||
## ICustomActionParameterBase.paramterLongName 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.
|
||||
>
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
paramterLongName: string;
|
||||
```
|
|
@ -21,6 +21,7 @@ export interface IHeftPlugin<TOptions = void>
|
|||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [accessor?](./heft.iheftplugin.accessor.md) | object | <i>(Optional)</i> |
|
||||
| [optionsSchema?](./heft.iheftplugin.optionsschema.md) | [JsonSchema](./node-core-library.jsonschema.md) | <i>(Optional)</i> |
|
||||
| [pluginName](./heft.iheftplugin.pluginname.md) | string | |
|
||||
|
||||
## Methods
|
||||
|
|
|
@ -21,8 +21,10 @@ export interface ITestStageProperties
|
|||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [debugHeftReporter](./heft.iteststageproperties.debugheftreporter.md) | boolean \| undefined | |
|
||||
| [detectOpenHandles](./heft.iteststageproperties.detectopenhandles.md) | boolean \| undefined | |
|
||||
| [findRelatedTests](./heft.iteststageproperties.findrelatedtests.md) | ReadonlyArray<string> \| undefined | |
|
||||
| [maxWorkers](./heft.iteststageproperties.maxworkers.md) | string \| undefined | |
|
||||
| [passWithNoTests](./heft.iteststageproperties.passwithnotests.md) | boolean \| undefined | |
|
||||
| [silent](./heft.iteststageproperties.silent.md) | boolean \| undefined | |
|
||||
| [testNamePattern](./heft.iteststageproperties.testnamepattern.md) | string \| undefined | |
|
||||
| [testPathPattern](./heft.iteststageproperties.testpathpattern.md) | ReadonlyArray<string> \| undefined | |
|
||||
|
|
|
@ -1,19 +0,0 @@
|
|||
---
|
||||
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) > [IWebpackConfiguration](./heft.iwebpackconfiguration.md)
|
||||
|
||||
## IWebpackConfiguration type
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type IWebpackConfiguration = IWebpackConfigurationWithDevServer | IWebpackConfigurationWithDevServer[] | undefined;
|
||||
```
|
||||
<b>References:</b> [IWebpackConfigurationWithDevServer](./heft.iwebpackconfigurationwithdevserver.md)
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
---
|
||||
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) > [IWebpackConfigurationWithDevServer](./heft.iwebpackconfigurationwithdevserver.md) > [devServer](./heft.iwebpackconfigurationwithdevserver.devserver.md)
|
||||
|
||||
## IWebpackConfigurationWithDevServer.devServer property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
devServer?: WebpackDevServerConfiguration;
|
||||
```
|
|
@ -1,25 +0,0 @@
|
|||
---
|
||||
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) > [IWebpackConfigurationWithDevServer](./heft.iwebpackconfigurationwithdevserver.md)
|
||||
|
||||
## IWebpackConfigurationWithDevServer interface
|
||||
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IWebpackConfigurationWithDevServer extends webpack.Configuration
|
||||
```
|
||||
<b>Extends:</b> webpack.Configuration
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [devServer?](./heft.iwebpackconfigurationwithdevserver.devserver.md) | WebpackDevServerConfiguration | <i>(Optional)</i> |
|
||||
|
|
@ -36,7 +36,6 @@ improve_this_button: false
|
|||
| [IBundleSubstageProperties](./heft.ibundlesubstageproperties.md) | |
|
||||
| [ICleanStageContext](./heft.icleanstagecontext.md) | |
|
||||
| [ICleanStageProperties](./heft.icleanstageproperties.md) | |
|
||||
| [ICompilerPackage](./heft.icompilerpackage.md) | |
|
||||
| [ICompileSubstage](./heft.icompilesubstage.md) | |
|
||||
| [ICompileSubstageProperties](./heft.icompilesubstageproperties.md) | |
|
||||
| [ICustomActionOptions](./heft.icustomactionoptions.md) | <b><i>(BETA)</i></b> |
|
||||
|
@ -56,7 +55,6 @@ improve_this_button: false
|
|||
| [IStageContext](./heft.istagecontext.md) | |
|
||||
| [ITestStageContext](./heft.iteststagecontext.md) | |
|
||||
| [ITestStageProperties](./heft.iteststageproperties.md) | |
|
||||
| [IWebpackConfigurationWithDevServer](./heft.iwebpackconfigurationwithdevserver.md) | |
|
||||
|
||||
## Type Aliases
|
||||
|
||||
|
@ -65,7 +63,6 @@ improve_this_button: false
|
|||
| [CopyFromCacheMode](./heft.copyfromcachemode.md) | |
|
||||
| [CustomActionParameterType](./heft.customactionparametertype.md) | <b><i>(BETA)</i></b> |
|
||||
| [ICustomActionParameter](./heft.icustomactionparameter.md) | <b><i>(BETA)</i></b> |
|
||||
| [IWebpackConfiguration](./heft.iwebpackconfiguration.md) | |
|
||||
| [RegisterAction](./heft.registeraction.md) | <b><i>(BETA)</i></b> |
|
||||
| [RequestAccessToPluginByNameCallback](./heft.requestaccesstopluginbynamecallback.md) | <b><i>(BETA)</i></b> |
|
||||
|
||||
|
|
|
@ -20,6 +20,6 @@ export interface IDefaultLocaleOptions
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [fillMissingTranslationStrings](./localization-plugin.idefaultlocaleoptions.fillmissingtranslationstrings.md) | boolean | If this option is set to <code>true</code>, strings that are missing from <code>localizedData.translatedStrings</code> will be provided by the default locale |
|
||||
| [fillMissingTranslationStrings?](./localization-plugin.idefaultlocaleoptions.fillmissingtranslationstrings.md) | boolean | <i>(Optional)</i> If this option is set to <code>true</code>, strings that are missing from <code>localizedData.translatedStrings</code> will be provided by the default locale |
|
||||
| [localeName](./localization-plugin.idefaultlocaleoptions.localename.md) | string | This required property specifies the name of the locale used in the <code>.resx</code> and <code>.loc.json</code> files in the source |
|
||||
|
||||
|
|
|
@ -21,9 +21,9 @@ export interface ILocalizationPluginOptions
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [filesToIgnore](./localization-plugin.ilocalizationpluginoptions.filestoignore.md) | string\[\] | This option is used to specify <code>.resx</code> and <code>.loc.json</code> files that should not be processed by this plugin. |
|
||||
| [localizationStats](./localization-plugin.ilocalizationpluginoptions.localizationstats.md) | [ILocalizationStatsOptions](./localization-plugin.ilocalizationstatsoptions.md) | Options for how localization stats data should be produced. |
|
||||
| [filesToIgnore?](./localization-plugin.ilocalizationpluginoptions.filestoignore.md) | string\[\] | <i>(Optional)</i> This option is used to specify <code>.resx</code> and <code>.loc.json</code> files that should not be processed by this plugin. |
|
||||
| [localizationStats?](./localization-plugin.ilocalizationpluginoptions.localizationstats.md) | [ILocalizationStatsOptions](./localization-plugin.ilocalizationstatsoptions.md) | <i>(Optional)</i> Options for how localization stats data should be produced. |
|
||||
| [localizedData](./localization-plugin.ilocalizationpluginoptions.localizeddata.md) | [ILocalizedData](./localization-plugin.ilocalizeddata.md) | Localization data. |
|
||||
| [noStringsLocaleName](./localization-plugin.ilocalizationpluginoptions.nostringslocalename.md) | string | The value to replace the \[locale\] token with for chunks without localized strings. Defaults to "none" |
|
||||
| [typingsOptions](./localization-plugin.ilocalizationpluginoptions.typingsoptions.md) | [ITypingsGenerationOptions](./localization-plugin.itypingsgenerationoptions.md) | This option is used to specify how and if TypeScript typings should be generated for loc files. |
|
||||
| [noStringsLocaleName?](./localization-plugin.ilocalizationpluginoptions.nostringslocalename.md) | string | <i>(Optional)</i> The value to replace the \[locale\] token with for chunks without localized strings. Defaults to "none" |
|
||||
| [typingsOptions?](./localization-plugin.ilocalizationpluginoptions.typingsoptions.md) | [ITypingsGenerationOptions](./localization-plugin.itypingsgenerationoptions.md) | <i>(Optional)</i> This option is used to specify how and if TypeScript typings should be generated for loc files. |
|
||||
|
||||
|
|
|
@ -21,6 +21,6 @@ export interface ILocalizationStatsOptions
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [callback](./localization-plugin.ilocalizationstatsoptions.callback.md) | (stats: [ILocalizationStats](./localization-plugin.ilocalizationstats.md)<!-- -->) => void | This option is used to specify a callback to be called with the stats data that would be dropped at <code>localizationStats.dropPath</code> after compilation completes. |
|
||||
| [dropPath](./localization-plugin.ilocalizationstatsoptions.droppath.md) | string | This option is used to designate a path at which a JSON file describing the localized assets produced should be written. |
|
||||
| [callback?](./localization-plugin.ilocalizationstatsoptions.callback.md) | (stats: [ILocalizationStats](./localization-plugin.ilocalizationstats.md)<!-- -->) => void | <i>(Optional)</i> This option is used to specify a callback to be called with the stats data that would be dropped at <code>localizationStats.dropPath</code> after compilation completes. |
|
||||
| [dropPath?](./localization-plugin.ilocalizationstatsoptions.droppath.md) | string | <i>(Optional)</i> This option is used to designate a path at which a JSON file describing the localized assets produced should be written. |
|
||||
|
||||
|
|
|
@ -21,9 +21,9 @@ export interface ILocalizedData
|
|||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [defaultLocale](./localization-plugin.ilocalizeddata.defaultlocale.md) | [IDefaultLocaleOptions](./localization-plugin.idefaultlocaleoptions.md) | Options for the locale used in the source localized data files. |
|
||||
| [normalizeResxNewlines](./localization-plugin.ilocalizeddata.normalizeresxnewlines.md) | 'lf' \| 'crlf' | Normalize newlines in RESX files to either CRLF (Windows-style) or LF ('nix style) |
|
||||
| [passthroughLocale](./localization-plugin.ilocalizeddata.passthroughlocale.md) | [IPassthroughLocaleOptions](./localization-plugin.ipassthroughlocaleoptions.md) | Options around including a passthrough locale. |
|
||||
| [pseudolocales](./localization-plugin.ilocalizeddata.pseudolocales.md) | [IPseudolocalesOptions](./localization-plugin.ipseudolocalesoptions.md) | Options for pseudo-localization. |
|
||||
| [resolveMissingTranslatedStrings](./localization-plugin.ilocalizeddata.resolvemissingtranslatedstrings.md) | (locales: string\[\], filePath: string) => [IResolvedMissingTranslations](./localization-plugin.iresolvedmissingtranslations.md) | Use this paramter to specify a function used to load translations missing from the [ILocalizedData.translatedStrings](./localization-plugin.ilocalizeddata.translatedstrings.md) parameter. |
|
||||
| [normalizeResxNewlines?](./localization-plugin.ilocalizeddata.normalizeresxnewlines.md) | 'lf' \| 'crlf' | <i>(Optional)</i> Normalize newlines in RESX files to either CRLF (Windows-style) or LF ('nix style) |
|
||||
| [passthroughLocale?](./localization-plugin.ilocalizeddata.passthroughlocale.md) | [IPassthroughLocaleOptions](./localization-plugin.ipassthroughlocaleoptions.md) | <i>(Optional)</i> Options around including a passthrough locale. |
|
||||
| [pseudolocales?](./localization-plugin.ilocalizeddata.pseudolocales.md) | [IPseudolocalesOptions](./localization-plugin.ipseudolocalesoptions.md) | <i>(Optional)</i> Options for pseudo-localization. |
|
||||
| [resolveMissingTranslatedStrings?](./localization-plugin.ilocalizeddata.resolvemissingtranslatedstrings.md) | (locales: string\[\], filePath: string) => [IResolvedMissingTranslations](./localization-plugin.iresolvedmissingtranslations.md) | <i>(Optional)</i> Use this parameter to specify a function used to load translations missing from the [ILocalizedData.translatedStrings](./localization-plugin.ilocalizeddata.translatedstrings.md) parameter. |
|
||||
| [translatedStrings](./localization-plugin.ilocalizeddata.translatedstrings.md) | [ILocalizedStrings](./localization-plugin.ilocalizedstrings.md) | Use this parameter to specify the translated data. |
|
||||
|
||||
|
|
|
@ -9,7 +9,7 @@ improve_this_button: false
|
|||
|
||||
## ILocalizedData.resolveMissingTranslatedStrings property
|
||||
|
||||
Use this paramter to specify a function used to load translations missing from the [ILocalizedData.translatedStrings](./localization-plugin.ilocalizeddata.translatedstrings.md) parameter.
|
||||
Use this parameter to specify a function used to load translations missing from the [ILocalizedData.translatedStrings](./localization-plugin.ilocalizeddata.translatedstrings.md) parameter.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
|
|
|
@ -21,5 +21,5 @@ export interface ILocalizedWebpackChunk extends webpack.compilation.Chunk
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [localizedFiles](./localization-plugin.ilocalizedwebpackchunk.localizedfiles.md) | { \[locale: string\]: string; } | |
|
||||
| [localizedFiles?](./localization-plugin.ilocalizedwebpackchunk.localizedfiles.md) | { \[locale: string\]: string; } | <i>(Optional)</i> |
|
||||
|
||||
|
|
|
@ -21,6 +21,6 @@ export interface IPassthroughLocaleOptions
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [passthroughLocaleName](./localization-plugin.ipassthroughlocaleoptions.passthroughlocalename.md) | string | If [IPassthroughLocaleOptions.usePassthroughLocale](./localization-plugin.ipassthroughlocaleoptions.usepassthroughlocale.md) is set, use this name for the passthrough locale. Defaults to "passthrough" |
|
||||
| [usePassthroughLocale](./localization-plugin.ipassthroughlocaleoptions.usepassthroughlocale.md) | boolean | If this is set to <code>true</code>, a passthrough locale will be included in the output |
|
||||
| [passthroughLocaleName?](./localization-plugin.ipassthroughlocaleoptions.passthroughlocalename.md) | string | <i>(Optional)</i> If [IPassthroughLocaleOptions.usePassthroughLocale](./localization-plugin.ipassthroughlocaleoptions.usepassthroughlocale.md) is set, use this name for the passthrough locale. Defaults to "passthrough" |
|
||||
| [usePassthroughLocale?](./localization-plugin.ipassthroughlocaleoptions.usepassthroughlocale.md) | boolean | <i>(Optional)</i> If this is set to <code>true</code>, a passthrough locale will be included in the output |
|
||||
|
||||
|
|
|
@ -21,11 +21,11 @@ export interface IPseudolocaleOptions
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [append](./localization-plugin.ipseudolocaleoptions.append.md) | string | |
|
||||
| [delimiter](./localization-plugin.ipseudolocaleoptions.delimiter.md) | string | |
|
||||
| [endDelimiter](./localization-plugin.ipseudolocaleoptions.enddelimiter.md) | string | |
|
||||
| [extend](./localization-plugin.ipseudolocaleoptions.extend.md) | number | |
|
||||
| [override](./localization-plugin.ipseudolocaleoptions.override.md) | string | |
|
||||
| [prepend](./localization-plugin.ipseudolocaleoptions.prepend.md) | string | |
|
||||
| [startDelimiter](./localization-plugin.ipseudolocaleoptions.startdelimiter.md) | string | |
|
||||
| [append?](./localization-plugin.ipseudolocaleoptions.append.md) | string | <i>(Optional)</i> |
|
||||
| [delimiter?](./localization-plugin.ipseudolocaleoptions.delimiter.md) | string | <i>(Optional)</i> |
|
||||
| [endDelimiter?](./localization-plugin.ipseudolocaleoptions.enddelimiter.md) | string | <i>(Optional)</i> |
|
||||
| [extend?](./localization-plugin.ipseudolocaleoptions.extend.md) | number | <i>(Optional)</i> |
|
||||
| [override?](./localization-plugin.ipseudolocaleoptions.override.md) | string | <i>(Optional)</i> |
|
||||
| [prepend?](./localization-plugin.ipseudolocaleoptions.prepend.md) | string | <i>(Optional)</i> |
|
||||
| [startDelimiter?](./localization-plugin.ipseudolocaleoptions.startdelimiter.md) | string | <i>(Optional)</i> |
|
||||
|
||||
|
|
|
@ -21,7 +21,7 @@ export interface ITypingsGenerationOptions
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [exportAsDefault](./localization-plugin.itypingsgenerationoptions.exportasdefault.md) | boolean | If this option is set to <code>true</code>, loc modules typings will be exported wrapped in a <code>default</code> property. |
|
||||
| [exportAsDefault?](./localization-plugin.itypingsgenerationoptions.exportasdefault.md) | boolean | <i>(Optional)</i> If this option is set to <code>true</code>, loc modules typings will be exported wrapped in a <code>default</code> property. |
|
||||
| [generatedTsFolder](./localization-plugin.itypingsgenerationoptions.generatedtsfolder.md) | string | This property specifies the folder in which <code>.d.ts</code> files for loc files should be dropped. |
|
||||
| [sourceRoot](./localization-plugin.itypingsgenerationoptions.sourceroot.md) | string | This optional property overrides the compiler context for discovery of localization files for which typings should be generated. |
|
||||
| [sourceRoot?](./localization-plugin.itypingsgenerationoptions.sourceroot.md) | string | <i>(Optional)</i> This optional property overrides the compiler context for discovery of localization files for which typings should be generated. |
|
||||
|
||||
|
|
|
@ -20,10 +20,10 @@ export interface ITypingsGeneratorOptions
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [exportAsDefault](./localization-plugin.itypingsgeneratoroptions.exportasdefault.md) | boolean | |
|
||||
| [filesToIgnore](./localization-plugin.itypingsgeneratoroptions.filestoignore.md) | string\[\] | |
|
||||
| [exportAsDefault?](./localization-plugin.itypingsgeneratoroptions.exportasdefault.md) | boolean | <i>(Optional)</i> |
|
||||
| [filesToIgnore?](./localization-plugin.itypingsgeneratoroptions.filestoignore.md) | string\[\] | <i>(Optional)</i> |
|
||||
| [generatedTsFolder](./localization-plugin.itypingsgeneratoroptions.generatedtsfolder.md) | string | |
|
||||
| [resxNewlineNormalization](./localization-plugin.itypingsgeneratoroptions.resxnewlinenormalization.md) | [NewlineKind](./node-core-library.newlinekind.md) \| undefined | |
|
||||
| [resxNewlineNormalization?](./localization-plugin.itypingsgeneratoroptions.resxnewlinenormalization.md) | [NewlineKind](./node-core-library.newlinekind.md) \| undefined | <i>(Optional)</i> |
|
||||
| [srcFolder](./localization-plugin.itypingsgeneratoroptions.srcfolder.md) | string | |
|
||||
| [terminal](./localization-plugin.itypingsgeneratoroptions.terminal.md) | [Terminal](./node-core-library.terminal.md) | |
|
||||
| [terminal?](./localization-plugin.itypingsgeneratoroptions.terminal.md) | [Terminal](./node-core-library.terminal.md) | <i>(Optional)</i> |
|
||||
|
||||
|
|
|
@ -22,10 +22,10 @@ export interface IExtendedModule extends webpack.compilation.Module
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [external](./module-minifier-plugin.iextendedmodule.external.md) | boolean | Is this module external? |
|
||||
| [external?](./module-minifier-plugin.iextendedmodule.external.md) | boolean | <i>(Optional)</i> Is this module external? |
|
||||
| [id](./module-minifier-plugin.iextendedmodule.id.md) | string \| number \| null | Id for the module |
|
||||
| [resource](./module-minifier-plugin.iextendedmodule.resource.md) | string | Path to the physical file this module represents |
|
||||
| [skipMinification](./module-minifier-plugin.iextendedmodule.skipminification.md) | boolean | If set, bypass the minifier for this module. Useful if the code is known to already be minified. |
|
||||
| [resource?](./module-minifier-plugin.iextendedmodule.resource.md) | string | <i>(Optional)</i> Path to the physical file this module represents |
|
||||
| [skipMinification?](./module-minifier-plugin.iextendedmodule.skipminification.md) | boolean | <i>(Optional)</i> If set, bypass the minifier for this module. Useful if the code is known to already be minified. |
|
||||
|
||||
## Methods
|
||||
|
||||
|
|
|
@ -21,9 +21,9 @@ export interface IModuleMinificationErrorResult
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [code](./module-minifier-plugin.imoduleminificationerrorresult.code.md) | undefined | Marker property to always return the same result shape. |
|
||||
| [code?](./module-minifier-plugin.imoduleminificationerrorresult.code.md) | undefined | <i>(Optional)</i> Marker property to always return the same result shape. |
|
||||
| [error](./module-minifier-plugin.imoduleminificationerrorresult.error.md) | Error | The error encountered, to be added to the current compilation's error collection. |
|
||||
| [extractedComments](./module-minifier-plugin.imoduleminificationerrorresult.extractedcomments.md) | undefined | Marker property to always return the same result shape. |
|
||||
| [extractedComments?](./module-minifier-plugin.imoduleminificationerrorresult.extractedcomments.md) | undefined | <i>(Optional)</i> Marker property to always return the same result shape. |
|
||||
| [hash](./module-minifier-plugin.imoduleminificationerrorresult.hash.md) | string | Identity of the request |
|
||||
| [map](./module-minifier-plugin.imoduleminificationerrorresult.map.md) | undefined | Marker property to always return the same result shape. |
|
||||
| [map?](./module-minifier-plugin.imoduleminificationerrorresult.map.md) | undefined | <i>(Optional)</i> Marker property to always return the same result shape. |
|
||||
|
||||
|
|
|
@ -25,5 +25,5 @@ export interface IModuleMinificationSuccessResult
|
|||
| [error](./module-minifier-plugin.imoduleminificationsuccessresult.error.md) | undefined | The error property being <code>undefined</code> indicates success. |
|
||||
| [extractedComments](./module-minifier-plugin.imoduleminificationsuccessresult.extractedcomments.md) | string\[\] | The array of extracted comments, usually these are license information for 3rd party libraries. |
|
||||
| [hash](./module-minifier-plugin.imoduleminificationsuccessresult.hash.md) | string | Identity of the request |
|
||||
| [map](./module-minifier-plugin.imoduleminificationsuccessresult.map.md) | RawSourceMap | Marker property to always return the same result shape. |
|
||||
| [map?](./module-minifier-plugin.imoduleminificationsuccessresult.map.md) | RawSourceMap | <i>(Optional)</i> Marker property to always return the same result shape. |
|
||||
|
||||
|
|
|
@ -27,5 +27,5 @@ export interface IModuleMinifier
|
|||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [ref()](./module-minifier-plugin.imoduleminifier.ref.md) | Prevents the minifier from shutting down until the returned callback is invoked. The callback may be used to surface errors encountered by the minifier that may not be relevant to a specific file. It should be called to allow the minifier to cleanup |
|
||||
| [ref()?](./module-minifier-plugin.imoduleminifier.ref.md) | <i>(Optional)</i> Prevents the minifier from shutting down until the returned callback is invoked. The callback may be used to surface errors encountered by the minifier that may not be relevant to a specific file. It should be called to allow the minifier to cleanup |
|
||||
|
||||
|
|
|
@ -22,6 +22,6 @@ export interface IModuleMinifierPluginOptions
|
|||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [minifier](./module-minifier-plugin.imoduleminifierpluginoptions.minifier.md) | [IModuleMinifier](./module-minifier-plugin.imoduleminifier.md) | Minifier implementation to use. Required. |
|
||||
| [sourceMap](./module-minifier-plugin.imoduleminifierpluginoptions.sourcemap.md) | boolean | Whether to enable source map processing. If not provided, will attempt to guess based on <code>mode</code> and <code>devtool</code> in the webpack config. Set to <code>false</code> for faster builds at the expense of debuggability. |
|
||||
| [usePortableModules](./module-minifier-plugin.imoduleminifierpluginoptions.useportablemodules.md) | boolean | Instructs the plugin to alter the code of modules to maximize portability across compilations. |
|
||||
| [sourceMap?](./module-minifier-plugin.imoduleminifierpluginoptions.sourcemap.md) | boolean | <i>(Optional)</i> Whether to enable source map processing. If not provided, will attempt to guess based on <code>mode</code> and <code>devtool</code> in the webpack config. Set to <code>false</code> for faster builds at the expense of debuggability. |
|
||||
| [usePortableModules?](./module-minifier-plugin.imoduleminifierpluginoptions.useportablemodules.md) | boolean | <i>(Optional)</i> Instructs the plugin to alter the code of modules to maximize portability across compilations. |
|
||||
|
||||
|
|
|
@ -21,5 +21,5 @@ export interface ISynchronousMinifierOptions
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [terserOptions](./module-minifier-plugin.isynchronousminifieroptions.terseroptions.md) | MinifyOptions | |
|
||||
| [terserOptions?](./module-minifier-plugin.isynchronousminifieroptions.terseroptions.md) | MinifyOptions | <i>(Optional)</i> |
|
||||
|
||||
|
|
|
@ -21,6 +21,6 @@ export interface IWorkerPoolMinifierOptions
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [maxThreads](./module-minifier-plugin.iworkerpoolminifieroptions.maxthreads.md) | number | Maximum number of worker threads to use. Will never use more than there are modules to process. Defaults to os.cpus().length |
|
||||
| [terserOptions](./module-minifier-plugin.iworkerpoolminifieroptions.terseroptions.md) | MinifyOptions | The options to forward to Terser. <code>output.comments</code> is currently not configurable and will always extract license comments to a separate file. |
|
||||
| [maxThreads?](./module-minifier-plugin.iworkerpoolminifieroptions.maxthreads.md) | number | <i>(Optional)</i> Maximum number of worker threads to use. Will never use more than there are modules to process. Defaults to os.cpus().length |
|
||||
| [terserOptions?](./module-minifier-plugin.iworkerpoolminifieroptions.terseroptions.md) | MinifyOptions | <i>(Optional)</i> The options to forward to Terser. <code>output.comments</code> is currently not configurable and will always extract license comments to a separate file. |
|
||||
|
||||
|
|
|
@ -35,6 +35,7 @@ If you need additional shell features such as wildcard globbing, environment var
|
|||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [spawn(filename, args, options)](./node-core-library.executable.spawn.md) | <code>static</code> | Start a child process. |
|
||||
| [spawnSync(filename, args, options)](./node-core-library.executable.spawnsync.md) | <code>static</code> | Synchronously create a child process and optionally capture its output. |
|
||||
| [tryResolve(filename, options)](./node-core-library.executable.tryresolve.md) | <code>static</code> | Given a filename, this determines the absolute path of the executable file that would be executed by a shell:<!-- -->- If the filename is missing a path, then the shell's default PATH will be searched. - If the filename is missing a file extension, then Windows default file extensions will be searched. |
|
||||
|
||||
|
|
|
@ -9,7 +9,7 @@ improve_this_button: false
|
|||
|
||||
## ExecutableStdioMapping type
|
||||
|
||||
Typings for IExecutableSpawnSyncOptions.stdio.
|
||||
Types for [IExecutableSpawnSyncOptions.stdio](./node-core-library.iexecutablespawnsyncoptions.stdio.md) and [IExecutableSpawnOptions.stdio](./node-core-library.iexecutablespawnoptions.stdio.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
|
|
|
@ -1,35 +0,0 @@
|
|||
---
|
||||
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/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [copyFileToManyAsync](./node-core-library.filesystem.copyfiletomanyasync.md)
|
||||
|
||||
## FileSystem.copyFileToManyAsync() method
|
||||
|
||||
Copies a single file from one location to one or more other locations. By default, the file at the destination is overwritten if it already exists.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
static copyFileToManyAsync(options: IFileSystemCopyFileToManyOptions): Promise<void>;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | [IFileSystemCopyFileToManyOptions](./node-core-library.ifilesystemcopyfiletomanyoptions.md) | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
Promise<void>
|
||||
|
||||
## Remarks
|
||||
|
||||
The `copyFileToManyAsync()` API cannot be used to copy folders. It copies at most one file.
|
||||
|
||||
The implementation is based on `createReadStream()` and `createWriteStream()` from the `fs-extra` package.
|
||||
|
|
@ -35,7 +35,6 @@ Note that in the documentation, we refer to "filesystem objects", this can be a
|
|||
| [copyFileAsync(options)](./node-core-library.filesystem.copyfileasync.md) | <code>static</code> | An async version of [FileSystem.copyFile()](./node-core-library.filesystem.copyfile.md)<!-- -->. |
|
||||
| [copyFiles(options)](./node-core-library.filesystem.copyfiles.md) | <code>static</code> | Copies a file or folder from one location to another, recursively copying any folder contents. By default, destinationPath is overwritten if it already exists. |
|
||||
| [copyFilesAsync(options)](./node-core-library.filesystem.copyfilesasync.md) | <code>static</code> | An async version of [FileSystem.copyFiles()](./node-core-library.filesystem.copyfiles.md)<!-- -->. |
|
||||
| [copyFileToManyAsync(options)](./node-core-library.filesystem.copyfiletomanyasync.md) | <code>static</code> | Copies a single file from one location to one or more other locations. By default, the file at the destination is overwritten if it already exists. |
|
||||
| [createHardLink(options)](./node-core-library.filesystem.createhardlink.md) | <code>static</code> | Creates a hard link. Behind the scenes it uses <code>fs.linkSync()</code>. |
|
||||
| [createHardLinkAsync(options)](./node-core-library.filesystem.createhardlinkasync.md) | <code>static</code> | An async version of [FileSystem.createHardLink()](./node-core-library.filesystem.createhardlink.md)<!-- -->. |
|
||||
| [createSymbolicLinkFile(options)](./node-core-library.filesystem.createsymboliclinkfile.md) | <code>static</code> | Creates a symbolic link to a file (on Windows this requires elevated permissionsBits). Behind the scenes it uses <code>fs.symlinkSync()</code>. |
|
||||
|
|
|
@ -9,10 +9,15 @@ improve_this_button: false
|
|||
|
||||
## IExecutableResolveOptions.environment property
|
||||
|
||||
The environment variables for the child process. If omitted, process.env will be used.
|
||||
The environment variables for the child process.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
environment?: NodeJS.ProcessEnv;
|
||||
```
|
||||
|
||||
## Remarks
|
||||
|
||||
If `environment` and `environmentMap` are both omitted, then `process.env` will be used. If `environment` and `environmentMap` cannot both be specified.
|
||||
|
||||
|
|
|
@ -22,5 +22,6 @@ export interface IExecutableResolveOptions
|
|||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [currentWorkingDirectory?](./node-core-library.iexecutableresolveoptions.currentworkingdirectory.md) | string | <i>(Optional)</i> The current working directory. If omitted, process.cwd() will be used. |
|
||||
| [environment?](./node-core-library.iexecutableresolveoptions.environment.md) | NodeJS.ProcessEnv | <i>(Optional)</i> The environment variables for the child process. If omitted, process.env will be used. |
|
||||
| [environment?](./node-core-library.iexecutableresolveoptions.environment.md) | NodeJS.ProcessEnv | <i>(Optional)</i> The environment variables for the child process. |
|
||||
| [environmentMap?](./node-core-library.iexecutableresolveoptions.environmentmap.md) | [EnvironmentMap](./node-core-library.environmentmap.md) | <i>(Optional)</i> The environment variables for the child process. |
|
||||
|
||||
|
|
|
@ -9,7 +9,7 @@ improve_this_button: false
|
|||
|
||||
## IExecutableSpawnSyncOptions.maxBuffer property
|
||||
|
||||
The largest amount of bytes allowed on stdout or stderr for this synchonous operation. If exceeded, the child process will be terminated. The default is 200 \* 1024.
|
||||
The largest amount of bytes allowed on stdout or stderr for this synchronous operation. If exceeded, the child process will be terminated. The default is 200 \* 1024.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
|
|
|
@ -9,7 +9,7 @@ improve_this_button: false
|
|||
|
||||
## IExecutableSpawnSyncOptions interface
|
||||
|
||||
Options for Executable.execute().
|
||||
Options for [Executable.spawnSync()](./node-core-library.executable.spawnsync.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
|
@ -23,7 +23,7 @@ export interface IExecutableSpawnSyncOptions extends IExecutableResolveOptions
|
|||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [input?](./node-core-library.iexecutablespawnsyncoptions.input.md) | string | <i>(Optional)</i> The content to be passed to the child process's stdin.<!-- -->NOTE: If specified, this content replaces any IExecutableSpawnSyncOptions.stdio\[0\] mapping for stdin. |
|
||||
| [maxBuffer?](./node-core-library.iexecutablespawnsyncoptions.maxbuffer.md) | number | <i>(Optional)</i> The largest amount of bytes allowed on stdout or stderr for this synchonous operation. If exceeded, the child process will be terminated. The default is 200 \* 1024. |
|
||||
| [maxBuffer?](./node-core-library.iexecutablespawnsyncoptions.maxbuffer.md) | number | <i>(Optional)</i> The largest amount of bytes allowed on stdout or stderr for this synchronous operation. If exceeded, the child process will be terminated. The default is 200 \* 1024. |
|
||||
| [stdio?](./node-core-library.iexecutablespawnsyncoptions.stdio.md) | [ExecutableStdioMapping](./node-core-library.executablestdiomapping.md) | <i>(Optional)</i> The stdio mappings for the child process.<!-- -->NOTE: If IExecutableSpawnSyncOptions.input is provided, it will take precedence over the stdin mapping (stdio\[0\]). |
|
||||
| [timeoutMs?](./node-core-library.iexecutablespawnsyncoptions.timeoutms.md) | number | <i>(Optional)</i> The maximum time the process is allowed to run before it will be terminated. |
|
||||
|
||||
|
|
|
@ -1,18 +0,0 @@
|
|||
---
|
||||
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/node-core-library](./node-core-library.md) > [IFileSystemCopyFileToManyOptions](./node-core-library.ifilesystemcopyfiletomanyoptions.md) > [destinationPaths](./node-core-library.ifilesystemcopyfiletomanyoptions.destinationpaths.md)
|
||||
|
||||
## IFileSystemCopyFileToManyOptions.destinationPaths property
|
||||
|
||||
The path that the object will be copied to. The path may be absolute or relative.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
destinationPaths: string[];
|
||||
```
|
|
@ -1,26 +0,0 @@
|
|||
---
|
||||
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/node-core-library](./node-core-library.md) > [IFileSystemCopyFileToManyOptions](./node-core-library.ifilesystemcopyfiletomanyoptions.md)
|
||||
|
||||
## IFileSystemCopyFileToManyOptions interface
|
||||
|
||||
The options for [FileSystem.copyFile()](./node-core-library.filesystem.copyfile.md)
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IFileSystemCopyFileToManyOptions extends IFileSystemCopyFileBaseOptions
|
||||
```
|
||||
<b>Extends:</b> [IFileSystemCopyFileBaseOptions](./node-core-library.ifilesystemcopyfilebaseoptions.md)
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [destinationPaths](./node-core-library.ifilesystemcopyfiletomanyoptions.destinationpaths.md) | string\[\] | The path that the object will be copied to. The path may be absolute or relative. |
|
||||
|
|
@ -22,6 +22,7 @@ export interface IJsonFileStringifyOptions
|
|||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [headerComment?](./node-core-library.ijsonfilestringifyoptions.headercomment.md) | string | <i>(Optional)</i> If specified, this header will be prepended to the start of the file. The header must consist of lines prefixed by "//" characters. |
|
||||
| [ignoreUndefinedValues?](./node-core-library.ijsonfilestringifyoptions.ignoreundefinedvalues.md) | boolean | <i>(Optional)</i> If true, conforms to the standard behavior of JSON.stringify() when a property has the value <code>undefined</code>. Specifically, the key will be dropped from the emitted object. |
|
||||
| [newlineConversion?](./node-core-library.ijsonfilestringifyoptions.newlineconversion.md) | [NewlineKind](./node-core-library.newlinekind.md) | <i>(Optional)</i> If provided, the specified newline type will be used instead of the default <code>\r\n</code>. |
|
||||
| [prettyFormatting?](./node-core-library.ijsonfilestringifyoptions.prettyformatting.md) | boolean | <i>(Optional)</i> If true, then the "jju" library will be used to improve the text formatting. Note that this is slightly slower than the native JSON.stringify() implementation. |
|
||||
|
||||
|
|
|
@ -41,6 +41,7 @@ Use the `INodePackageJson` interface when loading such files. Use `IPackageJson`
|
|||
| [peerDependencies?](./node-core-library.inodepackagejson.peerdependencies.md) | [IPackageJsonDependencyTable](./node-core-library.ipackagejsondependencytable.md) | <i>(Optional)</i> An array of dependencies that must be installed by a consumer of this package, but which will not be automatically installed by this package. |
|
||||
| [private?](./node-core-library.inodepackagejson.private.md) | boolean | <i>(Optional)</i> Indicates whether this package is allowed to be published or not. |
|
||||
| [repository?](./node-core-library.inodepackagejson.repository.md) | string | <i>(Optional)</i> The URL of the project's repository. |
|
||||
| [resolutions?](./node-core-library.inodepackagejson.resolutions.md) | Record<string, string> | <i>(Optional)</i> A table of package version resolutions. This feature is only implemented by the Yarn package manager. |
|
||||
| [scripts?](./node-core-library.inodepackagejson.scripts.md) | [IPackageJsonScriptTable](./node-core-library.ipackagejsonscripttable.md) | <i>(Optional)</i> A table of script hooks that a package manager or build tool may invoke. |
|
||||
| [tsdocMetadata?](./node-core-library.inodepackagejson.tsdocmetadata.md) | string | <b><i>(BETA)</i></b> <i>(Optional)</i> The path to the TSDoc metadata file. This is still being standardized: https://github.com/microsoft/tsdoc/issues/7\#issuecomment-442271815 |
|
||||
| [types?](./node-core-library.inodepackagejson.types.md) | string | <i>(Optional)</i> The path to the TypeScript \*.d.ts file describing the module file that will act as the main entry point. |
|
||||
|
|
|
@ -29,7 +29,7 @@ export declare class JsonFile
|
|||
| [loadAsync(jsonFilename)](./node-core-library.jsonfile.loadasync.md) | <code>static</code> | An async version of [JsonFile.load()](./node-core-library.jsonfile.load.md)<!-- -->. |
|
||||
| [parseString(jsonContents)](./node-core-library.jsonfile.parsestring.md) | <code>static</code> | Parses a JSON file's contents. |
|
||||
| [save(jsonObject, jsonFilename, options)](./node-core-library.jsonfile.save.md) | <code>static</code> | Saves the file to disk. Returns false if nothing was written due to options.onlyIfChanged. |
|
||||
| [saveAsync(jsonObject, jsonFilename, options)](./node-core-library.jsonfile.saveasync.md) | <code>static</code> | An async version of [JsonFile.loadAndValidateWithCallback()](./node-core-library.jsonfile.loadandvalidatewithcallback.md)<!-- -->. |
|
||||
| [saveAsync(jsonObject, jsonFilename, options)](./node-core-library.jsonfile.saveasync.md) | <code>static</code> | An async version of [JsonFile.save()](./node-core-library.jsonfile.save.md)<!-- -->. |
|
||||
| [stringify(jsonObject, options)](./node-core-library.jsonfile.stringify.md) | <code>static</code> | Serializes the specified JSON object to a string buffer. |
|
||||
| [updateString(previousJson, newJsonObject, options)](./node-core-library.jsonfile.updatestring.md) | <code>static</code> | Serializes the specified JSON object to a string buffer. |
|
||||
| [validateNoUndefinedMembers(jsonObject)](./node-core-library.jsonfile.validatenoundefinedmembers.md) | <code>static</code> | Used to validate a data structure before writing. Reports an error if there are any undefined members. |
|
||||
|
|
|
@ -9,7 +9,7 @@ improve_this_button: false
|
|||
|
||||
## JsonFile.saveAsync() method
|
||||
|
||||
An async version of [JsonFile.loadAndValidateWithCallback()](./node-core-library.jsonfile.loadandvalidatewithcallback.md)<!-- -->.
|
||||
An async version of [JsonFile.save()](./node-core-library.jsonfile.save.md)<!-- -->.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
|
|
|
@ -17,9 +17,11 @@ Core libraries that every NodeJS toolchain project should use.
|
|||
| --- | --- |
|
||||
| [AlreadyReportedError](./node-core-library.alreadyreportederror.md) | This exception can be thrown to indicate that an operation failed and an error message has already been reported appropriately. Thus, the catch handler does not have responsibility for reporting the error. |
|
||||
| [AnsiEscape](./node-core-library.ansiescape.md) | Operations for working with text strings that contain [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code)<!-- -->. The most commonly used escape codes set the foreground/background color for console output. |
|
||||
| [Async](./node-core-library.async.md) | <b><i>(BETA)</i></b> Utilities for parallel asynchronous operations, for use with the system <code>Promise</code> APIs. |
|
||||
| [Colors](./node-core-library.colors.md) | <b><i>(BETA)</i></b> The static functions on this class are used to produce colored text for use with the node-core-library terminal. |
|
||||
| [ConsoleTerminalProvider](./node-core-library.consoleterminalprovider.md) | <b><i>(BETA)</i></b> Terminal provider that prints to STDOUT (for log- and verbose-level messages) and STDERR (for warning- and error-level messsages). |
|
||||
| [Enum](./node-core-library.enum.md) | A helper for looking up TypeScript <code>enum</code> keys/values. |
|
||||
| [EnvironmentMap](./node-core-library.environmentmap.md) | A map data structure that stores process environment variables. On Windows operating system, the variable names are case-insensitive. |
|
||||
| [Executable](./node-core-library.executable.md) | The Executable class provides a safe, portable, recommended solution for tools that need to launch child processes. |
|
||||
| [FileSystem](./node-core-library.filesystem.md) | The FileSystem API provides a complete set of recommended operations for interacting with the file system. |
|
||||
| [FileWriter](./node-core-library.filewriter.md) | API for interacting with file handles. |
|
||||
|
@ -61,15 +63,17 @@ Core libraries that every NodeJS toolchain project should use.
|
|||
| Interface | Description |
|
||||
| --- | --- |
|
||||
| [IAnsiEscapeConvertForTestsOptions](./node-core-library.iansiescapeconvertfortestsoptions.md) | Options for [AnsiEscape.formatForTests()](./node-core-library.ansiescape.formatfortests.md)<!-- -->. |
|
||||
| [IAsyncParallelismOptions](./node-core-library.iasyncparallelismoptions.md) | <b><i>(BETA)</i></b> Options for controlling the parallelism of asynchronous operations. |
|
||||
| [IColorableSequence](./node-core-library.icolorablesequence.md) | <b><i>(BETA)</i></b> |
|
||||
| [IConsoleTerminalProviderOptions](./node-core-library.iconsoleterminalprovideroptions.md) | <b><i>(BETA)</i></b> Options to be provided to a [ConsoleTerminalProvider](./node-core-library.consoleterminalprovider.md) |
|
||||
| [IEnvironmentEntry](./node-core-library.ienvironmententry.md) | A process environment variable name and its value. Used by [EnvironmentMap](./node-core-library.environmentmap.md)<!-- -->. |
|
||||
| [IExecutableResolveOptions](./node-core-library.iexecutableresolveoptions.md) | Options for Executable.tryResolve(). |
|
||||
| [IExecutableSpawnSyncOptions](./node-core-library.iexecutablespawnsyncoptions.md) | Options for Executable.execute(). |
|
||||
| [IExecutableSpawnOptions](./node-core-library.iexecutablespawnoptions.md) | Options for [Executable.spawn()](./node-core-library.executable.spawn.md) |
|
||||
| [IExecutableSpawnSyncOptions](./node-core-library.iexecutablespawnsyncoptions.md) | Options for [Executable.spawnSync()](./node-core-library.executable.spawnsync.md) |
|
||||
| [IFileSystemCopyFileBaseOptions](./node-core-library.ifilesystemcopyfilebaseoptions.md) | |
|
||||
| [IFileSystemCopyFileOptions](./node-core-library.ifilesystemcopyfileoptions.md) | The options for [FileSystem.copyFile()](./node-core-library.filesystem.copyfile.md) |
|
||||
| [IFileSystemCopyFilesAsyncOptions](./node-core-library.ifilesystemcopyfilesasyncoptions.md) | The options for [FileSystem.copyFilesAsync()](./node-core-library.filesystem.copyfilesasync.md) |
|
||||
| [IFileSystemCopyFilesOptions](./node-core-library.ifilesystemcopyfilesoptions.md) | The options for [FileSystem.copyFiles()](./node-core-library.filesystem.copyfiles.md) |
|
||||
| [IFileSystemCopyFileToManyOptions](./node-core-library.ifilesystemcopyfiletomanyoptions.md) | The options for [FileSystem.copyFile()](./node-core-library.filesystem.copyfile.md) |
|
||||
| [IFileSystemCreateLinkOptions](./node-core-library.ifilesystemcreatelinkoptions.md) | The options for [FileSystem.createSymbolicLinkJunction()](./node-core-library.filesystem.createsymboliclinkjunction.md)<!-- -->, [FileSystem.createSymbolicLinkFile()](./node-core-library.filesystem.createsymboliclinkfile.md)<!-- -->, [FileSystem.createSymbolicLinkFolder()](./node-core-library.filesystem.createsymboliclinkfolder.md)<!-- -->, and [FileSystem.createHardLink()](./node-core-library.filesystem.createhardlink.md)<!-- -->. |
|
||||
| [IFileSystemDeleteFileOptions](./node-core-library.ifilesystemdeletefileoptions.md) | The options for [FileSystem.deleteFile()](./node-core-library.filesystem.deletefile.md) |
|
||||
| [IFileSystemMoveOptions](./node-core-library.ifilesystemmoveoptions.md) | The options for [FileSystem.move()](./node-core-library.filesystem.move.md) |
|
||||
|
@ -105,7 +109,7 @@ Core libraries that every NodeJS toolchain project should use.
|
|||
| Type Alias | Description |
|
||||
| --- | --- |
|
||||
| [Brand](./node-core-library.brand.md) | A "branded type" is a primitive type with a compile-type key that makes it incompatible with other aliases for the primitive type. |
|
||||
| [ExecutableStdioMapping](./node-core-library.executablestdiomapping.md) | Typings for IExecutableSpawnSyncOptions.stdio. |
|
||||
| [ExecutableStdioMapping](./node-core-library.executablestdiomapping.md) | Types for [IExecutableSpawnSyncOptions.stdio](./node-core-library.iexecutablespawnsyncoptions.stdio.md) and [IExecutableSpawnOptions.stdio](./node-core-library.iexecutablespawnoptions.stdio.md) |
|
||||
| [ExecutableStdioStreamMapping](./node-core-library.executablestdiostreammapping.md) | Typings for one of the streams inside IExecutableSpawnSyncOptions.stdio. |
|
||||
| [FileSystemCopyFilesAsyncFilter](./node-core-library.filesystemcopyfilesasyncfilter.md) | Callback function type for [IFileSystemCopyFilesAsyncOptions.filter](./node-core-library.ifilesystemcopyfilesasyncoptions.filter.md) |
|
||||
| [FileSystemCopyFilesFilter](./node-core-library.filesystemcopyfilesfilter.md) | Callback function type for [IFileSystemCopyFilesOptions.filter](./node-core-library.ifilesystemcopyfilesoptions.filter.md) |
|
||||
|
|
|
@ -14,7 +14,7 @@ Takes a list of files and returns the current git hashes for them
|
|||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function getGitHashForFiles(filesToHash: string[], packagePath: string): Map<string, string>;
|
||||
export declare function getGitHashForFiles(filesToHash: string[], packagePath: string, gitPath?: string): Map<string, string>;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
@ -23,6 +23,7 @@ export declare function getGitHashForFiles(filesToHash: string[], packagePath: s
|
|||
| --- | --- | --- |
|
||||
| filesToHash | string\[\] | |
|
||||
| packagePath | string | |
|
||||
| gitPath | string | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
|
|
|
@ -14,7 +14,7 @@ Builds an object containing hashes for the files under the specified `packagePat
|
|||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare function getPackageDeps(packagePath?: string, excludedPaths?: string[]): IPackageDeps;
|
||||
export declare function getPackageDeps(packagePath?: string, excludedPaths?: string[], gitPath?: string): Map<string, string>;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
@ -23,10 +23,11 @@ export declare function getPackageDeps(packagePath?: string, excludedPaths?: str
|
|||
| --- | --- | --- |
|
||||
| packagePath | string | The folder path to derive the package dependencies from. This is typically the folder containing package.json. If omitted, the default value is the current working directory. |
|
||||
| excludedPaths | string\[\] | An optional array of file path exclusions. If a file should be omitted from the list of dependencies, use this to exclude it. |
|
||||
| gitPath | string | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
[IPackageDeps](./package-deps-hash.ipackagedeps.md)
|
||||
Map<string, string>
|
||||
|
||||
the package-deps.json file content
|
||||
|
||||
|
|
|
@ -1,18 +0,0 @@
|
|||
---
|
||||
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/package-deps-hash](./package-deps-hash.md) > [IPackageDeps](./package-deps-hash.ipackagedeps.md) > [arguments](./package-deps-hash.ipackagedeps.arguments.md)
|
||||
|
||||
## IPackageDeps.arguments property
|
||||
|
||||
An optional field used to story command-line arguments for the build.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
arguments?: string;
|
||||
```
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
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/package-deps-hash](./package-deps-hash.md) > [IPackageDeps](./package-deps-hash.ipackagedeps.md) > [files](./package-deps-hash.ipackagedeps.files.md)
|
||||
|
||||
## IPackageDeps.files property
|
||||
|
||||
The `key` is a source file path, relative to the package folder. The value is the Git hash.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
files: {
|
||||
[key: string]: string;
|
||||
};
|
||||
```
|
|
@ -1,26 +0,0 @@
|
|||
---
|
||||
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/package-deps-hash](./package-deps-hash.md) > [IPackageDeps](./package-deps-hash.ipackagedeps.md)
|
||||
|
||||
## IPackageDeps interface
|
||||
|
||||
The data structure returned by [getPackageDeps()](./package-deps-hash.getpackagedeps.md)<!-- -->.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface IPackageDeps
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [arguments](./package-deps-hash.ipackagedeps.arguments.md) | string | An optional field used to story command-line arguments for the build. |
|
||||
| [files](./package-deps-hash.ipackagedeps.files.md) | { \[key: string\]: string; } | The <code>key</code> is a source file path, relative to the package folder. The value is the Git hash. |
|
||||
|
|
@ -19,12 +19,6 @@ For more info, please see the package [README](https://www.npmjs.com/package/@ru
|
|||
|
||||
| Function | Description |
|
||||
| --- | --- |
|
||||
| [getGitHashForFiles(filesToHash, packagePath)](./package-deps-hash.getgithashforfiles.md) | Takes a list of files and returns the current git hashes for them |
|
||||
| [getPackageDeps(packagePath, excludedPaths)](./package-deps-hash.getpackagedeps.md) | Builds an object containing hashes for the files under the specified <code>packagePath</code> folder. |
|
||||
|
||||
## Interfaces
|
||||
|
||||
| Interface | Description |
|
||||
| --- | --- |
|
||||
| [IPackageDeps](./package-deps-hash.ipackagedeps.md) | The data structure returned by [getPackageDeps()](./package-deps-hash.getpackagedeps.md)<!-- -->. |
|
||||
| [getGitHashForFiles(filesToHash, packagePath, gitPath)](./package-deps-hash.getgithashforfiles.md) | Takes a list of files and returns the current git hashes for them |
|
||||
| [getPackageDeps(packagePath, excludedPaths, gitPath)](./package-deps-hash.getpackagedeps.md) | Builds an object containing hashes for the files under the specified <code>packagePath</code> folder. |
|
||||
|
||||
|
|
|
@ -27,4 +27,5 @@ export declare const enum DependencyType
|
|||
| Optional | <code>"optionalDependencies"</code> | <b><i>(BETA)</i></b> |
|
||||
| Peer | <code>"peerDependencies"</code> | <b><i>(BETA)</i></b> |
|
||||
| Regular | <code>"dependencies"</code> | <b><i>(BETA)</i></b> |
|
||||
| YarnResolutions | <code>"resolutions"</code> | <b><i>(BETA)</i></b> |
|
||||
|
||||
|
|
|
@ -21,10 +21,16 @@ export declare const enum EnvironmentVariableNames
|
|||
|
||||
| Member | Value | Description |
|
||||
| --- | --- | --- |
|
||||
| RUSH\_ABSOLUTE\_SYMLINKS | <code>"RUSH_ABSOLUTE_SYMLINKS"</code> | If this variable is set to "true", Rush will create symlinks with absolute paths instead of relative paths. This can be necessary when a repository is moved during a build or if parts of a repository are moved into a sandbox. |
|
||||
| RUSH\_ALLOW\_UNSUPPORTED\_NODEJS | <code>"RUSH_ALLOW_UNSUPPORTED_NODEJS"</code> | If this variable is set to "true", Rush will not fail the build when running a version of Node that does not match the criteria specified in the "nodeSupportedVersionRange" field from rush.json. |
|
||||
| RUSH\_ABSOLUTE\_SYMLINKS | <code>"RUSH_ABSOLUTE_SYMLINKS"</code> | If this variable is set to "1", Rush will create symlinks with absolute paths instead of relative paths. This can be necessary when a repository is moved during a build or if parts of a repository are moved into a sandbox. |
|
||||
| RUSH\_ALLOW\_UNSUPPORTED\_NODEJS | <code>"RUSH_ALLOW_UNSUPPORTED_NODEJS"</code> | If this variable is set to "1", Rush will not fail the build when running a version of Node that does not match the criteria specified in the "nodeSupportedVersionRange" field from rush.json. |
|
||||
| RUSH\_ALLOW\_WARNINGS\_IN\_SUCCESSFUL\_BUILD | <code>"RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD"</code> | Setting this environment variable overrides the value of <code>allowWarningsInSuccessfulBuild</code> in the <code>command-line.json</code> configuration file. Specify <code>1</code> to allow warnings in a successful build, or <code>0</code> to disallow them. (See the comments in the command-line.json file for more information). |
|
||||
| RUSH\_BUILD\_CACHE\_CREDENTIAL | <code>"RUSH_BUILD_CACHE_CREDENTIAL"</code> | Provides a credential for a remote build cache, if configured. Setting this environment variable overrides whatever credential has been saved in the local cloud cache credentials using <code>rush update-cloud-credentials</code>. |
|
||||
| RUSH\_BUILD\_CACHE\_ENABLED | <code>"RUSH_BUILD_CACHE_ENABLED"</code> | Setting this environment variable overrides the value of <code>buildCacheEnabled</code> in the <code>build-cache.json</code> configuration file. Specify <code>1</code> to enable the build cache or <code>0</code> to disable it.<!-- -->If set to <code>0</code>, this is equivalent to passing the <code>--disable-build-cache</code> flag. |
|
||||
| RUSH\_BUILD\_CACHE\_WRITE\_ALLOWED | <code>"RUSH_BUILD_CACHE_WRITE_ALLOWED"</code> | Setting this environment variable overrides the value of <code>isCacheWriteAllowed</code> in the <code>build-cache.json</code> configuration file. Specify <code>1</code> to allow cache write and <code>0</code> to disable it. |
|
||||
| RUSH\_DEPLOY\_TARGET\_FOLDER | <code>"RUSH_DEPLOY_TARGET_FOLDER"</code> | This environment variable can be used to specify the <code>--target-folder</code> parameter for the "rush deploy" command. |
|
||||
| RUSH\_GIT\_BINARY\_PATH | <code>"RUSH_GIT_BINARY_PATH"</code> | Allows the git binary path to be explicitly specified. |
|
||||
| RUSH\_GLOBAL\_FOLDER | <code>"RUSH_GLOBAL_FOLDER"</code> | Overrides the location of the <code>~/.rush</code> global folder where Rush stores temporary files. |
|
||||
| RUSH\_INVOKED\_FOLDER | <code>"RUSH_INVOKED_FOLDER"</code> | When Rush executes shell scripts, it sometimes changes the working directory to be a project folder or the repository root folder. The original working directory (where the Rush command was invoked) is assigned to the the child process's <code>RUSH_INVOKED_FOLDER</code> environment variable, in case it is needed by the script. |
|
||||
| RUSH\_PARALLELISM | <code>"RUSH_PARALLELISM"</code> | Specifies the maximum number of concurrent processes to launch during a build. For more information, see the command-line help for the <code>--parallelism</code> parameter for "rush build". |
|
||||
| RUSH\_PNPM\_STORE\_PATH | <code>"RUSH_PNPM_STORE_PATH"</code> | When using PNPM as the package manager, this variable can be used to configure the path that PNPM will use as the store directory.<!-- -->If a relative path is used, then the store path will be resolved relative to the process's current working directory. An absolute path is recommended. |
|
||||
| RUSH\_PREVIEW\_VERSION | <code>"RUSH_PREVIEW_VERSION"</code> | This variable overrides the version of Rush that will be installed by the version selector. The default value is determined by the "rushVersion" field from rush.json. |
|
||||
|
|
|
@ -21,6 +21,6 @@ export interface IConfigurationEnvironmentVariable
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [override](./rush-lib.iconfigurationenvironmentvariable.override.md) | boolean | Set to true to override the environment variable even if it is set in the parent environment. The default value is false. |
|
||||
| [override?](./rush-lib.iconfigurationenvironmentvariable.override.md) | boolean | <i>(Optional)</i> Set to true to override the environment variable even if it is set in the parent environment. The default value is false. |
|
||||
| [value](./rush-lib.iconfigurationenvironmentvariable.value.md) | string | Value of the environment variable |
|
||||
|
||||
|
|
|
@ -1,21 +0,0 @@
|
|||
---
|
||||
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) > [@microsoft/rush-lib](./rush-lib.md) > [IExperimentsJson](./rush-lib.iexperimentsjson.md) > [legacyIncrementalBuildDependencyDetection](./rush-lib.iexperimentsjson.legacyincrementalbuilddependencydetection.md)
|
||||
|
||||
## IExperimentsJson.legacyIncrementalBuildDependencyDetection 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.
|
||||
>
|
||||
|
||||
If this setting is enabled, incremental builds should use repo-wide dependency tracking instead of project-specific tracking.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
legacyIncrementalBuildDependencyDetection?: boolean;
|
||||
```
|
|
@ -24,7 +24,8 @@ export interface IExperimentsJson
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [legacyIncrementalBuildDependencyDetection](./rush-lib.iexperimentsjson.legacyincrementalbuilddependencydetection.md) | boolean | <b><i>(BETA)</i></b> If this setting is enabled, incremental builds should use repo-wide dependency tracking instead of project-specific tracking. |
|
||||
| [noChmodFieldInTarHeaderNormalization](./rush-lib.iexperimentsjson.nochmodfieldintarheadernormalization.md) | boolean | <b><i>(BETA)</i></b> If true, the chmod field in temporary project tar headers will not be normalized. This normalization can help ensure consistent tarball integrity across platforms. |
|
||||
| [usePnpmFrozenLockfileForRushInstall](./rush-lib.iexperimentsjson.usepnpmfrozenlockfileforrushinstall.md) | boolean | <b><i>(BETA)</i></b> By default, rush passes --no-prefer-frozen-lockfile to 'pnpm install'. Set this option to true to pass '--frozen-lockfile' instead. |
|
||||
| [noChmodFieldInTarHeaderNormalization?](./rush-lib.iexperimentsjson.nochmodfieldintarheadernormalization.md) | boolean | <b><i>(BETA)</i></b> <i>(Optional)</i> If true, the chmod field in temporary project tar headers will not be normalized. This normalization can help ensure consistent tarball integrity across platforms. |
|
||||
| [omitImportersFromPreventManualShrinkwrapChanges?](./rush-lib.iexperimentsjson.omitimportersfrompreventmanualshrinkwrapchanges.md) | boolean | <b><i>(BETA)</i></b> <i>(Optional)</i> If using the 'preventManualShrinkwrapChanges' option, restricts the hash to only include the layout of external dependencies. Used to allow links between workspace projects or the addition/removal of references to existing dependency versions to not cause hash changes. |
|
||||
| [usePnpmFrozenLockfileForRushInstall?](./rush-lib.iexperimentsjson.usepnpmfrozenlockfileforrushinstall.md) | boolean | <b><i>(BETA)</i></b> <i>(Optional)</i> By default, 'rush install' passes --no-prefer-frozen-lockfile to 'pnpm install'. Set this option to true to pass '--frozen-lockfile' instead. |
|
||||
| [usePnpmPreferFrozenLockfileForRushUpdate?](./rush-lib.iexperimentsjson.usepnpmpreferfrozenlockfileforrushupdate.md) | boolean | <b><i>(BETA)</i></b> <i>(Optional)</i> By default, 'rush update' passes --no-prefer-frozen-lockfile to 'pnpm install'. Set this option to true to pass '--prefer-frozen-lockfile' instead. |
|
||||
|
||||
|
|
|
@ -12,7 +12,7 @@ improve_this_button: false
|
|||
> 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.
|
||||
>
|
||||
|
||||
By default, rush passes --no-prefer-frozen-lockfile to 'pnpm install'. Set this option to true to pass '--frozen-lockfile' instead.
|
||||
By default, 'rush install' passes --no-prefer-frozen-lockfile to 'pnpm install'. Set this option to true to pass '--frozen-lockfile' instead.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
|
|
|
@ -21,6 +21,6 @@ export interface ILaunchOptions
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [alreadyReportedNodeTooNewError](./rush-lib.ilaunchoptions.alreadyreportednodetoonewerror.md) | boolean | If true, the wrapper process already printed a warning that the version of Node.js hasn't been tested with this version of Rush, so we shouldn't print a similar error. |
|
||||
| [alreadyReportedNodeTooNewError?](./rush-lib.ilaunchoptions.alreadyreportednodetoonewerror.md) | boolean | <i>(Optional)</i> If true, the wrapper process already printed a warning that the version of Node.js hasn't been tested with this version of Rush, so we shouldn't print a similar error. |
|
||||
| [isManaged](./rush-lib.ilaunchoptions.ismanaged.md) | boolean | True if the tool was invoked from within a project with a rush.json file, otherwise false. We consider a project without a rush.json to be "unmanaged" and we'll print that to the command line when the tool is executed. This is mainly used for debugging purposes. |
|
||||
|
||||
|
|
|
@ -21,5 +21,5 @@ export interface IPackageManagerOptionsJsonBase
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [environmentVariables](./rush-lib.ipackagemanageroptionsjsonbase.environmentvariables.md) | [IConfigurationEnvironment](./rush-lib.iconfigurationenvironment.md) | Environment variables for the package manager |
|
||||
| [environmentVariables?](./rush-lib.ipackagemanageroptionsjsonbase.environmentvariables.md) | [IConfigurationEnvironment](./rush-lib.iconfigurationenvironment.md) | <i>(Optional)</i> Environment variables for the package manager |
|
||||
|
||||
|
|
|
@ -21,6 +21,6 @@ export interface ITryFindRushJsonLocationOptions
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [showVerbose](./rush-lib.itryfindrushjsonlocationoptions.showverbose.md) | boolean | Whether to show verbose console messages. Defaults to false. |
|
||||
| [startingFolder](./rush-lib.itryfindrushjsonlocationoptions.startingfolder.md) | string | The folder path where the search will start. Defaults tot he current working directory. |
|
||||
| [showVerbose?](./rush-lib.itryfindrushjsonlocationoptions.showverbose.md) | boolean | <i>(Optional)</i> Whether to show verbose console messages. Defaults to false. |
|
||||
| [startingFolder?](./rush-lib.itryfindrushjsonlocationoptions.startingfolder.md) | string | <i>(Optional)</i> The folder path where the search will start. Defaults tot he current working directory. |
|
||||
|
||||
|
|
|
@ -65,5 +65,4 @@ A library for writing scripts that interact with the [Rush](https://rushjs.io/)
|
|||
| --- | --- |
|
||||
| [PackageManagerName](./rush-lib.packagemanagername.md) | This represents the available Package Manager tools as a string |
|
||||
| [PnpmStoreOptions](./rush-lib.pnpmstoreoptions.md) | This represents the available PNPM store options |
|
||||
| [ResolutionStrategy](./rush-lib.resolutionstrategy.md) | This represents the available PNPM resolution strategies as a string |
|
||||
|
||||
|
|
|
@ -27,6 +27,7 @@ export declare class PackageJsonEditor
|
|||
| [devDependencyList](./rush-lib.packagejsoneditor.devdependencylist.md) | | ReadonlyArray<[PackageJsonDependency](./rush-lib.packagejsondependency.md)<!-- -->> | <b><i>(BETA)</i></b> The list of dependencies of type DependencyType.Dev. |
|
||||
| [filePath](./rush-lib.packagejsoneditor.filepath.md) | | string | <b><i>(BETA)</i></b> |
|
||||
| [name](./rush-lib.packagejsoneditor.name.md) | | string | <b><i>(BETA)</i></b> |
|
||||
| [resolutionsList](./rush-lib.packagejsoneditor.resolutionslist.md) | | ReadonlyArray<[PackageJsonDependency](./rush-lib.packagejsondependency.md)<!-- -->> | <b><i>(BETA)</i></b> This field is a Yarn-specific feature that allows overriding of package resolution. |
|
||||
| [version](./rush-lib.packagejsoneditor.version.md) | | string | <b><i>(BETA)</i></b> |
|
||||
|
||||
## Methods
|
||||
|
@ -37,6 +38,7 @@ export declare class PackageJsonEditor
|
|||
| [fromObject(object, filename)](./rush-lib.packagejsoneditor.fromobject.md) | <code>static</code> | <b><i>(BETA)</i></b> |
|
||||
| [load(filePath)](./rush-lib.packagejsoneditor.load.md) | <code>static</code> | <b><i>(BETA)</i></b> |
|
||||
| [saveIfModified()](./rush-lib.packagejsoneditor.saveifmodified.md) | | <b><i>(BETA)</i></b> |
|
||||
| [saveToObject()](./rush-lib.packagejsoneditor.savetoobject.md) | | <b><i>(BETA)</i></b> Get the normalized package.json that represents the current state of the PackageJsonEditor. This method does not save any changes that were made to the package.json, but instead returns the object representation of what would be saved if saveIfModified() is called. |
|
||||
| [tryGetDependency(packageName)](./rush-lib.packagejsoneditor.trygetdependency.md) | | <b><i>(BETA)</i></b> |
|
||||
| [tryGetDevDependency(packageName)](./rush-lib.packagejsoneditor.trygetdevdependency.md) | | <b><i>(BETA)</i></b> |
|
||||
|
||||
|
|
|
@ -26,5 +26,5 @@ The constructor for this class is marked as internal. Third-party code should no
|
|||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [environmentVariables](./rush-lib.packagemanageroptionsconfigurationbase.environmentvariables.md) | | [IConfigurationEnvironment](./rush-lib.iconfigurationenvironment.md) | Environment variables for the package manager |
|
||||
| [environmentVariables?](./rush-lib.packagemanageroptionsconfigurationbase.environmentvariables.md) | | [IConfigurationEnvironment](./rush-lib.iconfigurationenvironment.md) | <i>(Optional)</i> Environment variables for the package manager |
|
||||
|
||||
|
|
|
@ -31,7 +31,6 @@ The constructor for this class is marked as internal. Third-party code should no
|
|||
| [pnpmStore](./rush-lib.pnpmoptionsconfiguration.pnpmstore.md) | | [PnpmStoreOptions](./rush-lib.pnpmstoreoptions.md) | The method used to resolve the store used by PNPM. |
|
||||
| [pnpmStorePath](./rush-lib.pnpmoptionsconfiguration.pnpmstorepath.md) | | string | The path for PNPM to use as the store directory.<!-- -->Will be overridden by environment variable RUSH\_PNPM\_STORE\_PATH |
|
||||
| [preventManualShrinkwrapChanges](./rush-lib.pnpmoptionsconfiguration.preventmanualshrinkwrapchanges.md) | | boolean | If true, then <code>rush install</code> will report an error if manual modifications were made to the PNPM shrinkwrap file without running <code>rush update</code> afterwards. |
|
||||
| [resolutionStrategy](./rush-lib.pnpmoptionsconfiguration.resolutionstrategy.md) | | [ResolutionStrategy](./rush-lib.resolutionstrategy.md) | The resolution strategy that will be used by PNPM. |
|
||||
| [strictPeerDependencies](./rush-lib.pnpmoptionsconfiguration.strictpeerdependencies.md) | | boolean | If true, then Rush will add the "--strict-peer-dependencies" option when invoking PNPM. |
|
||||
| [useWorkspaces](./rush-lib.pnpmoptionsconfiguration.useworkspaces.md) | | boolean | If true, then Rush will use the workspaces feature to install and link packages when invoking PNPM. |
|
||||
|
||||
|
|
|
@ -1,27 +0,0 @@
|
|||
---
|
||||
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) > [@microsoft/rush-lib](./rush-lib.md) > [PnpmOptionsConfiguration](./rush-lib.pnpmoptionsconfiguration.md) > [resolutionStrategy](./rush-lib.pnpmoptionsconfiguration.resolutionstrategy.md)
|
||||
|
||||
## PnpmOptionsConfiguration.resolutionStrategy property
|
||||
|
||||
The resolution strategy that will be used by PNPM.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly resolutionStrategy: ResolutionStrategy;
|
||||
```
|
||||
|
||||
## Remarks
|
||||
|
||||
Configures the strategy used to select versions during installation.
|
||||
|
||||
This feature requires PNPM version 3.1 or newer. It corresponds to the `--resolution-strategy` command-line option for PNPM. Possible values are `"fast"` and `"fewer-dependencies"`<!-- -->. PNPM's default is `"fast"`<!-- -->, but this may be incompatible with certain packages, for example the `@types` packages from DefinitelyTyped. Rush's default is `"fewer-dependencies"`<!-- -->, which causes PNPM to avoid installing a newer version if an already installed version can be reused; this is more similar to NPM's algorithm.
|
||||
|
||||
For more background, see this discussion: [https://github.com/pnpm/pnpm/issues/1187](https://github.com/pnpm/pnpm/issues/1187)
|
||||
|
|
@ -22,6 +22,7 @@ export declare class RepoStateFile
|
|||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [filePath](./rush-lib.repostatefile.filepath.md) | | string | Get the absolute file path of the repo-state.json file. |
|
||||
| [isValid](./rush-lib.repostatefile.isvalid.md) | | boolean | If false, the repo-state.json file is not valid and its values cannot be relied upon |
|
||||
| [pnpmShrinkwrapHash](./rush-lib.repostatefile.pnpmshrinkwraphash.md) | | string \| undefined | The hash of the pnpm shrinkwrap file at the end of the last update. |
|
||||
| [preferredVersionsHash](./rush-lib.repostatefile.preferredversionshash.md) | | string \| undefined | The hash of all preferred versions at the end of the last update. |
|
||||
|
||||
|
|
|
@ -1,18 +0,0 @@
|
|||
---
|
||||
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) > [@microsoft/rush-lib](./rush-lib.md) > [ResolutionStrategy](./rush-lib.resolutionstrategy.md)
|
||||
|
||||
## ResolutionStrategy type
|
||||
|
||||
This represents the available PNPM resolution strategies as a string
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export declare type ResolutionStrategy = 'fewer-dependencies' | 'fast';
|
||||
```
|
|
@ -37,6 +37,7 @@ export declare class RushConfiguration
|
|||
| [eventHooks](./rush-lib.rushconfiguration.eventhooks.md) | | [EventHooks](./rush-lib.eventhooks.md) | <b><i>(BETA)</i></b> The rush hooks. It allows customized scripts to run at the specified point. |
|
||||
| [experimentsConfiguration](./rush-lib.rushconfiguration.experimentsconfiguration.md) | | [ExperimentsConfiguration](./rush-lib.experimentsconfiguration.md) | <b><i>(BETA)</i></b> This configuration object contains settings repo maintainers have specified to enable and disable experimental Rush features. |
|
||||
| [gitAllowedEmailRegExps](./rush-lib.rushconfiguration.gitallowedemailregexps.md) | | string\[\] | \[Part of the "gitPolicy" feature.\] A list of regular expressions describing allowable email patterns for Git commits. They are case-insensitive anchored JavaScript RegExps. Example: <code>".*@example\.com"</code> This array will never be undefined. |
|
||||
| [gitChangeLogUpdateCommitMessage](./rush-lib.rushconfiguration.gitchangelogupdatecommitmessage.md) | | string \| undefined | \[Part of the "gitPolicy" feature.\] The commit message to use when committing change log files 'rush version' |
|
||||
| [gitSampleEmail](./rush-lib.rushconfiguration.gitsampleemail.md) | | string | \[Part of the "gitPolicy" feature.\] An example valid email address that conforms to one of the allowedEmailRegExps. Example: <code>"foxtrot@example\.com"</code> This will never be undefined, and will always be nonempty if gitAllowedEmailRegExps is used. |
|
||||
| [gitVersionBumpCommitMessage](./rush-lib.rushconfiguration.gitversionbumpcommitmessage.md) | | string \| undefined | \[Part of the "gitPolicy" feature.\] The commit message to use when committing changes during 'rush publish' |
|
||||
| [hotfixChangeEnabled](./rush-lib.rushconfiguration.hotfixchangeenabled.md) | | boolean | \[Part of the "hotfixChange" feature.\] Enables creating hotfix changes |
|
||||
|
@ -78,9 +79,11 @@ export declare class RushConfiguration
|
|||
| --- | --- | --- |
|
||||
| [findProjectByShorthandName(shorthandProjectName)](./rush-lib.rushconfiguration.findprojectbyshorthandname.md) | | This is used e.g. by command-line interfaces such as "rush build --to example". If "example" is not a project name, then it also looks for a scoped name like <code>@something/example</code>. If exactly one project matches this heuristic, it is returned. Otherwise, undefined is returned. |
|
||||
| [findProjectByTempName(tempProjectName)](./rush-lib.rushconfiguration.findprojectbytempname.md) | | Looks up a project by its RushConfigurationProject.tempProjectName field. |
|
||||
| [findProjectForPosixRelativePath(posixRelativePath)](./rush-lib.rushconfiguration.findprojectforposixrelativepath.md) | | Finds the project that owns the specified POSIX relative path (e.g. apps/rush-lib). The path is case-sensitive, so will only return a project if its projectRelativePath matches the casing. |
|
||||
| [getCommittedShrinkwrapFilename(variant)](./rush-lib.rushconfiguration.getcommittedshrinkwrapfilename.md) | | Gets the committed shrinkwrap file name for a specific variant. |
|
||||
| [getCommonVersions(variant)](./rush-lib.rushconfiguration.getcommonversions.md) | | Gets the settings from the common-versions.json config file for a specific variant. |
|
||||
| [getCommonVersionsFilePath(variant)](./rush-lib.rushconfiguration.getcommonversionsfilepath.md) | | Gets the path to the common-versions.json config file for a specific variant. |
|
||||
| [getImplicitlyPreferredVersions(variant)](./rush-lib.rushconfiguration.getimplicitlypreferredversions.md) | | Returns a map of all direct dependencies that only have a single semantic version specifier. |
|
||||
| [getPnpmfilePath(variant)](./rush-lib.rushconfiguration.getpnpmfilepath.md) | | Gets the absolute path for "pnpmfile.js" for a specific variant. |
|
||||
| [getProjectByName(projectName)](./rush-lib.rushconfiguration.getprojectbyname.md) | | Looks up a project in the projectsByName map. If the project is not found, then undefined is returned. |
|
||||
| [getRepoState(variant)](./rush-lib.rushconfiguration.getrepostate.md) | | Gets the contents from the repo-state.json file for a specific variant. |
|
||||
|
|
|
@ -9,7 +9,12 @@ improve_this_button: false
|
|||
|
||||
## RushConfigurationProject.downstreamDependencyProjects property
|
||||
|
||||
A list of projects within the Rush configuration which directly depend on this package.
|
||||
> Warning: This API is now obsolete.
|
||||
>
|
||||
> Use `consumingProjectNames` instead, as it has Set semantics, which better reflect the nature of the data.
|
||||
>
|
||||
|
||||
An array of projects within the Rush configuration which directly depend on this package.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
|
|
|
@ -9,7 +9,12 @@ improve_this_button: false
|
|||
|
||||
## RushConfigurationProject.localDependencyProjects property
|
||||
|
||||
A map of projects within the Rush configuration which are directly depended on by this project
|
||||
> Warning: This API is now obsolete.
|
||||
>
|
||||
> Use `dependencyProjects` instead, as it has Set semantics, which better reflect the nature of the data.
|
||||
>
|
||||
|
||||
An array of projects within the Rush configuration which this project declares as dependencies.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
|
|
|
@ -25,16 +25,20 @@ The constructor for this class is marked as internal. Third-party code should no
|
|||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [consumingProjects](./rush-lib.rushconfigurationproject.consumingprojects.md) | | ReadonlySet<[RushConfigurationProject](./rush-lib.rushconfigurationproject.md)<!-- -->> | The set of projects within the Rush configuration which declare this project as a dependency. Excludes those that declare this project as a <code>cyclicDependencyProject</code>. |
|
||||
| [cyclicDependencyProjects](./rush-lib.rushconfigurationproject.cyclicdependencyprojects.md) | | Set<string> | A list of local projects that appear as devDependencies for this project, but cannot be locally linked because it would create a cyclic dependency; instead, the last published version will be installed in the Common folder.<!-- -->These are package names that would be found by RushConfiguration.getProjectByName(). |
|
||||
| [downstreamDependencyProjects](./rush-lib.rushconfigurationproject.downstreamdependencyprojects.md) | | string\[\] | A list of projects within the Rush configuration which directly depend on this package. |
|
||||
| [dependencyProjects](./rush-lib.rushconfigurationproject.dependencyprojects.md) | | ReadonlySet<[RushConfigurationProject](./rush-lib.rushconfigurationproject.md)<!-- -->> | The set of projects within the Rush configuration which this project declares as dependencies. |
|
||||
| [downstreamDependencyProjects](./rush-lib.rushconfigurationproject.downstreamdependencyprojects.md) | | string\[\] | An array of projects within the Rush configuration which directly depend on this package. |
|
||||
| [isMainProject](./rush-lib.rushconfigurationproject.ismainproject.md) | | boolean | <b><i>(BETA)</i></b> Indicate whether this project is the main project for the related version policy.<!-- -->False if the project is not for publishing. True if the project is individually versioned or if its lockstep version policy does not specify main project. False if the project is lockstepped and is not the main project for its version policy. |
|
||||
| [localDependencyProjects](./rush-lib.rushconfigurationproject.localdependencyprojects.md) | | ReadonlyArray<[RushConfigurationProject](./rush-lib.rushconfigurationproject.md)<!-- -->> | A map of projects within the Rush configuration which are directly depended on by this project |
|
||||
| [localDependencyProjects](./rush-lib.rushconfigurationproject.localdependencyprojects.md) | | ReadonlyArray<[RushConfigurationProject](./rush-lib.rushconfigurationproject.md)<!-- -->> | An array of projects within the Rush configuration which this project declares as dependencies. |
|
||||
| [packageJson](./rush-lib.rushconfigurationproject.packagejson.md) | | [IPackageJson](./node-core-library.ipackagejson.md) | The parsed NPM "package.json" file from projectFolder. |
|
||||
| [packageJsonEditor](./rush-lib.rushconfigurationproject.packagejsoneditor.md) | | [PackageJsonEditor](./rush-lib.packagejsoneditor.md) | <b><i>(BETA)</i></b> A useful wrapper around the package.json file for making modifications |
|
||||
| [packageName](./rush-lib.rushconfigurationproject.packagename.md) | | string | The name of the NPM package. An error is reported if this name is not identical to packageJson.name.<!-- -->Example: <code>@scope/MyProject</code> |
|
||||
| [projectFolder](./rush-lib.rushconfigurationproject.projectfolder.md) | | string | The full path of the folder that contains the project to be built by Rush.<!-- -->Example: <code>C:\MyRepo\libraries\my-project</code> |
|
||||
| [projectRelativeFolder](./rush-lib.rushconfigurationproject.projectrelativefolder.md) | | string | The relative path of the folder that contains the project to be built by Rush.<!-- -->Example: <code>libraries\my-project</code> |
|
||||
| [projectRelativeFolder](./rush-lib.rushconfigurationproject.projectrelativefolder.md) | | string | The relative path of the folder that contains the project to be built by Rush.<!-- -->Example: <code>libraries/my-project</code> |
|
||||
| [projectRushConfigFolder](./rush-lib.rushconfigurationproject.projectrushconfigfolder.md) | | string | The project-specific Rush configuration folder.<!-- -->Example: <code>C:\MyRepo\libraries\my-project\config\rush</code> |
|
||||
| [projectRushTempFolder](./rush-lib.rushconfigurationproject.projectrushtempfolder.md) | | string | The project-specific Rush temp folder. This folder is used to store Rush-specific temporary files.<!-- -->Example: <code>C:\MyRepo\libraries\my-project\.rush\temp</code> |
|
||||
| [publishFolder](./rush-lib.rushconfigurationproject.publishfolder.md) | | string | The full path of the folder that will get published by Rush. |
|
||||
| [reviewCategory](./rush-lib.rushconfigurationproject.reviewcategory.md) | | string \| undefined | The review category name, or undefined if no category was assigned. This name must be one of the valid choices listed in RushConfiguration.reviewCategories. |
|
||||
| [rushConfiguration](./rush-lib.rushconfigurationproject.rushconfiguration.md) | | [RushConfiguration](./rush-lib.rushconfiguration.md) | The Rush configuration for the monorepo that the project belongs to. |
|
||||
| [shouldPublish](./rush-lib.rushconfigurationproject.shouldpublish.md) | | boolean | A flag which indicates whether changes to this project should be published. This controls whether or not the project would show up when running <code>rush change</code>, and whether or not it should be published during <code>rush publish</code>. |
|
||||
|
|
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче