diff --git a/_data/api_nav.yaml b/_data/api_nav.yaml new file mode 100644 index 000000000..e826f5c84 --- /dev/null +++ b/_data/api_nav.yaml @@ -0,0 +1,2277 @@ +api_nav: + - title: API Reference + url: /pages/api/ + - title: '@microsoft/api-documenter' + url: /pages/api/api-documenter + subitems: + - title: IApiDocumenterPluginManifest + url: /pages/api/api-documenter.iapidocumenterpluginmanifest + subitems: + - title: features + url: /pages/api/api-documenter.iapidocumenterpluginmanifest.features + - title: manifestVersion + url: /pages/api/api-documenter.iapidocumenterpluginmanifest.manifestversion + - title: IFeatureDefinition + url: /pages/api/api-documenter.ifeaturedefinition + subitems: + - title: featureName + url: /pages/api/api-documenter.ifeaturedefinition.featurename + - title: kind + url: /pages/api/api-documenter.ifeaturedefinition.kind + - title: subclass + url: /pages/api/api-documenter.ifeaturedefinition.subclass + - title: IMarkdownDocumenterFeatureOnBeforeWritePageArgs + url: /pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs + subitems: + - title: apiItem + url: /pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.apiitem + - title: outputFilename + url: /pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.outputfilename + - title: pageContent + url: /pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.pagecontent + - title: IMarkdownDocumenterFeatureOnFinishedArgs + url: /pages/api/api-documenter.imarkdowndocumenterfeatureonfinishedargs + - title: MarkdownDocumenterAccessor + url: /pages/api/api-documenter.markdowndocumenteraccessor + subitems: + - title: getLinkForApiItem + url: /pages/api/api-documenter.markdowndocumenteraccessor.getlinkforapiitem + - title: MarkdownDocumenterFeature + url: /pages/api/api-documenter.markdowndocumenterfeature + subitems: + - title: context + url: /pages/api/api-documenter.markdowndocumenterfeature.context + - title: onBeforeWritePage + url: /pages/api/api-documenter.markdowndocumenterfeature.onbeforewritepage + - title: onFinished + url: /pages/api/api-documenter.markdowndocumenterfeature.onfinished + - title: MarkdownDocumenterFeatureContext + url: /pages/api/api-documenter.markdowndocumenterfeaturecontext + subitems: + - title: apiModel + url: /pages/api/api-documenter.markdowndocumenterfeaturecontext.apimodel + - title: documenter + url: /pages/api/api-documenter.markdowndocumenterfeaturecontext.documenter + - title: outputFolder + url: /pages/api/api-documenter.markdowndocumenterfeaturecontext.outputfolder + - title: PluginFeature + url: /pages/api/api-documenter.pluginfeature + subitems: + - title: context + url: /pages/api/api-documenter.pluginfeature.context + - title: onInitialized + url: /pages/api/api-documenter.pluginfeature.oninitialized + - title: PluginFeatureContext + url: /pages/api/api-documenter.pluginfeaturecontext + - title: PluginFeatureInitialization + url: /pages/api/api-documenter.pluginfeatureinitialization + - title: '@microsoft/api-extractor' + url: /pages/api/api-extractor + subitems: + - title: CompilerState + url: /pages/api/api-extractor.compilerstate + subitems: + - title: create + url: /pages/api/api-extractor.compilerstate.create + - title: program + url: /pages/api/api-extractor.compilerstate.program + - title: ConsoleMessageId + url: /pages/api/api-extractor.consolemessageid + - title: Extractor + url: /pages/api/api-extractor.extractor + subitems: + - title: invoke + url: /pages/api/api-extractor.extractor.invoke + - title: loadConfigAndInvoke + url: /pages/api/api-extractor.extractor.loadconfigandinvoke + - title: packageName + url: /pages/api/api-extractor.extractor.packagename + - title: version + url: /pages/api/api-extractor.extractor.version + - title: ExtractorConfig + url: /pages/api/api-extractor.extractorconfig + subitems: + - title: apiJsonFilePath + url: /pages/api/api-extractor.extractorconfig.apijsonfilepath + - title: apiReportEnabled + url: /pages/api/api-extractor.extractorconfig.apireportenabled + - title: betaTrimmedFilePath + url: /pages/api/api-extractor.extractorconfig.betatrimmedfilepath + - title: docModelEnabled + url: /pages/api/api-extractor.extractorconfig.docmodelenabled + - title: FILENAME + url: /pages/api/api-extractor.extractorconfig.filename + - title: getDiagnosticDump + url: /pages/api/api-extractor.extractorconfig.getdiagnosticdump + - title: hasDtsFileExtension + url: /pages/api/api-extractor.extractorconfig.hasdtsfileextension + - title: jsonSchema + url: /pages/api/api-extractor.extractorconfig.jsonschema + - title: loadFile + url: /pages/api/api-extractor.extractorconfig.loadfile + - title: loadFileAndPrepare + url: /pages/api/api-extractor.extractorconfig.loadfileandprepare + - title: mainEntryPointFilePath + url: /pages/api/api-extractor.extractorconfig.mainentrypointfilepath + - title: messages + url: /pages/api/api-extractor.extractorconfig.messages + - title: omitTrimmingComments + url: /pages/api/api-extractor.extractorconfig.omittrimmingcomments + - title: overrideTsconfig + url: /pages/api/api-extractor.extractorconfig.overridetsconfig + - title: packageFolder + url: /pages/api/api-extractor.extractorconfig.packagefolder + - title: packageJson + url: /pages/api/api-extractor.extractorconfig.packagejson + - title: prepare + url: /pages/api/api-extractor.extractorconfig.prepare + - title: projectFolder + url: /pages/api/api-extractor.extractorconfig.projectfolder + - title: publicTrimmedFilePath + url: /pages/api/api-extractor.extractorconfig.publictrimmedfilepath + - title: reportFilePath + url: /pages/api/api-extractor.extractorconfig.reportfilepath + - title: reportTempFilePath + url: /pages/api/api-extractor.extractorconfig.reporttempfilepath + - title: rollupEnabled + url: /pages/api/api-extractor.extractorconfig.rollupenabled + - title: skipLibCheck + url: /pages/api/api-extractor.extractorconfig.skiplibcheck + - title: testMode + url: /pages/api/api-extractor.extractorconfig.testmode + - title: tsconfigFilePath + url: /pages/api/api-extractor.extractorconfig.tsconfigfilepath + - title: tsdocMetadataEnabled + url: /pages/api/api-extractor.extractorconfig.tsdocmetadataenabled + - title: tsdocMetadataFilePath + url: /pages/api/api-extractor.extractorconfig.tsdocmetadatafilepath + - title: untrimmedFilePath + url: /pages/api/api-extractor.extractorconfig.untrimmedfilepath + - title: ExtractorLogLevel + url: /pages/api/api-extractor.extractorloglevel + - title: ExtractorMessage + url: /pages/api/api-extractor.extractormessage + subitems: + - title: category + url: /pages/api/api-extractor.extractormessage.category + - title: formatMessageWithLocation + url: /pages/api/api-extractor.extractormessage.formatmessagewithlocation + - title: formatMessageWithoutLocation + url: /pages/api/api-extractor.extractormessage.formatmessagewithoutlocation + - title: handled + url: /pages/api/api-extractor.extractormessage.handled + - title: logLevel + url: /pages/api/api-extractor.extractormessage.loglevel + - title: messageId + url: /pages/api/api-extractor.extractormessage.messageid + - title: properties + url: /pages/api/api-extractor.extractormessage.properties + - title: sourceFileColumn + url: /pages/api/api-extractor.extractormessage.sourcefilecolumn + - title: sourceFileLine + url: /pages/api/api-extractor.extractormessage.sourcefileline + - title: sourceFilePath + url: /pages/api/api-extractor.extractormessage.sourcefilepath + - title: text + url: /pages/api/api-extractor.extractormessage.text + - title: ExtractorMessageCategory + url: /pages/api/api-extractor.extractormessagecategory + - title: ExtractorMessageId + url: /pages/api/api-extractor.extractormessageid + - title: ExtractorResult + url: /pages/api/api-extractor.extractorresult + subitems: + - title: apiReportChanged + url: /pages/api/api-extractor.extractorresult.apireportchanged + - title: compilerState + url: /pages/api/api-extractor.extractorresult.compilerstate + - title: errorCount + url: /pages/api/api-extractor.extractorresult.errorcount + - title: extractorConfig + url: /pages/api/api-extractor.extractorresult.extractorconfig + - title: succeeded + url: /pages/api/api-extractor.extractorresult.succeeded + - title: warningCount + url: /pages/api/api-extractor.extractorresult.warningcount + - title: ICompilerStateCreateOptions + url: /pages/api/api-extractor.icompilerstatecreateoptions + subitems: + - title: additionalEntryPoints + url: /pages/api/api-extractor.icompilerstatecreateoptions.additionalentrypoints + - title: typescriptCompilerFolder + url: /pages/api/api-extractor.icompilerstatecreateoptions.typescriptcompilerfolder + - title: IConfigApiReport + url: /pages/api/api-extractor.iconfigapireport + subitems: + - title: enabled + url: /pages/api/api-extractor.iconfigapireport.enabled + - title: reportFileName + url: /pages/api/api-extractor.iconfigapireport.reportfilename + - title: reportFolder + url: /pages/api/api-extractor.iconfigapireport.reportfolder + - title: reportTempFolder + url: /pages/api/api-extractor.iconfigapireport.reporttempfolder + - title: IConfigCompiler + url: /pages/api/api-extractor.iconfigcompiler + subitems: + - title: overrideTsconfig + url: /pages/api/api-extractor.iconfigcompiler.overridetsconfig + - title: skipLibCheck + url: /pages/api/api-extractor.iconfigcompiler.skiplibcheck + - title: tsconfigFilePath + url: /pages/api/api-extractor.iconfigcompiler.tsconfigfilepath + - title: IConfigDocModel + url: /pages/api/api-extractor.iconfigdocmodel + subitems: + - title: apiJsonFilePath + url: /pages/api/api-extractor.iconfigdocmodel.apijsonfilepath + - title: enabled + url: /pages/api/api-extractor.iconfigdocmodel.enabled + - title: IConfigDtsRollup + url: /pages/api/api-extractor.iconfigdtsrollup + subitems: + - title: betaTrimmedFilePath + url: /pages/api/api-extractor.iconfigdtsrollup.betatrimmedfilepath + - title: enabled + url: /pages/api/api-extractor.iconfigdtsrollup.enabled + - title: omitTrimmingComments + url: /pages/api/api-extractor.iconfigdtsrollup.omittrimmingcomments + - title: publicTrimmedFilePath + url: /pages/api/api-extractor.iconfigdtsrollup.publictrimmedfilepath + - title: untrimmedFilePath + url: /pages/api/api-extractor.iconfigdtsrollup.untrimmedfilepath + - title: IConfigFile + url: /pages/api/api-extractor.iconfigfile + subitems: + - title: apiReport + url: /pages/api/api-extractor.iconfigfile.apireport + - title: compiler + url: /pages/api/api-extractor.iconfigfile.compiler + - title: docModel + url: /pages/api/api-extractor.iconfigfile.docmodel + - title: dtsRollup + url: /pages/api/api-extractor.iconfigfile.dtsrollup + - title: extends + url: /pages/api/api-extractor.iconfigfile.extends + - title: mainEntryPointFilePath + url: /pages/api/api-extractor.iconfigfile.mainentrypointfilepath + - title: messages + url: /pages/api/api-extractor.iconfigfile.messages + - title: projectFolder + url: /pages/api/api-extractor.iconfigfile.projectfolder + - title: testMode + url: /pages/api/api-extractor.iconfigfile.testmode + - title: tsdocMetadata + url: /pages/api/api-extractor.iconfigfile.tsdocmetadata + - title: IConfigMessageReportingRule + url: /pages/api/api-extractor.iconfigmessagereportingrule + subitems: + - title: addToApiReportFile + url: /pages/api/api-extractor.iconfigmessagereportingrule.addtoapireportfile + - title: logLevel + url: /pages/api/api-extractor.iconfigmessagereportingrule.loglevel + - title: IConfigMessageReportingTable + url: /pages/api/api-extractor.iconfigmessagereportingtable + - title: IConfigTsdocMetadata + url: /pages/api/api-extractor.iconfigtsdocmetadata + subitems: + - title: enabled + url: /pages/api/api-extractor.iconfigtsdocmetadata.enabled + - title: tsdocMetadataFilePath + url: /pages/api/api-extractor.iconfigtsdocmetadata.tsdocmetadatafilepath + - title: IExtractorConfigPrepareOptions + url: /pages/api/api-extractor.iextractorconfigprepareoptions + subitems: + - title: configObject + url: /pages/api/api-extractor.iextractorconfigprepareoptions.configobject + - title: configObjectFullPath + url: /pages/api/api-extractor.iextractorconfigprepareoptions.configobjectfullpath + - title: packageJson + url: /pages/api/api-extractor.iextractorconfigprepareoptions.packagejson + - title: packageJsonFullPath + url: /pages/api/api-extractor.iextractorconfigprepareoptions.packagejsonfullpath + - title: IExtractorInvokeOptions + url: /pages/api/api-extractor.iextractorinvokeoptions + subitems: + - title: compilerState + url: /pages/api/api-extractor.iextractorinvokeoptions.compilerstate + - title: localBuild + url: /pages/api/api-extractor.iextractorinvokeoptions.localbuild + - title: messageCallback + url: /pages/api/api-extractor.iextractorinvokeoptions.messagecallback + - title: showDiagnostics + url: /pages/api/api-extractor.iextractorinvokeoptions.showdiagnostics + - title: showVerboseMessages + url: /pages/api/api-extractor.iextractorinvokeoptions.showverbosemessages + - title: typescriptCompilerFolder + url: /pages/api/api-extractor.iextractorinvokeoptions.typescriptcompilerfolder + - title: IExtractorMessageProperties + url: /pages/api/api-extractor.iextractormessageproperties + subitems: + - title: exportName + url: /pages/api/api-extractor.iextractormessageproperties.exportname + - title: IExtractorMessagesConfig + url: /pages/api/api-extractor.iextractormessagesconfig + subitems: + - title: compilerMessageReporting + url: /pages/api/api-extractor.iextractormessagesconfig.compilermessagereporting + - title: extractorMessageReporting + url: /pages/api/api-extractor.iextractormessagesconfig.extractormessagereporting + - title: tsdocMessageReporting + url: /pages/api/api-extractor.iextractormessagesconfig.tsdocmessagereporting + - title: '@microsoft/api-extractor-model' + url: /pages/api/api-extractor-model + subitems: + - title: ApiCallSignature + url: /pages/api/api-extractor-model.apicallsignature + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apicallsignature._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apicallsignature.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apicallsignature.containerkey + - title: getContainerKey + url: /pages/api/api-extractor-model.apicallsignature.getcontainerkey + - title: kind + url: /pages/api/api-extractor-model.apicallsignature.kind + - title: ApiClass + url: /pages/api/api-extractor-model.apiclass + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apiclass._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apiclass.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apiclass.containerkey + - title: extendsType + url: /pages/api/api-extractor-model.apiclass.extendstype + - title: getContainerKey + url: /pages/api/api-extractor-model.apiclass.getcontainerkey + - title: implementsTypes + url: /pages/api/api-extractor-model.apiclass.implementstypes + - title: kind + url: /pages/api/api-extractor-model.apiclass.kind + - title: onDeserializeInto + url: /pages/api/api-extractor-model.apiclass.ondeserializeinto + - title: serializeInto + url: /pages/api/api-extractor-model.apiclass.serializeinto + - title: ApiConstructor + url: /pages/api/api-extractor-model.apiconstructor + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apiconstructor._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apiconstructor.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apiconstructor.containerkey + - title: getContainerKey + url: /pages/api/api-extractor-model.apiconstructor.getcontainerkey + - title: kind + url: /pages/api/api-extractor-model.apiconstructor.kind + - title: ApiConstructSignature + url: /pages/api/api-extractor-model.apiconstructsignature + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apiconstructsignature._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apiconstructsignature.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apiconstructsignature.containerkey + - title: getContainerKey + url: /pages/api/api-extractor-model.apiconstructsignature.getcontainerkey + - title: kind + url: /pages/api/api-extractor-model.apiconstructsignature.kind + - title: ApiDeclaredItem + url: /pages/api/api-extractor-model.apideclareditem + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apideclareditem._constructor_ + - title: buildExcerpt + url: /pages/api/api-extractor-model.apideclareditem.buildexcerpt + - title: excerpt + url: /pages/api/api-extractor-model.apideclareditem.excerpt + - title: excerptTokens + url: /pages/api/api-extractor-model.apideclareditem.excerpttokens + - title: getExcerptWithModifiers + url: /pages/api/api-extractor-model.apideclareditem.getexcerptwithmodifiers + - title: onDeserializeInto + url: /pages/api/api-extractor-model.apideclareditem.ondeserializeinto + - title: serializeInto + url: /pages/api/api-extractor-model.apideclareditem.serializeinto + - title: ApiDocumentedItem + url: /pages/api/api-extractor-model.apidocumenteditem + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apidocumenteditem._constructor_ + - title: onDeserializeInto + url: /pages/api/api-extractor-model.apidocumenteditem.ondeserializeinto + - title: serializeInto + url: /pages/api/api-extractor-model.apidocumenteditem.serializeinto + - title: tsdocComment + url: /pages/api/api-extractor-model.apidocumenteditem.tsdoccomment + - title: ApiEntryPoint + url: /pages/api/api-extractor-model.apientrypoint + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apientrypoint._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apientrypoint.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apientrypoint.containerkey + - title: importPath + url: /pages/api/api-extractor-model.apientrypoint.importpath + - title: kind + url: /pages/api/api-extractor-model.apientrypoint.kind + - title: ApiEnum + url: /pages/api/api-extractor-model.apienum + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apienum._constructor_ + - title: addMember + url: /pages/api/api-extractor-model.apienum.addmember + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apienum.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apienum.containerkey + - title: getContainerKey + url: /pages/api/api-extractor-model.apienum.getcontainerkey + - title: kind + url: /pages/api/api-extractor-model.apienum.kind + - title: members + url: /pages/api/api-extractor-model.apienum.members + - title: ApiEnumMember + url: /pages/api/api-extractor-model.apienummember + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apienummember._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apienummember.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apienummember.containerkey + - title: getContainerKey + url: /pages/api/api-extractor-model.apienummember.getcontainerkey + - title: initializerExcerpt + url: /pages/api/api-extractor-model.apienummember.initializerexcerpt + - title: kind + url: /pages/api/api-extractor-model.apienummember.kind + - title: onDeserializeInto + url: /pages/api/api-extractor-model.apienummember.ondeserializeinto + - title: serializeInto + url: /pages/api/api-extractor-model.apienummember.serializeinto + - title: ApiFunction + url: /pages/api/api-extractor-model.apifunction + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apifunction._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apifunction.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apifunction.containerkey + - title: getContainerKey + url: /pages/api/api-extractor-model.apifunction.getcontainerkey + - title: kind + url: /pages/api/api-extractor-model.apifunction.kind + - title: ApiIndexSignature + url: /pages/api/api-extractor-model.apiindexsignature + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apiindexsignature._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apiindexsignature.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apiindexsignature.containerkey + - title: getContainerKey + url: /pages/api/api-extractor-model.apiindexsignature.getcontainerkey + - title: kind + url: /pages/api/api-extractor-model.apiindexsignature.kind + - title: ApiInterface + url: /pages/api/api-extractor-model.apiinterface + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apiinterface._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apiinterface.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apiinterface.containerkey + - title: extendsTypes + url: /pages/api/api-extractor-model.apiinterface.extendstypes + - title: getContainerKey + url: /pages/api/api-extractor-model.apiinterface.getcontainerkey + - title: kind + url: /pages/api/api-extractor-model.apiinterface.kind + - title: onDeserializeInto + url: /pages/api/api-extractor-model.apiinterface.ondeserializeinto + - title: serializeInto + url: /pages/api/api-extractor-model.apiinterface.serializeinto + - title: ApiItem + url: /pages/api/api-extractor-model.apiitem + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apiitem._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apiitem.buildcanonicalreference + - title: canonicalReference + url: /pages/api/api-extractor-model.apiitem.canonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apiitem.containerkey + - title: deserialize + url: /pages/api/api-extractor-model.apiitem.deserialize + - title: displayName + url: /pages/api/api-extractor-model.apiitem.displayname + - title: getAssociatedPackage + url: /pages/api/api-extractor-model.apiitem.getassociatedpackage + - title: getHierarchy + url: /pages/api/api-extractor-model.apiitem.gethierarchy + - title: getScopedNameWithinPackage + url: /pages/api/api-extractor-model.apiitem.getscopednamewithinpackage + - title: getSortKey + url: /pages/api/api-extractor-model.apiitem.getsortkey + - title: kind + url: /pages/api/api-extractor-model.apiitem.kind + - title: members + url: /pages/api/api-extractor-model.apiitem.members + - title: onDeserializeInto + url: /pages/api/api-extractor-model.apiitem.ondeserializeinto + - title: parent + url: /pages/api/api-extractor-model.apiitem.parent + - title: serializeInto + url: /pages/api/api-extractor-model.apiitem.serializeinto + - title: ApiItemContainerMixin + url: /pages/api/api-extractor-model.apiitemcontainermixin + - title: ApiItemContainerMixin + url: /pages/api/api-extractor-model.apiitemcontainermixin + subitems: + - title: addMember + url: /pages/api/api-extractor-model.apiitemcontainermixin.addmember + - title: findMembersByName + url: /pages/api/api-extractor-model.apiitemcontainermixin.findmembersbyname + - title: members + url: /pages/api/api-extractor-model.apiitemcontainermixin.members + - title: serializeInto + url: /pages/api/api-extractor-model.apiitemcontainermixin.serializeinto + - title: tryGetMemberByKey + url: /pages/api/api-extractor-model.apiitemcontainermixin.trygetmemberbykey + - title: ApiItemContainerMixin + url: /pages/api/api-extractor-model.apiitemcontainermixin + subitems: + - title: isBaseClassOf + url: /pages/api/api-extractor-model.apiitemcontainermixin.isbaseclassof + - title: ApiItemKind + url: /pages/api/api-extractor-model.apiitemkind + - title: ApiMethod + url: /pages/api/api-extractor-model.apimethod + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apimethod._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apimethod.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apimethod.containerkey + - title: getContainerKey + url: /pages/api/api-extractor-model.apimethod.getcontainerkey + - title: kind + url: /pages/api/api-extractor-model.apimethod.kind + - title: ApiMethodSignature + url: /pages/api/api-extractor-model.apimethodsignature + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apimethodsignature._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apimethodsignature.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apimethodsignature.containerkey + - title: getContainerKey + url: /pages/api/api-extractor-model.apimethodsignature.getcontainerkey + - title: kind + url: /pages/api/api-extractor-model.apimethodsignature.kind + - title: ApiModel + url: /pages/api/api-extractor-model.apimodel + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apimodel._constructor_ + - title: addMember + url: /pages/api/api-extractor-model.apimodel.addmember + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apimodel.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apimodel.containerkey + - title: kind + url: /pages/api/api-extractor-model.apimodel.kind + - title: loadPackage + url: /pages/api/api-extractor-model.apimodel.loadpackage + - title: packages + url: /pages/api/api-extractor-model.apimodel.packages + - title: resolveDeclarationReference + url: /pages/api/api-extractor-model.apimodel.resolvedeclarationreference + - title: tryGetPackageByName + url: /pages/api/api-extractor-model.apimodel.trygetpackagebyname + - title: ApiNameMixin + url: /pages/api/api-extractor-model.apinamemixin + - title: ApiNameMixin + url: /pages/api/api-extractor-model.apinamemixin + subitems: + - title: name + url: /pages/api/api-extractor-model.apinamemixin.name + - title: serializeInto + url: /pages/api/api-extractor-model.apinamemixin.serializeinto + - title: ApiNameMixin + url: /pages/api/api-extractor-model.apinamemixin + subitems: + - title: isBaseClassOf + url: /pages/api/api-extractor-model.apinamemixin.isbaseclassof + - title: ApiNamespace + url: /pages/api/api-extractor-model.apinamespace + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apinamespace._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apinamespace.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apinamespace.containerkey + - title: getContainerKey + url: /pages/api/api-extractor-model.apinamespace.getcontainerkey + - title: kind + url: /pages/api/api-extractor-model.apinamespace.kind + - title: ApiPackage + url: /pages/api/api-extractor-model.apipackage + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apipackage._constructor_ + - title: addMember + url: /pages/api/api-extractor-model.apipackage.addmember + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apipackage.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apipackage.containerkey + - title: entryPoints + url: /pages/api/api-extractor-model.apipackage.entrypoints + - title: findEntryPointsByPath + url: /pages/api/api-extractor-model.apipackage.findentrypointsbypath + - title: kind + url: /pages/api/api-extractor-model.apipackage.kind + - title: loadFromJsonFile + url: /pages/api/api-extractor-model.apipackage.loadfromjsonfile + - title: saveToJsonFile + url: /pages/api/api-extractor-model.apipackage.savetojsonfile + - title: ApiParameterListMixin + url: /pages/api/api-extractor-model.apiparameterlistmixin + - title: ApiParameterListMixin + url: /pages/api/api-extractor-model.apiparameterlistmixin + subitems: + - title: overloadIndex + url: /pages/api/api-extractor-model.apiparameterlistmixin.overloadindex + - title: parameters + url: /pages/api/api-extractor-model.apiparameterlistmixin.parameters + - title: serializeInto + url: /pages/api/api-extractor-model.apiparameterlistmixin.serializeinto + - title: ApiParameterListMixin + url: /pages/api/api-extractor-model.apiparameterlistmixin + subitems: + - title: isBaseClassOf + url: /pages/api/api-extractor-model.apiparameterlistmixin.isbaseclassof + - title: ApiProperty + url: /pages/api/api-extractor-model.apiproperty + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apiproperty._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apiproperty.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apiproperty.containerkey + - title: getContainerKey + url: /pages/api/api-extractor-model.apiproperty.getcontainerkey + - title: kind + url: /pages/api/api-extractor-model.apiproperty.kind + - title: ApiPropertyItem + url: /pages/api/api-extractor-model.apipropertyitem + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apipropertyitem._constructor_ + - title: isEventProperty + url: /pages/api/api-extractor-model.apipropertyitem.iseventproperty + - title: onDeserializeInto + url: /pages/api/api-extractor-model.apipropertyitem.ondeserializeinto + - title: propertyTypeExcerpt + url: /pages/api/api-extractor-model.apipropertyitem.propertytypeexcerpt + - title: serializeInto + url: /pages/api/api-extractor-model.apipropertyitem.serializeinto + - title: ApiPropertySignature + url: /pages/api/api-extractor-model.apipropertysignature + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apipropertysignature._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apipropertysignature.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apipropertysignature.containerkey + - title: getContainerKey + url: /pages/api/api-extractor-model.apipropertysignature.getcontainerkey + - title: kind + url: /pages/api/api-extractor-model.apipropertysignature.kind + - title: ApiReleaseTagMixin + url: /pages/api/api-extractor-model.apireleasetagmixin + - title: ApiReleaseTagMixin + url: /pages/api/api-extractor-model.apireleasetagmixin + subitems: + - title: releaseTag + url: /pages/api/api-extractor-model.apireleasetagmixin.releasetag + - title: serializeInto + url: /pages/api/api-extractor-model.apireleasetagmixin.serializeinto + - title: ApiReleaseTagMixin + url: /pages/api/api-extractor-model.apireleasetagmixin + subitems: + - title: isBaseClassOf + url: /pages/api/api-extractor-model.apireleasetagmixin.isbaseclassof + - title: ApiReturnTypeMixin + url: /pages/api/api-extractor-model.apireturntypemixin + - title: ApiReturnTypeMixin + url: /pages/api/api-extractor-model.apireturntypemixin + subitems: + - title: returnTypeExcerpt + url: /pages/api/api-extractor-model.apireturntypemixin.returntypeexcerpt + - title: serializeInto + url: /pages/api/api-extractor-model.apireturntypemixin.serializeinto + - title: ApiReturnTypeMixin + url: /pages/api/api-extractor-model.apireturntypemixin + subitems: + - title: isBaseClassOf + url: /pages/api/api-extractor-model.apireturntypemixin.isbaseclassof + - title: ApiStaticMixin + url: /pages/api/api-extractor-model.apistaticmixin + - title: ApiStaticMixin + url: /pages/api/api-extractor-model.apistaticmixin + subitems: + - title: isStatic + url: /pages/api/api-extractor-model.apistaticmixin.isstatic + - title: serializeInto + url: /pages/api/api-extractor-model.apistaticmixin.serializeinto + - title: ApiStaticMixin + url: /pages/api/api-extractor-model.apistaticmixin + subitems: + - title: isBaseClassOf + url: /pages/api/api-extractor-model.apistaticmixin.isbaseclassof + - title: ApiTypeAlias + url: /pages/api/api-extractor-model.apitypealias + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apitypealias._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apitypealias.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apitypealias.containerkey + - title: getContainerKey + url: /pages/api/api-extractor-model.apitypealias.getcontainerkey + - title: kind + url: /pages/api/api-extractor-model.apitypealias.kind + - title: onDeserializeInto + url: /pages/api/api-extractor-model.apitypealias.ondeserializeinto + - title: serializeInto + url: /pages/api/api-extractor-model.apitypealias.serializeinto + - title: typeExcerpt + url: /pages/api/api-extractor-model.apitypealias.typeexcerpt + - title: ApiTypeParameterListMixin + url: /pages/api/api-extractor-model.apitypeparameterlistmixin + - title: ApiTypeParameterListMixin + url: /pages/api/api-extractor-model.apitypeparameterlistmixin + subitems: + - title: serializeInto + url: /pages/api/api-extractor-model.apitypeparameterlistmixin.serializeinto + - title: typeParameters + url: /pages/api/api-extractor-model.apitypeparameterlistmixin.typeparameters + - title: ApiTypeParameterListMixin + url: /pages/api/api-extractor-model.apitypeparameterlistmixin + subitems: + - title: isBaseClassOf + url: /pages/api/api-extractor-model.apitypeparameterlistmixin.isbaseclassof + - title: ApiVariable + url: /pages/api/api-extractor-model.apivariable + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.apivariable._constructor_ + - title: buildCanonicalReference + url: /pages/api/api-extractor-model.apivariable.buildcanonicalreference + - title: containerKey + url: /pages/api/api-extractor-model.apivariable.containerkey + - title: getContainerKey + url: /pages/api/api-extractor-model.apivariable.getcontainerkey + - title: kind + url: /pages/api/api-extractor-model.apivariable.kind + - title: onDeserializeInto + url: /pages/api/api-extractor-model.apivariable.ondeserializeinto + - title: serializeInto + url: /pages/api/api-extractor-model.apivariable.serializeinto + - title: variableTypeExcerpt + url: /pages/api/api-extractor-model.apivariable.variabletypeexcerpt + - title: Constructor + url: /pages/api/api-extractor-model.constructor + - title: Excerpt + url: /pages/api/api-extractor-model.excerpt + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.excerpt._constructor_ + - title: isEmpty + url: /pages/api/api-extractor-model.excerpt.isempty + - title: text + url: /pages/api/api-extractor-model.excerpt.text + - title: tokenRange + url: /pages/api/api-extractor-model.excerpt.tokenrange + - title: tokens + url: /pages/api/api-extractor-model.excerpt.tokens + - title: ExcerptToken + url: /pages/api/api-extractor-model.excerpttoken + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.excerpttoken._constructor_ + - title: kind + url: /pages/api/api-extractor-model.excerpttoken.kind + - title: text + url: /pages/api/api-extractor-model.excerpttoken.text + - title: ExcerptTokenKind + url: /pages/api/api-extractor-model.excerpttokenkind + - title: HeritageType + url: /pages/api/api-extractor-model.heritagetype + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.heritagetype._constructor_ + - title: excerpt + url: /pages/api/api-extractor-model.heritagetype.excerpt + - title: IApiCallSignatureOptions + url: /pages/api/api-extractor-model.iapicallsignatureoptions + - title: IApiClassOptions + url: /pages/api/api-extractor-model.iapiclassoptions + subitems: + - title: extendsTokenRange + url: /pages/api/api-extractor-model.iapiclassoptions.extendstokenrange + - title: implementsTokenRanges + url: /pages/api/api-extractor-model.iapiclassoptions.implementstokenranges + - title: IApiConstructorOptions + url: /pages/api/api-extractor-model.iapiconstructoroptions + - title: IApiConstructSignatureOptions + url: /pages/api/api-extractor-model.iapiconstructsignatureoptions + - title: IApiDeclaredItemOptions + url: /pages/api/api-extractor-model.iapideclareditemoptions + subitems: + - title: excerptTokens + url: /pages/api/api-extractor-model.iapideclareditemoptions.excerpttokens + - title: IApiDocumentedItemOptions + url: /pages/api/api-extractor-model.iapidocumenteditemoptions + subitems: + - title: docComment + url: /pages/api/api-extractor-model.iapidocumenteditemoptions.doccomment + - title: IApiEntryPointOptions + url: /pages/api/api-extractor-model.iapientrypointoptions + - title: IApiEnumMemberOptions + url: /pages/api/api-extractor-model.iapienummemberoptions + subitems: + - title: initializerTokenRange + url: /pages/api/api-extractor-model.iapienummemberoptions.initializertokenrange + - title: IApiEnumOptions + url: /pages/api/api-extractor-model.iapienumoptions + - title: IApiFunctionOptions + url: /pages/api/api-extractor-model.iapifunctionoptions + - title: IApiIndexSignatureOptions + url: /pages/api/api-extractor-model.iapiindexsignatureoptions + - title: IApiInterfaceOptions + url: /pages/api/api-extractor-model.iapiinterfaceoptions + subitems: + - title: extendsTokenRanges + url: /pages/api/api-extractor-model.iapiinterfaceoptions.extendstokenranges + - title: IApiItemConstructor + url: /pages/api/api-extractor-model.iapiitemconstructor + - title: IApiItemContainerMixinOptions + url: /pages/api/api-extractor-model.iapiitemcontainermixinoptions + subitems: + - title: members + url: /pages/api/api-extractor-model.iapiitemcontainermixinoptions.members + - title: IApiItemOptions + url: /pages/api/api-extractor-model.iapiitemoptions + - title: IApiMethodOptions + url: /pages/api/api-extractor-model.iapimethodoptions + - title: IApiMethodSignatureOptions + url: /pages/api/api-extractor-model.iapimethodsignatureoptions + - title: IApiNameMixinOptions + url: /pages/api/api-extractor-model.iapinamemixinoptions + subitems: + - title: name + url: /pages/api/api-extractor-model.iapinamemixinoptions.name + - title: IApiNamespaceOptions + url: /pages/api/api-extractor-model.iapinamespaceoptions + - title: IApiPackageOptions + url: /pages/api/api-extractor-model.iapipackageoptions + - title: IApiPackageSaveOptions + url: /pages/api/api-extractor-model.iapipackagesaveoptions + subitems: + - title: testMode + url: /pages/api/api-extractor-model.iapipackagesaveoptions.testmode + - title: toolPackage + url: /pages/api/api-extractor-model.iapipackagesaveoptions.toolpackage + - title: toolVersion + url: /pages/api/api-extractor-model.iapipackagesaveoptions.toolversion + - title: IApiParameterListMixinOptions + url: /pages/api/api-extractor-model.iapiparameterlistmixinoptions + subitems: + - title: overloadIndex + url: /pages/api/api-extractor-model.iapiparameterlistmixinoptions.overloadindex + - title: parameters + url: /pages/api/api-extractor-model.iapiparameterlistmixinoptions.parameters + - title: IApiParameterOptions + url: /pages/api/api-extractor-model.iapiparameteroptions + subitems: + - title: parameterName + url: /pages/api/api-extractor-model.iapiparameteroptions.parametername + - title: parameterTypeTokenRange + url: /pages/api/api-extractor-model.iapiparameteroptions.parametertypetokenrange + - title: IApiPropertyItemOptions + url: /pages/api/api-extractor-model.iapipropertyitemoptions + subitems: + - title: propertyTypeTokenRange + url: /pages/api/api-extractor-model.iapipropertyitemoptions.propertytypetokenrange + - title: IApiPropertyOptions + url: /pages/api/api-extractor-model.iapipropertyoptions + - title: IApiPropertySignatureOptions + url: /pages/api/api-extractor-model.iapipropertysignatureoptions + - title: IApiReleaseTagMixinOptions + url: /pages/api/api-extractor-model.iapireleasetagmixinoptions + subitems: + - title: releaseTag + url: /pages/api/api-extractor-model.iapireleasetagmixinoptions.releasetag + - title: IApiReturnTypeMixinOptions + url: /pages/api/api-extractor-model.iapireturntypemixinoptions + subitems: + - title: returnTypeTokenRange + url: /pages/api/api-extractor-model.iapireturntypemixinoptions.returntypetokenrange + - title: IApiStaticMixinOptions + url: /pages/api/api-extractor-model.iapistaticmixinoptions + subitems: + - title: isStatic + url: /pages/api/api-extractor-model.iapistaticmixinoptions.isstatic + - title: IApiTypeAliasOptions + url: /pages/api/api-extractor-model.iapitypealiasoptions + subitems: + - title: typeTokenRange + url: /pages/api/api-extractor-model.iapitypealiasoptions.typetokenrange + - title: IApiTypeParameterListMixinOptions + url: /pages/api/api-extractor-model.iapitypeparameterlistmixinoptions + subitems: + - title: typeParameters + url: /pages/api/api-extractor-model.iapitypeparameterlistmixinoptions.typeparameters + - title: IApiTypeParameterOptions + url: /pages/api/api-extractor-model.iapitypeparameteroptions + subitems: + - title: constraintTokenRange + url: /pages/api/api-extractor-model.iapitypeparameteroptions.constrainttokenrange + - title: defaultTypeTokenRange + url: /pages/api/api-extractor-model.iapitypeparameteroptions.defaulttypetokenrange + - title: typeParameterName + url: /pages/api/api-extractor-model.iapitypeparameteroptions.typeparametername + - title: IApiVariableOptions + url: /pages/api/api-extractor-model.iapivariableoptions + subitems: + - title: variableTypeTokenRange + url: /pages/api/api-extractor-model.iapivariableoptions.variabletypetokenrange + - title: IExcerptToken + url: /pages/api/api-extractor-model.iexcerpttoken + subitems: + - title: kind + url: /pages/api/api-extractor-model.iexcerpttoken.kind + - title: text + url: /pages/api/api-extractor-model.iexcerpttoken.text + - title: IExcerptTokenRange + url: /pages/api/api-extractor-model.iexcerpttokenrange + subitems: + - title: endIndex + url: /pages/api/api-extractor-model.iexcerpttokenrange.endindex + - title: startIndex + url: /pages/api/api-extractor-model.iexcerpttokenrange.startindex + - title: IParameterOptions + url: /pages/api/api-extractor-model.iparameteroptions + subitems: + - title: name + url: /pages/api/api-extractor-model.iparameteroptions.name + - title: parameterTypeExcerpt + url: /pages/api/api-extractor-model.iparameteroptions.parametertypeexcerpt + - title: parent + url: /pages/api/api-extractor-model.iparameteroptions.parent + - title: IResolveDeclarationReferenceResult + url: /pages/api/api-extractor-model.iresolvedeclarationreferenceresult + subitems: + - title: errorMessage + url: /pages/api/api-extractor-model.iresolvedeclarationreferenceresult.errormessage + - title: resolvedApiItem + url: /pages/api/api-extractor-model.iresolvedeclarationreferenceresult.resolvedapiitem + - title: ITypeParameterOptions + url: /pages/api/api-extractor-model.itypeparameteroptions + subitems: + - title: constraintExcerpt + url: /pages/api/api-extractor-model.itypeparameteroptions.constraintexcerpt + - title: defaultTypeExcerpt + url: /pages/api/api-extractor-model.itypeparameteroptions.defaulttypeexcerpt + - title: name + url: /pages/api/api-extractor-model.itypeparameteroptions.name + - title: parent + url: /pages/api/api-extractor-model.itypeparameteroptions.parent + - title: Parameter + url: /pages/api/api-extractor-model.parameter + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.parameter._constructor_ + - title: name + url: /pages/api/api-extractor-model.parameter.name + - title: parameterTypeExcerpt + url: /pages/api/api-extractor-model.parameter.parametertypeexcerpt + - title: tsdocParamBlock + url: /pages/api/api-extractor-model.parameter.tsdocparamblock + - title: PropertiesOf + url: /pages/api/api-extractor-model.propertiesof + - title: ReleaseTag + url: /pages/api/api-extractor-model.releasetag + - title: ReleaseTag + url: /pages/api/api-extractor-model.releasetag + subitems: + - title: compare + url: /pages/api/api-extractor-model.releasetag.compare + - title: getTagName + url: /pages/api/api-extractor-model.releasetag.gettagname + - title: TypeParameter + url: /pages/api/api-extractor-model.typeparameter + subitems: + - title: (constructor) + url: /pages/api/api-extractor-model.typeparameter._constructor_ + - title: constraintExcerpt + url: /pages/api/api-extractor-model.typeparameter.constraintexcerpt + - title: defaultTypeExcerpt + url: /pages/api/api-extractor-model.typeparameter.defaulttypeexcerpt + - title: name + url: /pages/api/api-extractor-model.typeparameter.name + - title: tsdocTypeParamBlock + url: /pages/api/api-extractor-model.typeparameter.tsdoctypeparamblock + - title: '@microsoft/node-core-library' + url: /pages/api/node-core-library + subitems: + - title: callback + url: /pages/api/node-core-library.callback + - title: Colors + url: /pages/api/node-core-library.colors + subitems: + - title: black + url: /pages/api/node-core-library.colors.black + - title: blackBackground + url: /pages/api/node-core-library.colors.blackbackground + - title: blink + url: /pages/api/node-core-library.colors.blink + - title: blue + url: /pages/api/node-core-library.colors.blue + - title: blueBackground + url: /pages/api/node-core-library.colors.bluebackground + - title: bold + url: /pages/api/node-core-library.colors.bold + - title: cyan + url: /pages/api/node-core-library.colors.cyan + - title: cyanBackground + url: /pages/api/node-core-library.colors.cyanbackground + - title: dim + url: /pages/api/node-core-library.colors.dim + - title: gray + url: /pages/api/node-core-library.colors.gray + - title: grayBackground + url: /pages/api/node-core-library.colors.graybackground + - title: green + url: /pages/api/node-core-library.colors.green + - title: greenBackground + url: /pages/api/node-core-library.colors.greenbackground + - title: hidden + url: /pages/api/node-core-library.colors.hidden + - title: invertColor + url: /pages/api/node-core-library.colors.invertcolor + - title: magenta + url: /pages/api/node-core-library.colors.magenta + - title: magentaBackground + url: /pages/api/node-core-library.colors.magentabackground + - title: red + url: /pages/api/node-core-library.colors.red + - title: redBackground + url: /pages/api/node-core-library.colors.redbackground + - title: underline + url: /pages/api/node-core-library.colors.underline + - title: white + url: /pages/api/node-core-library.colors.white + - title: whiteBackground + url: /pages/api/node-core-library.colors.whitebackground + - title: yellow + url: /pages/api/node-core-library.colors.yellow + - title: yellowBackground + url: /pages/api/node-core-library.colors.yellowbackground + - title: ColorValue + url: /pages/api/node-core-library.colorvalue + - title: ConsoleTerminalProvider + url: /pages/api/node-core-library.consoleterminalprovider + subitems: + - title: (constructor) + url: /pages/api/node-core-library.consoleterminalprovider._constructor_ + - title: eolCharacter + url: /pages/api/node-core-library.consoleterminalprovider.eolcharacter + - title: supportsColor + url: /pages/api/node-core-library.consoleterminalprovider.supportscolor + - title: verboseEnabled + url: /pages/api/node-core-library.consoleterminalprovider.verboseenabled + - title: write + url: /pages/api/node-core-library.consoleterminalprovider.write + - title: Encoding + url: /pages/api/node-core-library.encoding + - title: Executable + url: /pages/api/node-core-library.executable + subitems: + - title: spawnSync + url: /pages/api/node-core-library.executable.spawnsync + - title: tryResolve + url: /pages/api/node-core-library.executable.tryresolve + - title: ExecutableStdioMapping + url: /pages/api/node-core-library.executablestdiomapping + - title: ExecutableStdioStreamMapping + url: /pages/api/node-core-library.executablestdiostreammapping + - title: FileConstants + url: /pages/api/node-core-library.fileconstants + - title: FileSystem + url: /pages/api/node-core-library.filesystem + subitems: + - title: appendToFile + url: /pages/api/node-core-library.filesystem.appendtofile + - title: changePosixModeBits + url: /pages/api/node-core-library.filesystem.changeposixmodebits + - title: copyFile + url: /pages/api/node-core-library.filesystem.copyfile + - title: createHardLink + url: /pages/api/node-core-library.filesystem.createhardlink + - title: createSymbolicLinkFile + url: /pages/api/node-core-library.filesystem.createsymboliclinkfile + - title: createSymbolicLinkFolder + url: /pages/api/node-core-library.filesystem.createsymboliclinkfolder + - title: createSymbolicLinkJunction + url: /pages/api/node-core-library.filesystem.createsymboliclinkjunction + - title: deleteFile + url: /pages/api/node-core-library.filesystem.deletefile + - title: deleteFolder + url: /pages/api/node-core-library.filesystem.deletefolder + - title: ensureEmptyFolder + url: /pages/api/node-core-library.filesystem.ensureemptyfolder + - title: ensureFolder + url: /pages/api/node-core-library.filesystem.ensurefolder + - title: exists + url: /pages/api/node-core-library.filesystem.exists + - title: formatPosixModeBits + url: /pages/api/node-core-library.filesystem.formatposixmodebits + - title: getLinkStatistics + url: /pages/api/node-core-library.filesystem.getlinkstatistics + - title: getPosixModeBits + url: /pages/api/node-core-library.filesystem.getposixmodebits + - title: getRealPath + url: /pages/api/node-core-library.filesystem.getrealpath + - title: getStatistics + url: /pages/api/node-core-library.filesystem.getstatistics + - title: move + url: /pages/api/node-core-library.filesystem.move + - title: readFile + url: /pages/api/node-core-library.filesystem.readfile + - title: readFileToBuffer + url: /pages/api/node-core-library.filesystem.readfiletobuffer + - title: readFolder + url: /pages/api/node-core-library.filesystem.readfolder + - title: updateTimes + url: /pages/api/node-core-library.filesystem.updatetimes + - title: writeFile + url: /pages/api/node-core-library.filesystem.writefile + - title: FileWriter + url: /pages/api/node-core-library.filewriter + subitems: + - title: close + url: /pages/api/node-core-library.filewriter.close + - title: open + url: /pages/api/node-core-library.filewriter.open + - title: write + url: /pages/api/node-core-library.filewriter.write + - title: FolderConstants + url: /pages/api/node-core-library.folderconstants + - title: IColorableSequence + url: /pages/api/node-core-library.icolorablesequence + subitems: + - title: backgroundColor + url: /pages/api/node-core-library.icolorablesequence.backgroundcolor + - title: foregroundColor + url: /pages/api/node-core-library.icolorablesequence.foregroundcolor + - title: isEol + url: /pages/api/node-core-library.icolorablesequence.iseol + - title: text + url: /pages/api/node-core-library.icolorablesequence.text + - title: textAttributes + url: /pages/api/node-core-library.icolorablesequence.textattributes + - title: IConsoleTerminalProviderOptions + url: /pages/api/node-core-library.iconsoleterminalprovideroptions + subitems: + - title: verboseEnabled + url: /pages/api/node-core-library.iconsoleterminalprovideroptions.verboseenabled + - title: IExecutableResolveOptions + url: /pages/api/node-core-library.iexecutableresolveoptions + subitems: + - title: currentWorkingDirectory + url: /pages/api/node-core-library.iexecutableresolveoptions.currentworkingdirectory + - title: environment + url: /pages/api/node-core-library.iexecutableresolveoptions.environment + - title: IExecutableSpawnSyncOptions + url: /pages/api/node-core-library.iexecutablespawnsyncoptions + subitems: + - title: input + url: /pages/api/node-core-library.iexecutablespawnsyncoptions.input + - title: maxBuffer + url: /pages/api/node-core-library.iexecutablespawnsyncoptions.maxbuffer + - title: stdio + url: /pages/api/node-core-library.iexecutablespawnsyncoptions.stdio + - title: timeoutMs + url: /pages/api/node-core-library.iexecutablespawnsyncoptions.timeoutms + - title: IFileSystemCopyFileOptions + url: /pages/api/node-core-library.ifilesystemcopyfileoptions + subitems: + - title: destinationPath + url: /pages/api/node-core-library.ifilesystemcopyfileoptions.destinationpath + - title: sourcePath + url: /pages/api/node-core-library.ifilesystemcopyfileoptions.sourcepath + - title: IFileSystemCreateLinkOptions + url: /pages/api/node-core-library.ifilesystemcreatelinkoptions + subitems: + - title: linkTargetPath + url: /pages/api/node-core-library.ifilesystemcreatelinkoptions.linktargetpath + - title: newLinkPath + url: /pages/api/node-core-library.ifilesystemcreatelinkoptions.newlinkpath + - title: IFileSystemDeleteFileOptions + url: /pages/api/node-core-library.ifilesystemdeletefileoptions + subitems: + - title: throwIfNotExists + url: /pages/api/node-core-library.ifilesystemdeletefileoptions.throwifnotexists + - title: IFileSystemMoveOptions + url: /pages/api/node-core-library.ifilesystemmoveoptions + subitems: + - title: destinationPath + url: /pages/api/node-core-library.ifilesystemmoveoptions.destinationpath + - title: ensureFolderExists + url: /pages/api/node-core-library.ifilesystemmoveoptions.ensurefolderexists + - title: overwrite + url: /pages/api/node-core-library.ifilesystemmoveoptions.overwrite + - title: sourcePath + url: /pages/api/node-core-library.ifilesystemmoveoptions.sourcepath + - title: IFileSystemReadFileOptions + url: /pages/api/node-core-library.ifilesystemreadfileoptions + subitems: + - title: convertLineEndings + url: /pages/api/node-core-library.ifilesystemreadfileoptions.convertlineendings + - title: encoding + url: /pages/api/node-core-library.ifilesystemreadfileoptions.encoding + - title: IFileSystemReadFolderOptions + url: /pages/api/node-core-library.ifilesystemreadfolderoptions + subitems: + - title: absolutePaths + url: /pages/api/node-core-library.ifilesystemreadfolderoptions.absolutepaths + - title: IFileSystemUpdateTimeParameters + url: /pages/api/node-core-library.ifilesystemupdatetimeparameters + subitems: + - title: accessedTime + url: /pages/api/node-core-library.ifilesystemupdatetimeparameters.accessedtime + - title: modifiedTime + url: /pages/api/node-core-library.ifilesystemupdatetimeparameters.modifiedtime + - title: IFileSystemWriteFileOptions + url: /pages/api/node-core-library.ifilesystemwritefileoptions + subitems: + - title: convertLineEndings + url: /pages/api/node-core-library.ifilesystemwritefileoptions.convertlineendings + - title: encoding + url: /pages/api/node-core-library.ifilesystemwritefileoptions.encoding + - title: ensureFolderExists + url: /pages/api/node-core-library.ifilesystemwritefileoptions.ensurefolderexists + - title: IFileWriterFlags + url: /pages/api/node-core-library.ifilewriterflags + subitems: + - title: append + url: /pages/api/node-core-library.ifilewriterflags.append + - title: exclusive + url: /pages/api/node-core-library.ifilewriterflags.exclusive + - title: IJsonFileSaveOptions + url: /pages/api/node-core-library.ijsonfilesaveoptions + subitems: + - title: ensureFolderExists + url: /pages/api/node-core-library.ijsonfilesaveoptions.ensurefolderexists + - title: onlyIfChanged + url: /pages/api/node-core-library.ijsonfilesaveoptions.onlyifchanged + - title: updateExistingFile + url: /pages/api/node-core-library.ijsonfilesaveoptions.updateexistingfile + - title: IJsonFileStringifyOptions + url: /pages/api/node-core-library.ijsonfilestringifyoptions + subitems: + - title: newlineConversion + url: /pages/api/node-core-library.ijsonfilestringifyoptions.newlineconversion + - title: prettyFormatting + url: /pages/api/node-core-library.ijsonfilestringifyoptions.prettyformatting + - title: IJsonSchemaErrorInfo + url: /pages/api/node-core-library.ijsonschemaerrorinfo + subitems: + - title: details + url: /pages/api/node-core-library.ijsonschemaerrorinfo.details + - title: IJsonSchemaFromFileOptions + url: /pages/api/node-core-library.ijsonschemafromfileoptions + subitems: + - title: dependentSchemas + url: /pages/api/node-core-library.ijsonschemafromfileoptions.dependentschemas + - title: IJsonSchemaValidateOptions + url: /pages/api/node-core-library.ijsonschemavalidateoptions + subitems: + - title: customErrorHeader + url: /pages/api/node-core-library.ijsonschemavalidateoptions.customerrorheader + - title: INodePackageJson + url: /pages/api/node-core-library.inodepackagejson + subitems: + - title: bin + url: /pages/api/node-core-library.inodepackagejson.bin + - title: dependencies + url: /pages/api/node-core-library.inodepackagejson.dependencies + - title: description + url: /pages/api/node-core-library.inodepackagejson.description + - title: devDependencies + url: /pages/api/node-core-library.inodepackagejson.devdependencies + - title: homepage + url: /pages/api/node-core-library.inodepackagejson.homepage + - title: license + url: /pages/api/node-core-library.inodepackagejson.license + - title: main + url: /pages/api/node-core-library.inodepackagejson.main + - title: name + url: /pages/api/node-core-library.inodepackagejson.name + - title: optionalDependencies + url: /pages/api/node-core-library.inodepackagejson.optionaldependencies + - title: peerDependencies + url: /pages/api/node-core-library.inodepackagejson.peerdependencies + - title: private + url: /pages/api/node-core-library.inodepackagejson.private + - title: repository + url: /pages/api/node-core-library.inodepackagejson.repository + - title: scripts + url: /pages/api/node-core-library.inodepackagejson.scripts + - title: tsdocMetadata + url: /pages/api/node-core-library.inodepackagejson.tsdocmetadata + - title: types + url: /pages/api/node-core-library.inodepackagejson.types + - title: typings + url: /pages/api/node-core-library.inodepackagejson.typings + - title: version + url: /pages/api/node-core-library.inodepackagejson.version + - title: InternalError + url: /pages/api/node-core-library.internalerror + subitems: + - title: (constructor) + url: /pages/api/node-core-library.internalerror._constructor_ + - title: breakInDebugger + url: /pages/api/node-core-library.internalerror.breakindebugger + - title: toString + url: /pages/api/node-core-library.internalerror.tostring + - title: unformattedMessage + url: /pages/api/node-core-library.internalerror.unformattedmessage + - title: IPackageJson + url: /pages/api/node-core-library.ipackagejson + subitems: + - title: version + url: /pages/api/node-core-library.ipackagejson.version + - title: IPackageJsonDependencyTable + url: /pages/api/node-core-library.ipackagejsondependencytable + - title: IPackageJsonLookupParameters + url: /pages/api/node-core-library.ipackagejsonlookupparameters + subitems: + - title: loadExtraFields + url: /pages/api/node-core-library.ipackagejsonlookupparameters.loadextrafields + - title: IPackageJsonScriptTable + url: /pages/api/node-core-library.ipackagejsonscripttable + - title: IParsedPackageName + url: /pages/api/node-core-library.iparsedpackagename + subitems: + - title: scope + url: /pages/api/node-core-library.iparsedpackagename.scope + - title: unscopedName + url: /pages/api/node-core-library.iparsedpackagename.unscopedname + - title: IParsedPackageNameOrError + url: /pages/api/node-core-library.iparsedpackagenameorerror + subitems: + - title: error + url: /pages/api/node-core-library.iparsedpackagenameorerror.error + - title: IProtectableMapParameters + url: /pages/api/node-core-library.iprotectablemapparameters + subitems: + - title: onClear + url: /pages/api/node-core-library.iprotectablemapparameters.onclear + - title: onDelete + url: /pages/api/node-core-library.iprotectablemapparameters.ondelete + - title: onSet + url: /pages/api/node-core-library.iprotectablemapparameters.onset + - title: IStringBuilder + url: /pages/api/node-core-library.istringbuilder + subitems: + - title: append + url: /pages/api/node-core-library.istringbuilder.append + - title: toString + url: /pages/api/node-core-library.istringbuilder.tostring + - title: ITerminalProvider + url: /pages/api/node-core-library.iterminalprovider + subitems: + - title: eolCharacter + url: /pages/api/node-core-library.iterminalprovider.eolcharacter + - title: supportsColor + url: /pages/api/node-core-library.iterminalprovider.supportscolor + - title: write + url: /pages/api/node-core-library.iterminalprovider.write + - title: JsonFile + url: /pages/api/node-core-library.jsonfile + subitems: + - title: load + url: /pages/api/node-core-library.jsonfile.load + - title: loadAndValidate + url: /pages/api/node-core-library.jsonfile.loadandvalidate + - title: loadAndValidateWithCallback + url: /pages/api/node-core-library.jsonfile.loadandvalidatewithcallback + - title: save + url: /pages/api/node-core-library.jsonfile.save + - title: stringify + url: /pages/api/node-core-library.jsonfile.stringify + - title: updateString + url: /pages/api/node-core-library.jsonfile.updatestring + - title: validateNoUndefinedMembers + url: /pages/api/node-core-library.jsonfile.validatenoundefinedmembers + - title: JsonSchema + url: /pages/api/node-core-library.jsonschema + subitems: + - title: ensureCompiled + url: /pages/api/node-core-library.jsonschema.ensurecompiled + - title: fromFile + url: /pages/api/node-core-library.jsonschema.fromfile + - title: fromLoadedObject + url: /pages/api/node-core-library.jsonschema.fromloadedobject + - title: shortName + url: /pages/api/node-core-library.jsonschema.shortname + - title: validateObject + url: /pages/api/node-core-library.jsonschema.validateobject + - title: validateObjectWithCallback + url: /pages/api/node-core-library.jsonschema.validateobjectwithcallback + - title: LegacyAdapters + url: /pages/api/node-core-library.legacyadapters + subitems: + - title: convertCallbackToPromise + url: /pages/api/node-core-library.legacyadapters.convertcallbacktopromise + - title: convertCallbackToPromise + url: /pages/api/node-core-library.legacyadapters.convertcallbacktopromise_1 + - title: convertCallbackToPromise + url: /pages/api/node-core-library.legacyadapters.convertcallbacktopromise_2 + - title: scrubError + url: /pages/api/node-core-library.legacyadapters.scruberror + - title: LockFile + url: /pages/api/node-core-library.lockfile + subitems: + - title: acquire + url: /pages/api/node-core-library.lockfile.acquire + - title: dirtyWhenAcquired + url: /pages/api/node-core-library.lockfile.dirtywhenacquired + - title: filePath + url: /pages/api/node-core-library.lockfile.filepath + - title: getLockFilePath + url: /pages/api/node-core-library.lockfile.getlockfilepath + - title: isReleased + url: /pages/api/node-core-library.lockfile.isreleased + - title: release + url: /pages/api/node-core-library.lockfile.release + - title: tryAcquire + url: /pages/api/node-core-library.lockfile.tryacquire + - title: MapExtensions + url: /pages/api/node-core-library.mapextensions + subitems: + - title: mergeFromMap + url: /pages/api/node-core-library.mapextensions.mergefrommap + - title: NewlineKind + url: /pages/api/node-core-library.newlinekind + - title: PackageJsonLookup + url: /pages/api/node-core-library.packagejsonlookup + subitems: + - title: (constructor) + url: /pages/api/node-core-library.packagejsonlookup._constructor_ + - title: clearCache + url: /pages/api/node-core-library.packagejsonlookup.clearcache + - title: loadNodePackageJson + url: /pages/api/node-core-library.packagejsonlookup.loadnodepackagejson + - title: loadOwnPackageJson + url: /pages/api/node-core-library.packagejsonlookup.loadownpackagejson + - title: loadPackageJson + url: /pages/api/node-core-library.packagejsonlookup.loadpackagejson + - title: tryGetPackageFolderFor + url: /pages/api/node-core-library.packagejsonlookup.trygetpackagefolderfor + - title: tryGetPackageJsonFilePathFor + url: /pages/api/node-core-library.packagejsonlookup.trygetpackagejsonfilepathfor + - title: tryLoadNodePackageJsonFor + url: /pages/api/node-core-library.packagejsonlookup.tryloadnodepackagejsonfor + - title: tryLoadPackageJsonFor + url: /pages/api/node-core-library.packagejsonlookup.tryloadpackagejsonfor + - title: PackageName + url: /pages/api/node-core-library.packagename + subitems: + - title: combineParts + url: /pages/api/node-core-library.packagename.combineparts + - title: getScope + url: /pages/api/node-core-library.packagename.getscope + - title: getUnscopedName + url: /pages/api/node-core-library.packagename.getunscopedname + - title: isValidName + url: /pages/api/node-core-library.packagename.isvalidname + - title: parse + url: /pages/api/node-core-library.packagename.parse + - title: tryParse + url: /pages/api/node-core-library.packagename.tryparse + - title: validate + url: /pages/api/node-core-library.packagename.validate + - title: Path + url: /pages/api/node-core-library.path + subitems: + - title: isUnder + url: /pages/api/node-core-library.path.isunder + - title: isUnderOrEqual + url: /pages/api/node-core-library.path.isunderorequal + - title: PosixModeBits + url: /pages/api/node-core-library.posixmodebits + - title: ProtectableMap + url: /pages/api/node-core-library.protectablemap + subitems: + - title: (constructor) + url: /pages/api/node-core-library.protectablemap._constructor_ + - title: clear + url: /pages/api/node-core-library.protectablemap.clear + - title: delete + url: /pages/api/node-core-library.protectablemap.delete + - title: forEach + url: /pages/api/node-core-library.protectablemap.foreach + - title: get + url: /pages/api/node-core-library.protectablemap.get + - title: has + url: /pages/api/node-core-library.protectablemap.has + - title: protectedView + url: /pages/api/node-core-library.protectablemap.protectedview + - title: set + url: /pages/api/node-core-library.protectablemap.set + - title: size + url: /pages/api/node-core-library.protectablemap.size + - title: Sort + url: /pages/api/node-core-library.sort + subitems: + - title: compareByValue + url: /pages/api/node-core-library.sort.comparebyvalue + - title: isSorted + url: /pages/api/node-core-library.sort.issorted + - title: isSortedBy + url: /pages/api/node-core-library.sort.issortedby + - title: sortBy + url: /pages/api/node-core-library.sort.sortby + - title: sortMapKeys + url: /pages/api/node-core-library.sort.sortmapkeys + - title: sortSet + url: /pages/api/node-core-library.sort.sortset + - title: sortSetBy + url: /pages/api/node-core-library.sort.sortsetby + - title: StringBufferTerminalProvider + url: /pages/api/node-core-library.stringbufferterminalprovider + subitems: + - title: (constructor) + url: /pages/api/node-core-library.stringbufferterminalprovider._constructor_ + - title: eolCharacter + url: /pages/api/node-core-library.stringbufferterminalprovider.eolcharacter + - title: getErrorOutput + url: /pages/api/node-core-library.stringbufferterminalprovider.geterroroutput + - title: getOutput + url: /pages/api/node-core-library.stringbufferterminalprovider.getoutput + - title: getVerbose + url: /pages/api/node-core-library.stringbufferterminalprovider.getverbose + - title: getWarningOutput + url: /pages/api/node-core-library.stringbufferterminalprovider.getwarningoutput + - title: supportsColor + url: /pages/api/node-core-library.stringbufferterminalprovider.supportscolor + - title: write + url: /pages/api/node-core-library.stringbufferterminalprovider.write + - title: StringBuilder + url: /pages/api/node-core-library.stringbuilder + subitems: + - title: (constructor) + url: /pages/api/node-core-library.stringbuilder._constructor_ + - title: append + url: /pages/api/node-core-library.stringbuilder.append + - title: toString + url: /pages/api/node-core-library.stringbuilder.tostring + - title: Terminal + url: /pages/api/node-core-library.terminal + subitems: + - title: (constructor) + url: /pages/api/node-core-library.terminal._constructor_ + - title: registerProvider + url: /pages/api/node-core-library.terminal.registerprovider + - title: unregisterProvider + url: /pages/api/node-core-library.terminal.unregisterprovider + - title: write + url: /pages/api/node-core-library.terminal.write + - title: writeError + url: /pages/api/node-core-library.terminal.writeerror + - title: writeErrorLine + url: /pages/api/node-core-library.terminal.writeerrorline + - title: writeLine + url: /pages/api/node-core-library.terminal.writeline + - title: writeVerbose + url: /pages/api/node-core-library.terminal.writeverbose + - title: writeVerboseLine + url: /pages/api/node-core-library.terminal.writeverboseline + - title: writeWarning + url: /pages/api/node-core-library.terminal.writewarning + - title: writeWarningLine + url: /pages/api/node-core-library.terminal.writewarningline + - title: TerminalProviderSeverity + url: /pages/api/node-core-library.terminalproviderseverity + - title: Text + url: /pages/api/node-core-library.text + subitems: + - title: convertToCrLf + url: /pages/api/node-core-library.text.converttocrlf + - title: convertToLf + url: /pages/api/node-core-library.text.converttolf + - title: ensureTrailingNewline + url: /pages/api/node-core-library.text.ensuretrailingnewline + - title: padEnd + url: /pages/api/node-core-library.text.padend + - title: padStart + url: /pages/api/node-core-library.text.padstart + - title: replaceAll + url: /pages/api/node-core-library.text.replaceall + - title: truncateWithEllipsis + url: /pages/api/node-core-library.text.truncatewithellipsis + - title: TextAttribute + url: /pages/api/node-core-library.textattribute + - title: '@microsoft/package-deps-hash' + url: /pages/api/package-deps-hash + subitems: + - title: getPackageDeps + url: /pages/api/package-deps-hash.getpackagedeps + - title: IPackageDeps + url: /pages/api/package-deps-hash.ipackagedeps + subitems: + - title: files + url: /pages/api/package-deps-hash.ipackagedeps.files + - title: '@microsoft/rush-lib' + url: /pages/api/rush-lib + subitems: + - title: ApprovedPackagesConfiguration + url: /pages/api/rush-lib.approvedpackagesconfiguration + subitems: + - title: (constructor) + url: /pages/api/rush-lib.approvedpackagesconfiguration._constructor_ + - title: addOrUpdatePackage + url: /pages/api/rush-lib.approvedpackagesconfiguration.addorupdatepackage + - title: clear + url: /pages/api/rush-lib.approvedpackagesconfiguration.clear + - title: getItemByName + url: /pages/api/rush-lib.approvedpackagesconfiguration.getitembyname + - title: items + url: /pages/api/rush-lib.approvedpackagesconfiguration.items + - title: loadFromFile + url: /pages/api/rush-lib.approvedpackagesconfiguration.loadfromfile + - title: saveToFile + url: /pages/api/rush-lib.approvedpackagesconfiguration.savetofile + - title: tryLoadFromFile + url: /pages/api/rush-lib.approvedpackagesconfiguration.tryloadfromfile + - title: ApprovedPackagesItem + url: /pages/api/rush-lib.approvedpackagesitem + subitems: + - title: allowedCategories + url: /pages/api/rush-lib.approvedpackagesitem.allowedcategories + - title: packageName + url: /pages/api/rush-lib.approvedpackagesitem.packagename + - title: ApprovedPackagesPolicy + url: /pages/api/rush-lib.approvedpackagespolicy + subitems: + - title: browserApprovedPackages + url: /pages/api/rush-lib.approvedpackagespolicy.browserapprovedpackages + - title: enabled + url: /pages/api/rush-lib.approvedpackagespolicy.enabled + - title: ignoredNpmScopes + url: /pages/api/rush-lib.approvedpackagespolicy.ignorednpmscopes + - title: nonbrowserApprovedPackages + url: /pages/api/rush-lib.approvedpackagespolicy.nonbrowserapprovedpackages + - title: reviewCategories + url: /pages/api/rush-lib.approvedpackagespolicy.reviewcategories + - title: BumpType + url: /pages/api/rush-lib.bumptype + - title: ChangeManager + url: /pages/api/rush-lib.changemanager + subitems: + - title: createEmptyChangeFiles + url: /pages/api/rush-lib.changemanager.createemptychangefiles + - title: CommonVersionsConfiguration + url: /pages/api/rush-lib.commonversionsconfiguration + subitems: + - title: allowedAlternativeVersions + url: /pages/api/rush-lib.commonversionsconfiguration.allowedalternativeversions + - title: filePath + url: /pages/api/rush-lib.commonversionsconfiguration.filepath + - title: getAllPreferredVersions + url: /pages/api/rush-lib.commonversionsconfiguration.getallpreferredversions + - title: loadFromFile + url: /pages/api/rush-lib.commonversionsconfiguration.loadfromfile + - title: preferredVersions + url: /pages/api/rush-lib.commonversionsconfiguration.preferredversions + - title: save + url: /pages/api/rush-lib.commonversionsconfiguration.save + - title: xstitchPreferredVersions + url: /pages/api/rush-lib.commonversionsconfiguration.xstitchpreferredversions + - title: DependencyType + url: /pages/api/rush-lib.dependencytype + - title: EnvironmentVariableNames + url: /pages/api/rush-lib.environmentvariablenames + - title: Event + url: /pages/api/rush-lib.event + - title: EventHooks + url: /pages/api/rush-lib.eventhooks + subitems: + - title: get + url: /pages/api/rush-lib.eventhooks.get + - title: ILaunchOptions + url: /pages/api/rush-lib.ilaunchoptions + subitems: + - title: alreadyReportedNodeTooNewError + url: /pages/api/rush-lib.ilaunchoptions.alreadyreportednodetoonewerror + - title: isManaged + url: /pages/api/rush-lib.ilaunchoptions.ismanaged + - title: IndividualVersionPolicy + url: /pages/api/rush-lib.individualversionpolicy + subitems: + - title: bump + url: /pages/api/rush-lib.individualversionpolicy.bump + - title: ensure + url: /pages/api/rush-lib.individualversionpolicy.ensure + - title: lockedMajor + url: /pages/api/rush-lib.individualversionpolicy.lockedmajor + - title: validate + url: /pages/api/rush-lib.individualversionpolicy.validate + - title: ITryFindRushJsonLocationOptions + url: /pages/api/rush-lib.itryfindrushjsonlocationoptions + subitems: + - title: showVerbose + url: /pages/api/rush-lib.itryfindrushjsonlocationoptions.showverbose + - title: startingFolder + url: /pages/api/rush-lib.itryfindrushjsonlocationoptions.startingfolder + - title: LockStepVersionPolicy + url: /pages/api/rush-lib.lockstepversionpolicy + subitems: + - title: bump + url: /pages/api/rush-lib.lockstepversionpolicy.bump + - title: ensure + url: /pages/api/rush-lib.lockstepversionpolicy.ensure + - title: mainProject + url: /pages/api/rush-lib.lockstepversionpolicy.mainproject + - title: nextBump + url: /pages/api/rush-lib.lockstepversionpolicy.nextbump + - title: update + url: /pages/api/rush-lib.lockstepversionpolicy.update + - title: validate + url: /pages/api/rush-lib.lockstepversionpolicy.validate + - title: version + url: /pages/api/rush-lib.lockstepversionpolicy.version + - title: PackageJsonDependency + url: /pages/api/rush-lib.packagejsondependency + subitems: + - title: (constructor) + url: /pages/api/rush-lib.packagejsondependency._constructor_ + - title: dependencyType + url: /pages/api/rush-lib.packagejsondependency.dependencytype + - title: name + url: /pages/api/rush-lib.packagejsondependency.name + - title: setVersion + url: /pages/api/rush-lib.packagejsondependency.setversion + - title: version + url: /pages/api/rush-lib.packagejsondependency.version + - title: PackageJsonEditor + url: /pages/api/rush-lib.packagejsoneditor + subitems: + - title: addOrUpdateDependency + url: /pages/api/rush-lib.packagejsoneditor.addorupdatedependency + - title: dependencyList + url: /pages/api/rush-lib.packagejsoneditor.dependencylist + - title: devDependencyList + url: /pages/api/rush-lib.packagejsoneditor.devdependencylist + - title: filePath + url: /pages/api/rush-lib.packagejsoneditor.filepath + - title: fromObject + url: /pages/api/rush-lib.packagejsoneditor.fromobject + - title: load + url: /pages/api/rush-lib.packagejsoneditor.load + - title: name + url: /pages/api/rush-lib.packagejsoneditor.name + - title: saveIfModified + url: /pages/api/rush-lib.packagejsoneditor.saveifmodified + - title: tryGetDependency + url: /pages/api/rush-lib.packagejsoneditor.trygetdependency + - title: tryGetDevDependency + url: /pages/api/rush-lib.packagejsoneditor.trygetdevdependency + - title: version + url: /pages/api/rush-lib.packagejsoneditor.version + - title: PackageManager + url: /pages/api/rush-lib.packagemanager + subitems: + - title: _shrinkwrapFilename + url: /pages/api/rush-lib.packagemanager._shrinkwrapfilename + - title: packageManager + url: /pages/api/rush-lib.packagemanager.packagemanager + - title: shrinkwrapFilename + url: /pages/api/rush-lib.packagemanager.shrinkwrapfilename + - title: version + url: /pages/api/rush-lib.packagemanager.version + - title: PackageManagerName + url: /pages/api/rush-lib.packagemanagername + - title: PnpmOptionsConfiguration + url: /pages/api/rush-lib.pnpmoptionsconfiguration + subitems: + - title: resolutionStrategy + url: /pages/api/rush-lib.pnpmoptionsconfiguration.resolutionstrategy + - title: strictPeerDependencies + url: /pages/api/rush-lib.pnpmoptionsconfiguration.strictpeerdependencies + - title: ResolutionStrategy + url: /pages/api/rush-lib.resolutionstrategy + - title: Rush + url: /pages/api/rush-lib.rush + subitems: + - title: launch + url: /pages/api/rush-lib.rush.launch + - title: launchRushX + url: /pages/api/rush-lib.rush.launchrushx + - title: version + url: /pages/api/rush-lib.rush.version + - title: RushConfiguration + url: /pages/api/rush-lib.rushconfiguration + subitems: + - title: approvedPackagesPolicy + url: /pages/api/rush-lib.rushconfiguration.approvedpackagespolicy + - title: changesFolder + url: /pages/api/rush-lib.rushconfiguration.changesfolder + - title: committedShrinkwrapFilename + url: /pages/api/rush-lib.rushconfiguration.committedshrinkwrapfilename + - title: commonFolder + url: /pages/api/rush-lib.rushconfiguration.commonfolder + - title: commonRushConfigFolder + url: /pages/api/rush-lib.rushconfiguration.commonrushconfigfolder + - title: commonScriptsFolder + url: /pages/api/rush-lib.rushconfiguration.commonscriptsfolder + - title: commonTempFolder + url: /pages/api/rush-lib.rushconfiguration.commontempfolder + - title: commonVersions + url: /pages/api/rush-lib.rushconfiguration.commonversions + - title: currentInstalledVariant + url: /pages/api/rush-lib.rushconfiguration.currentinstalledvariant + - title: currentVariantJsonFilename + url: /pages/api/rush-lib.rushconfiguration.currentvariantjsonfilename + - title: ensureConsistentVersions + url: /pages/api/rush-lib.rushconfiguration.ensureconsistentversions + - title: eventHooks + url: /pages/api/rush-lib.rushconfiguration.eventhooks + - title: findProjectByShorthandName + url: /pages/api/rush-lib.rushconfiguration.findprojectbyshorthandname + - title: findProjectByTempName + url: /pages/api/rush-lib.rushconfiguration.findprojectbytempname + - 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: getPnpmfilePath + url: /pages/api/rush-lib.rushconfiguration.getpnpmfilepath + - title: getProjectByName + url: /pages/api/rush-lib.rushconfiguration.getprojectbyname + - title: gitAllowedEmailRegExps + url: /pages/api/rush-lib.rushconfiguration.gitallowedemailregexps + - title: gitSampleEmail + url: /pages/api/rush-lib.rushconfiguration.gitsampleemail + - title: gitVersionBumpCommitMessage + url: /pages/api/rush-lib.rushconfiguration.gitversionbumpcommitmessage + - title: hotfixChangeEnabled + url: /pages/api/rush-lib.rushconfiguration.hotfixchangeenabled + - title: loadFromConfigurationFile + url: /pages/api/rush-lib.rushconfiguration.loadfromconfigurationfile + - title: loadFromDefaultLocation + url: /pages/api/rush-lib.rushconfiguration.loadfromdefaultlocation + - title: npmCacheFolder + url: /pages/api/rush-lib.rushconfiguration.npmcachefolder + - title: npmTmpFolder + url: /pages/api/rush-lib.rushconfiguration.npmtmpfolder + - title: packageManager + url: /pages/api/rush-lib.rushconfiguration.packagemanager + - title: packageManagerToolFilename + url: /pages/api/rush-lib.rushconfiguration.packagemanagertoolfilename + - title: packageManagerToolVersion + url: /pages/api/rush-lib.rushconfiguration.packagemanagertoolversion + - title: packageManagerWrapper + url: /pages/api/rush-lib.rushconfiguration.packagemanagerwrapper + - title: pnpmOptions + url: /pages/api/rush-lib.rushconfiguration.pnpmoptions + - title: pnpmStoreFolder + url: /pages/api/rush-lib.rushconfiguration.pnpmstorefolder + - title: projectFolderMaxDepth + url: /pages/api/rush-lib.rushconfiguration.projectfoldermaxdepth + - title: projectFolderMinDepth + url: /pages/api/rush-lib.rushconfiguration.projectfoldermindepth + - title: projects + url: /pages/api/rush-lib.rushconfiguration.projects + - title: projectsByName + url: /pages/api/rush-lib.rushconfiguration.projectsbyname + - title: repositoryUrl + url: /pages/api/rush-lib.rushconfiguration.repositoryurl + - title: rushJsonFile + url: /pages/api/rush-lib.rushconfiguration.rushjsonfile + - title: rushJsonFolder + url: /pages/api/rush-lib.rushconfiguration.rushjsonfolder + - title: rushLinkJsonFilename + url: /pages/api/rush-lib.rushconfiguration.rushlinkjsonfilename + - title: shrinkwrapFilename + url: /pages/api/rush-lib.rushconfiguration.shrinkwrapfilename + - title: shrinkwrapFilePhrase + url: /pages/api/rush-lib.rushconfiguration.shrinkwrapfilephrase + - title: suppressNodeLtsWarning + url: /pages/api/rush-lib.rushconfiguration.suppressnodeltswarning + - title: telemetryEnabled + url: /pages/api/rush-lib.rushconfiguration.telemetryenabled + - title: tempShrinkwrapFilename + url: /pages/api/rush-lib.rushconfiguration.tempshrinkwrapfilename + - title: tempShrinkwrapPreinstallFilename + url: /pages/api/rush-lib.rushconfiguration.tempshrinkwrappreinstallfilename + - title: tryFindRushJsonLocation + url: /pages/api/rush-lib.rushconfiguration.tryfindrushjsonlocation + - title: tryGetProjectForPath + url: /pages/api/rush-lib.rushconfiguration.trygetprojectforpath + - title: versionPolicyConfiguration + url: /pages/api/rush-lib.rushconfiguration.versionpolicyconfiguration + - title: yarnCacheFolder + url: /pages/api/rush-lib.rushconfiguration.yarncachefolder + - title: yarnOptions + url: /pages/api/rush-lib.rushconfiguration.yarnoptions + - title: RushConfigurationProject + url: /pages/api/rush-lib.rushconfigurationproject + subitems: + - title: cyclicDependencyProjects + url: /pages/api/rush-lib.rushconfigurationproject.cyclicdependencyprojects + - title: downstreamDependencyProjects + url: /pages/api/rush-lib.rushconfigurationproject.downstreamdependencyprojects + - title: isMainProject + url: /pages/api/rush-lib.rushconfigurationproject.ismainproject + - title: packageJson + url: /pages/api/rush-lib.rushconfigurationproject.packagejson + - title: packageJsonEditor + url: /pages/api/rush-lib.rushconfigurationproject.packagejsoneditor + - title: packageName + url: /pages/api/rush-lib.rushconfigurationproject.packagename + - title: projectFolder + url: /pages/api/rush-lib.rushconfigurationproject.projectfolder + - title: projectRelativeFolder + url: /pages/api/rush-lib.rushconfigurationproject.projectrelativefolder + - title: reviewCategory + url: /pages/api/rush-lib.rushconfigurationproject.reviewcategory + - title: shouldPublish + url: /pages/api/rush-lib.rushconfigurationproject.shouldpublish + - title: skipRushCheck + url: /pages/api/rush-lib.rushconfigurationproject.skiprushcheck + - title: tempProjectName + url: /pages/api/rush-lib.rushconfigurationproject.tempprojectname + - title: unscopedTempProjectName + url: /pages/api/rush-lib.rushconfigurationproject.unscopedtempprojectname + - title: versionPolicy + url: /pages/api/rush-lib.rushconfigurationproject.versionpolicy + - title: versionPolicyName + url: /pages/api/rush-lib.rushconfigurationproject.versionpolicyname + - title: VersionPolicy + url: /pages/api/rush-lib.versionpolicy + subitems: + - title: bump + url: /pages/api/rush-lib.versionpolicy.bump + - title: definitionName + url: /pages/api/rush-lib.versionpolicy.definitionname + - title: ensure + url: /pages/api/rush-lib.versionpolicy.ensure + - title: exemptFromRushChange + url: /pages/api/rush-lib.versionpolicy.exemptfromrushchange + - title: isLockstepped + url: /pages/api/rush-lib.versionpolicy.islockstepped + - title: policyName + url: /pages/api/rush-lib.versionpolicy.policyname + - title: setDependenciesBeforeCommit + url: /pages/api/rush-lib.versionpolicy.setdependenciesbeforecommit + - title: setDependenciesBeforePublish + url: /pages/api/rush-lib.versionpolicy.setdependenciesbeforepublish + - title: validate + url: /pages/api/rush-lib.versionpolicy.validate + - title: VersionPolicyConfiguration + url: /pages/api/rush-lib.versionpolicyconfiguration + subitems: + - title: bump + url: /pages/api/rush-lib.versionpolicyconfiguration.bump + - title: getVersionPolicy + url: /pages/api/rush-lib.versionpolicyconfiguration.getversionpolicy + - title: update + url: /pages/api/rush-lib.versionpolicyconfiguration.update + - title: validate + url: /pages/api/rush-lib.versionpolicyconfiguration.validate + - title: versionPolicies + url: /pages/api/rush-lib.versionpolicyconfiguration.versionpolicies + - title: VersionPolicyDefinitionName + url: /pages/api/rush-lib.versionpolicydefinitionname + - title: YarnOptionsConfiguration + url: /pages/api/rush-lib.yarnoptionsconfiguration + subitems: + - title: ignoreEngines + url: /pages/api/rush-lib.yarnoptionsconfiguration.ignoreengines + - title: '@microsoft/stream-collator' + url: /pages/api/stream-collator + subitems: + - title: Interleaver + url: /pages/api/stream-collator.interleaver + subitems: + - title: registerTask + url: /pages/api/stream-collator.interleaver.registertask + - title: reset + url: /pages/api/stream-collator.interleaver.reset + - title: setStdOut + url: /pages/api/stream-collator.interleaver.setstdout + - title: ITaskWriter + url: /pages/api/stream-collator.itaskwriter + subitems: + - title: close + url: /pages/api/stream-collator.itaskwriter.close + - title: getStdError + url: /pages/api/stream-collator.itaskwriter.getstderror + - title: getStdOutput + url: /pages/api/stream-collator.itaskwriter.getstdoutput + - title: write + url: /pages/api/stream-collator.itaskwriter.write + - title: writeError + url: /pages/api/stream-collator.itaskwriter.writeerror + - title: writeLine + url: /pages/api/stream-collator.itaskwriter.writeline + - title: '@microsoft/ts-command-line' + url: /pages/api/ts-command-line + subitems: + - title: CommandLineAction + url: /pages/api/ts-command-line.commandlineaction + subitems: + - title: (constructor) + url: /pages/api/ts-command-line.commandlineaction._constructor_ + - title: actionName + url: /pages/api/ts-command-line.commandlineaction.actionname + - title: documentation + url: /pages/api/ts-command-line.commandlineaction.documentation + - title: onDefineParameters + url: /pages/api/ts-command-line.commandlineaction.ondefineparameters + - title: onExecute + url: /pages/api/ts-command-line.commandlineaction.onexecute + - title: summary + url: /pages/api/ts-command-line.commandlineaction.summary + - title: CommandLineChoiceParameter + url: /pages/api/ts-command-line.commandlinechoiceparameter + subitems: + - title: alternatives + url: /pages/api/ts-command-line.commandlinechoiceparameter.alternatives + - title: appendToArgList + url: /pages/api/ts-command-line.commandlinechoiceparameter.appendtoarglist + - title: defaultValue + url: /pages/api/ts-command-line.commandlinechoiceparameter.defaultvalue + - title: kind + url: /pages/api/ts-command-line.commandlinechoiceparameter.kind + - title: value + url: /pages/api/ts-command-line.commandlinechoiceparameter.value + - title: CommandLineFlagParameter + url: /pages/api/ts-command-line.commandlineflagparameter + subitems: + - title: appendToArgList + url: /pages/api/ts-command-line.commandlineflagparameter.appendtoarglist + - title: kind + url: /pages/api/ts-command-line.commandlineflagparameter.kind + - title: value + url: /pages/api/ts-command-line.commandlineflagparameter.value + - title: CommandLineIntegerParameter + url: /pages/api/ts-command-line.commandlineintegerparameter + subitems: + - title: appendToArgList + url: /pages/api/ts-command-line.commandlineintegerparameter.appendtoarglist + - title: defaultValue + url: /pages/api/ts-command-line.commandlineintegerparameter.defaultvalue + - title: kind + url: /pages/api/ts-command-line.commandlineintegerparameter.kind + - title: value + url: /pages/api/ts-command-line.commandlineintegerparameter.value + - title: CommandLineParameter + url: /pages/api/ts-command-line.commandlineparameter + subitems: + - title: appendToArgList + url: /pages/api/ts-command-line.commandlineparameter.appendtoarglist + - title: description + url: /pages/api/ts-command-line.commandlineparameter.description + - title: environmentVariable + url: /pages/api/ts-command-line.commandlineparameter.environmentvariable + - title: kind + url: /pages/api/ts-command-line.commandlineparameter.kind + - title: longName + url: /pages/api/ts-command-line.commandlineparameter.longname + - title: reportInvalidData + url: /pages/api/ts-command-line.commandlineparameter.reportinvaliddata + - title: required + url: /pages/api/ts-command-line.commandlineparameter.required + - title: shortName + url: /pages/api/ts-command-line.commandlineparameter.shortname + - title: validateDefaultValue + url: /pages/api/ts-command-line.commandlineparameter.validatedefaultvalue + - title: CommandLineParameterKind + url: /pages/api/ts-command-line.commandlineparameterkind + - title: CommandLineParameterProvider + url: /pages/api/ts-command-line.commandlineparameterprovider + subitems: + - title: defineChoiceParameter + url: /pages/api/ts-command-line.commandlineparameterprovider.definechoiceparameter + - title: defineFlagParameter + url: /pages/api/ts-command-line.commandlineparameterprovider.defineflagparameter + - title: defineIntegerParameter + url: /pages/api/ts-command-line.commandlineparameterprovider.defineintegerparameter + - title: defineStringListParameter + url: /pages/api/ts-command-line.commandlineparameterprovider.definestringlistparameter + - title: defineStringParameter + url: /pages/api/ts-command-line.commandlineparameterprovider.definestringparameter + - title: getChoiceParameter + url: /pages/api/ts-command-line.commandlineparameterprovider.getchoiceparameter + - title: getFlagParameter + url: /pages/api/ts-command-line.commandlineparameterprovider.getflagparameter + - title: getIntegerParameter + url: /pages/api/ts-command-line.commandlineparameterprovider.getintegerparameter + - title: getStringListParameter + url: /pages/api/ts-command-line.commandlineparameterprovider.getstringlistparameter + - title: getStringParameter + url: /pages/api/ts-command-line.commandlineparameterprovider.getstringparameter + - title: onDefineParameters + url: /pages/api/ts-command-line.commandlineparameterprovider.ondefineparameters + - title: parameters + url: /pages/api/ts-command-line.commandlineparameterprovider.parameters + - title: renderHelpText + url: /pages/api/ts-command-line.commandlineparameterprovider.renderhelptext + - title: CommandLineParameterWithArgument + url: /pages/api/ts-command-line.commandlineparameterwithargument + subitems: + - title: argumentName + url: /pages/api/ts-command-line.commandlineparameterwithargument.argumentname + - title: CommandLineParser + url: /pages/api/ts-command-line.commandlineparser + subitems: + - title: (constructor) + url: /pages/api/ts-command-line.commandlineparser._constructor_ + - title: actions + url: /pages/api/ts-command-line.commandlineparser.actions + - title: addAction + url: /pages/api/ts-command-line.commandlineparser.addaction + - title: execute + url: /pages/api/ts-command-line.commandlineparser.execute + - title: executeWithoutErrorHandling + url: /pages/api/ts-command-line.commandlineparser.executewithouterrorhandling + - title: getAction + url: /pages/api/ts-command-line.commandlineparser.getaction + - title: onExecute + url: /pages/api/ts-command-line.commandlineparser.onexecute + - title: selectedAction + url: /pages/api/ts-command-line.commandlineparser.selectedaction + - title: toolDescription + url: /pages/api/ts-command-line.commandlineparser.tooldescription + - title: toolFilename + url: /pages/api/ts-command-line.commandlineparser.toolfilename + - title: tryGetAction + url: /pages/api/ts-command-line.commandlineparser.trygetaction + - title: CommandLineStringListParameter + url: /pages/api/ts-command-line.commandlinestringlistparameter + subitems: + - title: appendToArgList + url: /pages/api/ts-command-line.commandlinestringlistparameter.appendtoarglist + - title: kind + url: /pages/api/ts-command-line.commandlinestringlistparameter.kind + - title: values + url: /pages/api/ts-command-line.commandlinestringlistparameter.values + - title: CommandLineStringParameter + url: /pages/api/ts-command-line.commandlinestringparameter + subitems: + - title: appendToArgList + url: /pages/api/ts-command-line.commandlinestringparameter.appendtoarglist + - title: defaultValue + url: /pages/api/ts-command-line.commandlinestringparameter.defaultvalue + - title: kind + url: /pages/api/ts-command-line.commandlinestringparameter.kind + - title: value + url: /pages/api/ts-command-line.commandlinestringparameter.value + - title: DynamicCommandLineAction + url: /pages/api/ts-command-line.dynamiccommandlineaction + subitems: + - title: onDefineParameters + url: /pages/api/ts-command-line.dynamiccommandlineaction.ondefineparameters + - title: onExecute + url: /pages/api/ts-command-line.dynamiccommandlineaction.onexecute + - title: DynamicCommandLineParser + url: /pages/api/ts-command-line.dynamiccommandlineparser + subitems: + - title: onDefineParameters + url: /pages/api/ts-command-line.dynamiccommandlineparser.ondefineparameters + - title: IBaseCommandLineDefinition + url: /pages/api/ts-command-line.ibasecommandlinedefinition + subitems: + - title: description + url: /pages/api/ts-command-line.ibasecommandlinedefinition.description + - title: environmentVariable + url: /pages/api/ts-command-line.ibasecommandlinedefinition.environmentvariable + - title: parameterLongName + url: /pages/api/ts-command-line.ibasecommandlinedefinition.parameterlongname + - title: parameterShortName + url: /pages/api/ts-command-line.ibasecommandlinedefinition.parametershortname + - title: required + url: /pages/api/ts-command-line.ibasecommandlinedefinition.required + - title: IBaseCommandLineDefinitionWithArgument + url: /pages/api/ts-command-line.ibasecommandlinedefinitionwithargument + subitems: + - title: argumentName + url: /pages/api/ts-command-line.ibasecommandlinedefinitionwithargument.argumentname + - title: ICommandLineActionOptions + url: /pages/api/ts-command-line.icommandlineactionoptions + subitems: + - title: actionName + url: /pages/api/ts-command-line.icommandlineactionoptions.actionname + - title: documentation + url: /pages/api/ts-command-line.icommandlineactionoptions.documentation + - title: summary + url: /pages/api/ts-command-line.icommandlineactionoptions.summary + - title: ICommandLineChoiceDefinition + url: /pages/api/ts-command-line.icommandlinechoicedefinition + subitems: + - title: alternatives + url: /pages/api/ts-command-line.icommandlinechoicedefinition.alternatives + - title: defaultValue + url: /pages/api/ts-command-line.icommandlinechoicedefinition.defaultvalue + - title: ICommandLineFlagDefinition + url: /pages/api/ts-command-line.icommandlineflagdefinition + - title: ICommandLineIntegerDefinition + url: /pages/api/ts-command-line.icommandlineintegerdefinition + subitems: + - title: defaultValue + url: /pages/api/ts-command-line.icommandlineintegerdefinition.defaultvalue + - title: ICommandLineParserOptions + url: /pages/api/ts-command-line.icommandlineparseroptions + subitems: + - title: toolDescription + url: /pages/api/ts-command-line.icommandlineparseroptions.tooldescription + - title: toolFilename + url: /pages/api/ts-command-line.icommandlineparseroptions.toolfilename + - title: ICommandLineStringDefinition + url: /pages/api/ts-command-line.icommandlinestringdefinition + subitems: + - title: defaultValue + url: /pages/api/ts-command-line.icommandlinestringdefinition.defaultvalue + - title: ICommandLineStringListDefinition + url: /pages/api/ts-command-line.icommandlinestringlistdefinition diff --git a/pages/api/api-documenter.iapidocumenterpluginmanifest.features.md b/pages/api/api-documenter.iapidocumenterpluginmanifest.features.md new file mode 100644 index 000000000..944defdf5 --- /dev/null +++ b/pages/api/api-documenter.iapidocumenterpluginmanifest.features.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [IApiDocumenterPluginManifest](./api-documenter.iapidocumenterpluginmanifest.md) > [features](./api-documenter.iapidocumenterpluginmanifest.features.md) + +## IApiDocumenterPluginManifest.features property + +The list of features provided by this plugin. + +Signature: + +```typescript +features: IFeatureDefinition[]; +``` diff --git a/pages/api/api-documenter.iapidocumenterpluginmanifest.manifestversion.md b/pages/api/api-documenter.iapidocumenterpluginmanifest.manifestversion.md new file mode 100644 index 000000000..80507307b --- /dev/null +++ b/pages/api/api-documenter.iapidocumenterpluginmanifest.manifestversion.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [IApiDocumenterPluginManifest](./api-documenter.iapidocumenterpluginmanifest.md) > [manifestVersion](./api-documenter.iapidocumenterpluginmanifest.manifestversion.md) + +## IApiDocumenterPluginManifest.manifestVersion property + +The manifest version number. For now, this must always be `1000`. + +Signature: + +```typescript +manifestVersion: 1000; +``` diff --git a/pages/api/api-documenter.iapidocumenterpluginmanifest.md b/pages/api/api-documenter.iapidocumenterpluginmanifest.md new file mode 100644 index 000000000..541bf9d19 --- /dev/null +++ b/pages/api/api-documenter.iapidocumenterpluginmanifest.md @@ -0,0 +1,52 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [IApiDocumenterPluginManifest](./api-documenter.iapidocumenterpluginmanifest.md) + +## IApiDocumenterPluginManifest interface + +The manifest for an API Documenter plugin. + +Signature: + +```typescript +export interface IApiDocumenterPluginManifest +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [features](./api-documenter.iapidocumenterpluginmanifest.features.md) | IFeatureDefinition[] | The list of features provided by this plugin. | +| [manifestVersion](./api-documenter.iapidocumenterpluginmanifest.manifestversion.md) | 1000 | The manifest version number. For now, this must always be 1000. | + +## Remarks + +An API documenter plugin is an NPM package. By convention, the NPM package name should have the prefix `doc-plugin-`. Its main entry point should export an object named `apiDocumenterPluginManifest` which implements the `IApiDocumenterPluginManifest` interface. + +For example: + +```ts +class MyMarkdownDocumenter extends MarkdownDocumenterFeature { + public onInitialized(): void { + console.log('MyMarkdownDocumenter: onInitialized()'); + } +} + +export const apiDocumenterPluginManifest: IApiDocumenterPluginManifest = { + manifestVersion: 1000, + features: [ + { + featureName: 'my-markdown-documenter', + kind: 'MarkdownDocumenterFeature', + subclass: MyMarkdownDocumenter + } + ] +}; + +``` + diff --git a/pages/api/api-documenter.ifeaturedefinition.featurename.md b/pages/api/api-documenter.ifeaturedefinition.featurename.md new file mode 100644 index 000000000..557ba0d21 --- /dev/null +++ b/pages/api/api-documenter.ifeaturedefinition.featurename.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [IFeatureDefinition](./api-documenter.ifeaturedefinition.md) > [featureName](./api-documenter.ifeaturedefinition.featurename.md) + +## IFeatureDefinition.featureName property + +The name of this feature, as it will appear in the config file. + +The name should consist of one or more words separated by hyphens. Each word should consist of lower case letters and numbers. Example: `my-feature` + +Signature: + +```typescript +featureName: string; +``` diff --git a/pages/api/api-documenter.ifeaturedefinition.kind.md b/pages/api/api-documenter.ifeaturedefinition.kind.md new file mode 100644 index 000000000..36e48ea17 --- /dev/null +++ b/pages/api/api-documenter.ifeaturedefinition.kind.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [IFeatureDefinition](./api-documenter.ifeaturedefinition.md) > [kind](./api-documenter.ifeaturedefinition.kind.md) + +## IFeatureDefinition.kind property + +Determines the kind of feature. The specified value is the name of the base class that `subclass` inherits from. + +Signature: + +```typescript +kind: 'MarkdownDocumenterFeature'; +``` + +## Remarks + +For now, `MarkdownDocumenterFeature` is the only supported value. + diff --git a/pages/api/api-documenter.ifeaturedefinition.md b/pages/api/api-documenter.ifeaturedefinition.md new file mode 100644 index 000000000..9f7e43d5e --- /dev/null +++ b/pages/api/api-documenter.ifeaturedefinition.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [IFeatureDefinition](./api-documenter.ifeaturedefinition.md) + +## IFeatureDefinition interface + +Defines a "feature" that is provided by an API Documenter plugin. A feature is a user-defined module that customizes the behavior of API Documenter. + +Signature: + +```typescript +export interface IFeatureDefinition +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [featureName](./api-documenter.ifeaturedefinition.featurename.md) | string | The name of this feature, as it will appear in the config file.The name should consist of one or more words separated by hyphens. Each word should consist of lower case letters and numbers. Example: my-feature | +| [kind](./api-documenter.ifeaturedefinition.kind.md) | 'MarkdownDocumenterFeature' | Determines the kind of feature. The specified value is the name of the base class that subclass inherits from. | +| [subclass](./api-documenter.ifeaturedefinition.subclass.md) | {
new (initialization: PluginFeatureInitialization): MarkdownDocumenterFeature;
} | Your subclass that extends from the base class. | + diff --git a/pages/api/api-documenter.ifeaturedefinition.subclass.md b/pages/api/api-documenter.ifeaturedefinition.subclass.md new file mode 100644 index 000000000..901ffcdf1 --- /dev/null +++ b/pages/api/api-documenter.ifeaturedefinition.subclass.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [IFeatureDefinition](./api-documenter.ifeaturedefinition.md) > [subclass](./api-documenter.ifeaturedefinition.subclass.md) + +## IFeatureDefinition.subclass property + +Your subclass that extends from the base class. + +Signature: + +```typescript +subclass: { + new (initialization: PluginFeatureInitialization): MarkdownDocumenterFeature; + }; +``` diff --git a/pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.apiitem.md b/pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.apiitem.md new file mode 100644 index 000000000..cebd390c1 --- /dev/null +++ b/pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.apiitem.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [IMarkdownDocumenterFeatureOnBeforeWritePageArgs](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.md) > [apiItem](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.apiitem.md) + +## IMarkdownDocumenterFeatureOnBeforeWritePageArgs.apiItem property + +The API item corresponding to this page. + +Signature: + +```typescript +readonly apiItem: ApiItem; +``` diff --git a/pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.md b/pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.md new file mode 100644 index 000000000..5e57c0a05 --- /dev/null +++ b/pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [IMarkdownDocumenterFeatureOnBeforeWritePageArgs](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.md) + +## IMarkdownDocumenterFeatureOnBeforeWritePageArgs interface + +Event arguments for MarkdownDocumenterFeature.onBeforeWritePage() + +Signature: + +```typescript +export interface IMarkdownDocumenterFeatureOnBeforeWritePageArgs +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [apiItem](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.apiitem.md) | ApiItem | The API item corresponding to this page. | +| [outputFilename](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.outputfilename.md) | string | The filename where the output will be written. | +| [pageContent](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.pagecontent.md) | string | The page content. The onBeforeWritePage() handler can reassign this string to customize the page appearance. | + diff --git a/pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.outputfilename.md b/pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.outputfilename.md new file mode 100644 index 000000000..deefe88ca --- /dev/null +++ b/pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.outputfilename.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [IMarkdownDocumenterFeatureOnBeforeWritePageArgs](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.md) > [outputFilename](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.outputfilename.md) + +## IMarkdownDocumenterFeatureOnBeforeWritePageArgs.outputFilename property + +The filename where the output will be written. + +Signature: + +```typescript +readonly outputFilename: string; +``` diff --git a/pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.pagecontent.md b/pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.pagecontent.md new file mode 100644 index 000000000..b043017d4 --- /dev/null +++ b/pages/api/api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.pagecontent.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [IMarkdownDocumenterFeatureOnBeforeWritePageArgs](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.md) > [pageContent](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.pagecontent.md) + +## IMarkdownDocumenterFeatureOnBeforeWritePageArgs.pageContent property + +The page content. The onBeforeWritePage() handler can reassign this string to customize the page appearance. + +Signature: + +```typescript +pageContent: string; +``` diff --git a/pages/api/api-documenter.imarkdowndocumenterfeatureonfinishedargs.md b/pages/api/api-documenter.imarkdowndocumenterfeatureonfinishedargs.md new file mode 100644 index 000000000..e955807c6 --- /dev/null +++ b/pages/api/api-documenter.imarkdowndocumenterfeatureonfinishedargs.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [IMarkdownDocumenterFeatureOnFinishedArgs](./api-documenter.imarkdowndocumenterfeatureonfinishedargs.md) + +## IMarkdownDocumenterFeatureOnFinishedArgs interface + +Event arguments for MarkdownDocumenterFeature.onFinished() + +Signature: + +```typescript +export interface IMarkdownDocumenterFeatureOnFinishedArgs +``` diff --git a/pages/api/api-documenter.markdowndocumenteraccessor.getlinkforapiitem.md b/pages/api/api-documenter.markdowndocumenteraccessor.getlinkforapiitem.md new file mode 100644 index 000000000..acf7c91ea --- /dev/null +++ b/pages/api/api-documenter.markdowndocumenteraccessor.getlinkforapiitem.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [MarkdownDocumenterAccessor](./api-documenter.markdowndocumenteraccessor.md) > [getLinkForApiItem](./api-documenter.markdowndocumenteraccessor.getlinkforapiitem.md) + +## MarkdownDocumenterAccessor.getLinkForApiItem() method + +For a given `ApiItem`, return its markdown hyperlink. + +Signature: + +```typescript +getLinkForApiItem(apiItem: ApiItem): string | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| apiItem | ApiItem | | + +Returns: + +`string | undefined` + +The hyperlink, or `undefined` if the `ApiItem` object does not have a hyperlink. + diff --git a/pages/api/api-documenter.markdowndocumenteraccessor.md b/pages/api/api-documenter.markdowndocumenteraccessor.md new file mode 100644 index 000000000..b60c67044 --- /dev/null +++ b/pages/api/api-documenter.markdowndocumenteraccessor.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [MarkdownDocumenterAccessor](./api-documenter.markdowndocumenteraccessor.md) + +## MarkdownDocumenterAccessor class + +Provides access to the documenter that is generating the output. + +Signature: + +```typescript +export declare class MarkdownDocumenterAccessor +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [getLinkForApiItem(apiItem)](./api-documenter.markdowndocumenteraccessor.getlinkforapiitem.md) | | For a given ApiItem, return its markdown hyperlink. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MarkdownDocumenterAccessor` class. + diff --git a/pages/api/api-documenter.markdowndocumenterfeature.context.md b/pages/api/api-documenter.markdowndocumenterfeature.context.md new file mode 100644 index 000000000..ec987213f --- /dev/null +++ b/pages/api/api-documenter.markdowndocumenterfeature.context.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md) > [context](./api-documenter.markdowndocumenterfeature.context.md) + +## MarkdownDocumenterFeature.context property + +Signature: + +```typescript +context: MarkdownDocumenterFeatureContext; +``` diff --git a/pages/api/api-documenter.markdowndocumenterfeature.md b/pages/api/api-documenter.markdowndocumenterfeature.md new file mode 100644 index 000000000..61e084b4e --- /dev/null +++ b/pages/api/api-documenter.markdowndocumenterfeature.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md) + +## MarkdownDocumenterFeature class + +Inherit from this base class to implement an API Documenter plugin feature that customizes the generation of markdown output. + +Signature: + +```typescript +export declare class MarkdownDocumenterFeature extends PluginFeature +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [context](./api-documenter.markdowndocumenterfeature.context.md) | | MarkdownDocumenterFeatureContext | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [onBeforeWritePage(eventArgs)](./api-documenter.markdowndocumenterfeature.onbeforewritepage.md) | | This event occurs before each markdown file is written. It provides an opportunity to customize the content of the file. | +| [onFinished(eventArgs)](./api-documenter.markdowndocumenterfeature.onfinished.md) | | This event occurs after all output files have been written. | + diff --git a/pages/api/api-documenter.markdowndocumenterfeature.onbeforewritepage.md b/pages/api/api-documenter.markdowndocumenterfeature.onbeforewritepage.md new file mode 100644 index 000000000..b3d3123ad --- /dev/null +++ b/pages/api/api-documenter.markdowndocumenterfeature.onbeforewritepage.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md) > [onBeforeWritePage](./api-documenter.markdowndocumenterfeature.onbeforewritepage.md) + +## MarkdownDocumenterFeature.onBeforeWritePage() method + +This event occurs before each markdown file is written. It provides an opportunity to customize the content of the file. + +Signature: + +```typescript +/** @virtual */ +onBeforeWritePage(eventArgs: IMarkdownDocumenterFeatureOnBeforeWritePageArgs): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| eventArgs | IMarkdownDocumenterFeatureOnBeforeWritePageArgs | | + +Returns: + +`void` + diff --git a/pages/api/api-documenter.markdowndocumenterfeature.onfinished.md b/pages/api/api-documenter.markdowndocumenterfeature.onfinished.md new file mode 100644 index 000000000..0d09baf3b --- /dev/null +++ b/pages/api/api-documenter.markdowndocumenterfeature.onfinished.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md) > [onFinished](./api-documenter.markdowndocumenterfeature.onfinished.md) + +## MarkdownDocumenterFeature.onFinished() method + +This event occurs after all output files have been written. + +Signature: + +```typescript +/** @virtual */ +onFinished(eventArgs: IMarkdownDocumenterFeatureOnFinishedArgs): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| eventArgs | IMarkdownDocumenterFeatureOnFinishedArgs | | + +Returns: + +`void` + diff --git a/pages/api/api-documenter.markdowndocumenterfeaturecontext.apimodel.md b/pages/api/api-documenter.markdowndocumenterfeaturecontext.apimodel.md new file mode 100644 index 000000000..24215c9a8 --- /dev/null +++ b/pages/api/api-documenter.markdowndocumenterfeaturecontext.apimodel.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [MarkdownDocumenterFeatureContext](./api-documenter.markdowndocumenterfeaturecontext.md) > [apiModel](./api-documenter.markdowndocumenterfeaturecontext.apimodel.md) + +## MarkdownDocumenterFeatureContext.apiModel property + +Provides access to the `ApiModel` for the documentation being generated. + +Signature: + +```typescript +readonly apiModel: ApiModel; +``` diff --git a/pages/api/api-documenter.markdowndocumenterfeaturecontext.documenter.md b/pages/api/api-documenter.markdowndocumenterfeaturecontext.documenter.md new file mode 100644 index 000000000..9b932d91c --- /dev/null +++ b/pages/api/api-documenter.markdowndocumenterfeaturecontext.documenter.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [MarkdownDocumenterFeatureContext](./api-documenter.markdowndocumenterfeaturecontext.md) > [documenter](./api-documenter.markdowndocumenterfeaturecontext.documenter.md) + +## MarkdownDocumenterFeatureContext.documenter property + +Exposes functionality of the documenter. + +Signature: + +```typescript +readonly documenter: MarkdownDocumenterAccessor; +``` diff --git a/pages/api/api-documenter.markdowndocumenterfeaturecontext.md b/pages/api/api-documenter.markdowndocumenterfeaturecontext.md new file mode 100644 index 000000000..50dc0dabb --- /dev/null +++ b/pages/api/api-documenter.markdowndocumenterfeaturecontext.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [MarkdownDocumenterFeatureContext](./api-documenter.markdowndocumenterfeaturecontext.md) + +## MarkdownDocumenterFeatureContext class + +Context object for [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md). + +Signature: + +```typescript +export declare class MarkdownDocumenterFeatureContext +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [apiModel](./api-documenter.markdowndocumenterfeaturecontext.apimodel.md) | | ApiModel | Provides access to the ApiModel for the documentation being generated. | +| [documenter](./api-documenter.markdowndocumenterfeaturecontext.documenter.md) | | MarkdownDocumenterAccessor | Exposes functionality of the documenter. | +| [outputFolder](./api-documenter.markdowndocumenterfeaturecontext.outputfolder.md) | | string | The full path to the output folder. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `MarkdownDocumenterFeatureContext` class. + diff --git a/pages/api/api-documenter.markdowndocumenterfeaturecontext.outputfolder.md b/pages/api/api-documenter.markdowndocumenterfeaturecontext.outputfolder.md new file mode 100644 index 000000000..c1a78030d --- /dev/null +++ b/pages/api/api-documenter.markdowndocumenterfeaturecontext.outputfolder.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [MarkdownDocumenterFeatureContext](./api-documenter.markdowndocumenterfeaturecontext.md) > [outputFolder](./api-documenter.markdowndocumenterfeaturecontext.outputfolder.md) + +## MarkdownDocumenterFeatureContext.outputFolder property + +The full path to the output folder. + +Signature: + +```typescript +readonly outputFolder: string; +``` diff --git a/pages/api/api-documenter.md b/pages/api/api-documenter.md new file mode 100644 index 000000000..21c03dc40 --- /dev/null +++ b/pages/api/api-documenter.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) + +## api-documenter package + +## Classes + +| Class | Description | +| --- | --- | +| [MarkdownDocumenterAccessor](./api-documenter.markdowndocumenteraccessor.md) | Provides access to the documenter that is generating the output. | +| [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md) | Inherit from this base class to implement an API Documenter plugin feature that customizes the generation of markdown output. | +| [MarkdownDocumenterFeatureContext](./api-documenter.markdowndocumenterfeaturecontext.md) | Context object for [MarkdownDocumenterFeature](./api-documenter.markdowndocumenterfeature.md). | +| [PluginFeature](./api-documenter.pluginfeature.md) | The abstract base class for all API Documenter plugin features. | +| [PluginFeatureContext](./api-documenter.pluginfeaturecontext.md) | Context object for [PluginFeature](./api-documenter.pluginfeature.md). | +| [PluginFeatureInitialization](./api-documenter.pluginfeatureinitialization.md) | This is an internal part of the plugin infrastructure. | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [IApiDocumenterPluginManifest](./api-documenter.iapidocumenterpluginmanifest.md) | The manifest for an API Documenter plugin. | +| [IFeatureDefinition](./api-documenter.ifeaturedefinition.md) | Defines a "feature" that is provided by an API Documenter plugin. A feature is a user-defined module that customizes the behavior of API Documenter. | +| [IMarkdownDocumenterFeatureOnBeforeWritePageArgs](./api-documenter.imarkdowndocumenterfeatureonbeforewritepageargs.md) | Event arguments for MarkdownDocumenterFeature.onBeforeWritePage() | +| [IMarkdownDocumenterFeatureOnFinishedArgs](./api-documenter.imarkdowndocumenterfeatureonfinishedargs.md) | Event arguments for MarkdownDocumenterFeature.onFinished() | + diff --git a/pages/api/api-documenter.pluginfeature.context.md b/pages/api/api-documenter.pluginfeature.context.md new file mode 100644 index 000000000..9e47c8ebd --- /dev/null +++ b/pages/api/api-documenter.pluginfeature.context.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [PluginFeature](./api-documenter.pluginfeature.md) > [context](./api-documenter.pluginfeature.context.md) + +## PluginFeature.context property + +Signature: + +```typescript +context: PluginFeatureContext; +``` diff --git a/pages/api/api-documenter.pluginfeature.md b/pages/api/api-documenter.pluginfeature.md new file mode 100644 index 000000000..8b118575a --- /dev/null +++ b/pages/api/api-documenter.pluginfeature.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [PluginFeature](./api-documenter.pluginfeature.md) + +## PluginFeature class + +The abstract base class for all API Documenter plugin features. + +Signature: + +```typescript +export declare abstract class PluginFeature +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [context](./api-documenter.pluginfeature.context.md) | | PluginFeatureContext | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [onInitialized()](./api-documenter.pluginfeature.oninitialized.md) | | This event function is called after the feature is initialized, but before any processing occurs. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PluginFeature` class. + diff --git a/pages/api/api-documenter.pluginfeature.oninitialized.md b/pages/api/api-documenter.pluginfeature.oninitialized.md new file mode 100644 index 000000000..525ed4863 --- /dev/null +++ b/pages/api/api-documenter.pluginfeature.oninitialized.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [PluginFeature](./api-documenter.pluginfeature.md) > [onInitialized](./api-documenter.pluginfeature.oninitialized.md) + +## PluginFeature.onInitialized() method + +This event function is called after the feature is initialized, but before any processing occurs. + +Signature: + +```typescript +/** @virtual */ +onInitialized(): void; +``` +Returns: + +`void` + diff --git a/pages/api/api-documenter.pluginfeaturecontext.md b/pages/api/api-documenter.pluginfeaturecontext.md new file mode 100644 index 000000000..7ff578f7b --- /dev/null +++ b/pages/api/api-documenter.pluginfeaturecontext.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [PluginFeatureContext](./api-documenter.pluginfeaturecontext.md) + +## PluginFeatureContext class + +Context object for [PluginFeature](./api-documenter.pluginfeature.md). + +Signature: + +```typescript +export declare class PluginFeatureContext +``` diff --git a/pages/api/api-documenter.pluginfeatureinitialization.md b/pages/api/api-documenter.pluginfeatureinitialization.md new file mode 100644 index 000000000..4ef87480a --- /dev/null +++ b/pages/api/api-documenter.pluginfeatureinitialization.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-documenter](./api-documenter.md) > [PluginFeatureInitialization](./api-documenter.pluginfeatureinitialization.md) + +## PluginFeatureInitialization class + +This is an internal part of the plugin infrastructure. + +Signature: + +```typescript +export declare class PluginFeatureInitialization +``` + +## Remarks + +This object is the constructor parameter for API Documenter plugin features. + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PluginFeatureInitialization` class. + diff --git a/pages/api/api-extractor-model.apicallsignature._constructor_.md b/pages/api/api-extractor-model.apicallsignature._constructor_.md new file mode 100644 index 000000000..068107f92 --- /dev/null +++ b/pages/api/api-extractor-model.apicallsignature._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiCallSignature](./api-extractor-model.apicallsignature.md) > [(constructor)](./api-extractor-model.apicallsignature._constructor_.md) + +## ApiCallSignature.(constructor) + +Constructs a new instance of the `ApiCallSignature` class + +Signature: + +```typescript +constructor(options: IApiCallSignatureOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiCallSignatureOptions | | + diff --git a/pages/api/api-extractor-model.apicallsignature.buildcanonicalreference.md b/pages/api/api-extractor-model.apicallsignature.buildcanonicalreference.md new file mode 100644 index 000000000..1e4059b09 --- /dev/null +++ b/pages/api/api-extractor-model.apicallsignature.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiCallSignature](./api-extractor-model.apicallsignature.md) > [buildCanonicalReference](./api-extractor-model.apicallsignature.buildcanonicalreference.md) + +## ApiCallSignature.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apicallsignature.containerkey.md b/pages/api/api-extractor-model.apicallsignature.containerkey.md new file mode 100644 index 000000000..f4f6e4cfa --- /dev/null +++ b/pages/api/api-extractor-model.apicallsignature.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiCallSignature](./api-extractor-model.apicallsignature.md) > [containerKey](./api-extractor-model.apicallsignature.containerkey.md) + +## ApiCallSignature.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apicallsignature.getcontainerkey.md b/pages/api/api-extractor-model.apicallsignature.getcontainerkey.md new file mode 100644 index 000000000..975c2a2e2 --- /dev/null +++ b/pages/api/api-extractor-model.apicallsignature.getcontainerkey.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiCallSignature](./api-extractor-model.apicallsignature.md) > [getContainerKey](./api-extractor-model.apicallsignature.getcontainerkey.md) + +## ApiCallSignature.getContainerKey() method + +Signature: + +```typescript +static getContainerKey(overloadIndex: number): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| overloadIndex | number | | + +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apicallsignature.kind.md b/pages/api/api-extractor-model.apicallsignature.kind.md new file mode 100644 index 000000000..43b3bd9ab --- /dev/null +++ b/pages/api/api-extractor-model.apicallsignature.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiCallSignature](./api-extractor-model.apicallsignature.md) > [kind](./api-extractor-model.apicallsignature.kind.md) + +## ApiCallSignature.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apicallsignature.md b/pages/api/api-extractor-model.apicallsignature.md new file mode 100644 index 000000000..2c54f0950 --- /dev/null +++ b/pages/api/api-extractor-model.apicallsignature.md @@ -0,0 +1,62 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiCallSignature](./api-extractor-model.apicallsignature.md) + +## ApiCallSignature class + +Represents a TypeScript function call signature. + +Signature: + +```typescript +export declare class ApiCallSignature extends ApiCallSignature_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apicallsignature._constructor_.md) | | Constructs a new instance of the ApiCallSignature class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apicallsignature.containerkey.md) | | string | | +| [kind](./api-extractor-model.apicallsignature.kind.md) | | ApiItemKind | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apicallsignature.buildcanonicalreference.md) | | (BETA) | +| [getContainerKey(overloadIndex)](./api-extractor-model.apicallsignature.getcontainerkey.md) | static | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiCallSignature` represents a TypeScript declaration such as `(x: number, y: number): number` in this example: + +```ts +export interface IChooser { + // A call signature: + (x: number, y: number): number; + + // Another overload for this call signature: + (x: string, y: string): string; +} + +function chooseFirst(x: T, y: T): T { + return x; +} + +let chooser: IChooser = chooseFirst; + +``` + diff --git a/pages/api/api-extractor-model.apiclass._constructor_.md b/pages/api/api-extractor-model.apiclass._constructor_.md new file mode 100644 index 000000000..2f310d89d --- /dev/null +++ b/pages/api/api-extractor-model.apiclass._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiClass](./api-extractor-model.apiclass.md) > [(constructor)](./api-extractor-model.apiclass._constructor_.md) + +## ApiClass.(constructor) + +Constructs a new instance of the `ApiClass` class + +Signature: + +```typescript +constructor(options: IApiClassOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiClassOptions | | + diff --git a/pages/api/api-extractor-model.apiclass.buildcanonicalreference.md b/pages/api/api-extractor-model.apiclass.buildcanonicalreference.md new file mode 100644 index 000000000..024783254 --- /dev/null +++ b/pages/api/api-extractor-model.apiclass.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiClass](./api-extractor-model.apiclass.md) > [buildCanonicalReference](./api-extractor-model.apiclass.buildcanonicalreference.md) + +## ApiClass.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apiclass.containerkey.md b/pages/api/api-extractor-model.apiclass.containerkey.md new file mode 100644 index 000000000..e5fec69fe --- /dev/null +++ b/pages/api/api-extractor-model.apiclass.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiClass](./api-extractor-model.apiclass.md) > [containerKey](./api-extractor-model.apiclass.containerkey.md) + +## ApiClass.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apiclass.extendstype.md b/pages/api/api-extractor-model.apiclass.extendstype.md new file mode 100644 index 000000000..93f745b50 --- /dev/null +++ b/pages/api/api-extractor-model.apiclass.extendstype.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiClass](./api-extractor-model.apiclass.md) > [extendsType](./api-extractor-model.apiclass.extendstype.md) + +## ApiClass.extendsType property + +The base class that this class inherits from (using the `extends` keyword), or undefined if there is no base class. + +Signature: + +```typescript +readonly extendsType: HeritageType | undefined; +``` diff --git a/pages/api/api-extractor-model.apiclass.getcontainerkey.md b/pages/api/api-extractor-model.apiclass.getcontainerkey.md new file mode 100644 index 000000000..830bddf89 --- /dev/null +++ b/pages/api/api-extractor-model.apiclass.getcontainerkey.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiClass](./api-extractor-model.apiclass.md) > [getContainerKey](./api-extractor-model.apiclass.getcontainerkey.md) + +## ApiClass.getContainerKey() method + +Signature: + +```typescript +static getContainerKey(name: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apiclass.implementstypes.md b/pages/api/api-extractor-model.apiclass.implementstypes.md new file mode 100644 index 000000000..30c743e44 --- /dev/null +++ b/pages/api/api-extractor-model.apiclass.implementstypes.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiClass](./api-extractor-model.apiclass.md) > [implementsTypes](./api-extractor-model.apiclass.implementstypes.md) + +## ApiClass.implementsTypes property + +The list of interfaces that this class implements using the `implements` keyword. + +Signature: + +```typescript +readonly implementsTypes: ReadonlyArray; +``` diff --git a/pages/api/api-extractor-model.apiclass.kind.md b/pages/api/api-extractor-model.apiclass.kind.md new file mode 100644 index 000000000..a4a065a57 --- /dev/null +++ b/pages/api/api-extractor-model.apiclass.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiClass](./api-extractor-model.apiclass.md) > [kind](./api-extractor-model.apiclass.kind.md) + +## ApiClass.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apiclass.md b/pages/api/api-extractor-model.apiclass.md new file mode 100644 index 000000000..bc8db028f --- /dev/null +++ b/pages/api/api-extractor-model.apiclass.md @@ -0,0 +1,54 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiClass](./api-extractor-model.apiclass.md) + +## ApiClass class + +Represents a TypeScript class declaration. + +Signature: + +```typescript +export declare class ApiClass extends ApiClass_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apiclass._constructor_.md) | | Constructs a new instance of the ApiClass class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apiclass.containerkey.md) | | string | | +| [extendsType](./api-extractor-model.apiclass.extendstype.md) | | HeritageType | undefined | The base class that this class inherits from (using the extends keyword), or undefined if there is no base class. | +| [implementsTypes](./api-extractor-model.apiclass.implementstypes.md) | | ReadonlyArray<HeritageType> | The list of interfaces that this class implements using the implements keyword. | +| [kind](./api-extractor-model.apiclass.kind.md) | | ApiItemKind | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apiclass.buildcanonicalreference.md) | | (BETA) | +| [getContainerKey(name)](./api-extractor-model.apiclass.getcontainerkey.md) | static | | +| [onDeserializeInto(options, context, jsonObject)](./api-extractor-model.apiclass.ondeserializeinto.md) | static | | +| [serializeInto(jsonObject)](./api-extractor-model.apiclass.serializeinto.md) | | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiClass` represents a TypeScript declaration such as this: + +```ts +export class X { } + +``` + diff --git a/pages/api/api-extractor-model.apiclass.ondeserializeinto.md b/pages/api/api-extractor-model.apiclass.ondeserializeinto.md new file mode 100644 index 000000000..6c283a25e --- /dev/null +++ b/pages/api/api-extractor-model.apiclass.ondeserializeinto.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiClass](./api-extractor-model.apiclass.md) > [onDeserializeInto](./api-extractor-model.apiclass.ondeserializeinto.md) + +## ApiClass.onDeserializeInto() method + + +Signature: + +```typescript +/** @override */ +static onDeserializeInto(options: Partial, context: DeserializerContext, jsonObject: IApiClassJson): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | Partial<IApiClassOptions> | | +| context | DeserializerContext | | +| jsonObject | IApiClassJson | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apiclass.serializeinto.md b/pages/api/api-extractor-model.apiclass.serializeinto.md new file mode 100644 index 000000000..e245ccbc8 --- /dev/null +++ b/pages/api/api-extractor-model.apiclass.serializeinto.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiClass](./api-extractor-model.apiclass.md) > [serializeInto](./api-extractor-model.apiclass.serializeinto.md) + +## ApiClass.serializeInto() method + + +Signature: + +```typescript +/** @override */ +serializeInto(jsonObject: Partial): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Partial<IApiClassJson> | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apiconstructor._constructor_.md b/pages/api/api-extractor-model.apiconstructor._constructor_.md new file mode 100644 index 000000000..dc25151cd --- /dev/null +++ b/pages/api/api-extractor-model.apiconstructor._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiConstructor](./api-extractor-model.apiconstructor.md) > [(constructor)](./api-extractor-model.apiconstructor._constructor_.md) + +## ApiConstructor.(constructor) + +Constructs a new instance of the `ApiConstructor` class + +Signature: + +```typescript +constructor(options: IApiConstructorOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiConstructorOptions | | + diff --git a/pages/api/api-extractor-model.apiconstructor.buildcanonicalreference.md b/pages/api/api-extractor-model.apiconstructor.buildcanonicalreference.md new file mode 100644 index 000000000..0f7328b06 --- /dev/null +++ b/pages/api/api-extractor-model.apiconstructor.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiConstructor](./api-extractor-model.apiconstructor.md) > [buildCanonicalReference](./api-extractor-model.apiconstructor.buildcanonicalreference.md) + +## ApiConstructor.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apiconstructor.containerkey.md b/pages/api/api-extractor-model.apiconstructor.containerkey.md new file mode 100644 index 000000000..ac0a4d0d9 --- /dev/null +++ b/pages/api/api-extractor-model.apiconstructor.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiConstructor](./api-extractor-model.apiconstructor.md) > [containerKey](./api-extractor-model.apiconstructor.containerkey.md) + +## ApiConstructor.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apiconstructor.getcontainerkey.md b/pages/api/api-extractor-model.apiconstructor.getcontainerkey.md new file mode 100644 index 000000000..7b7cfb743 --- /dev/null +++ b/pages/api/api-extractor-model.apiconstructor.getcontainerkey.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiConstructor](./api-extractor-model.apiconstructor.md) > [getContainerKey](./api-extractor-model.apiconstructor.getcontainerkey.md) + +## ApiConstructor.getContainerKey() method + +Signature: + +```typescript +static getContainerKey(overloadIndex: number): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| overloadIndex | number | | + +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apiconstructor.kind.md b/pages/api/api-extractor-model.apiconstructor.kind.md new file mode 100644 index 000000000..9ad2e2ff1 --- /dev/null +++ b/pages/api/api-extractor-model.apiconstructor.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiConstructor](./api-extractor-model.apiconstructor.md) > [kind](./api-extractor-model.apiconstructor.kind.md) + +## ApiConstructor.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apiconstructor.md b/pages/api/api-extractor-model.apiconstructor.md new file mode 100644 index 000000000..2ca7301c6 --- /dev/null +++ b/pages/api/api-extractor-model.apiconstructor.md @@ -0,0 +1,60 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiConstructor](./api-extractor-model.apiconstructor.md) + +## ApiConstructor class + +Represents a TypeScript class constructor declaration that belongs to an `ApiClass`. + +Signature: + +```typescript +export declare class ApiConstructor extends ApiConstructor_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apiconstructor._constructor_.md) | | Constructs a new instance of the ApiConstructor class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apiconstructor.containerkey.md) | | string | | +| [kind](./api-extractor-model.apiconstructor.kind.md) | | ApiItemKind | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apiconstructor.buildcanonicalreference.md) | | (BETA) | +| [getContainerKey(overloadIndex)](./api-extractor-model.apiconstructor.getcontainerkey.md) | static | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiConstructor` represents a declaration using the `constructor` keyword such as in this example: + +```ts +export class Vector { + public x: number; + public y: number; + + // A class constructor: + public constructor(x: number, y: number) { + this.x = x; + this.y = y; + } +} + +``` +Compare with [ApiConstructSignature](./api-extractor-model.apiconstructsignature.md), which describes the construct signature for a class constructor. + diff --git a/pages/api/api-extractor-model.apiconstructsignature._constructor_.md b/pages/api/api-extractor-model.apiconstructsignature._constructor_.md new file mode 100644 index 000000000..ac8369399 --- /dev/null +++ b/pages/api/api-extractor-model.apiconstructsignature._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiConstructSignature](./api-extractor-model.apiconstructsignature.md) > [(constructor)](./api-extractor-model.apiconstructsignature._constructor_.md) + +## ApiConstructSignature.(constructor) + +Constructs a new instance of the `ApiConstructSignature` class + +Signature: + +```typescript +constructor(options: IApiConstructSignatureOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiConstructSignatureOptions | | + diff --git a/pages/api/api-extractor-model.apiconstructsignature.buildcanonicalreference.md b/pages/api/api-extractor-model.apiconstructsignature.buildcanonicalreference.md new file mode 100644 index 000000000..73e196358 --- /dev/null +++ b/pages/api/api-extractor-model.apiconstructsignature.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiConstructSignature](./api-extractor-model.apiconstructsignature.md) > [buildCanonicalReference](./api-extractor-model.apiconstructsignature.buildcanonicalreference.md) + +## ApiConstructSignature.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apiconstructsignature.containerkey.md b/pages/api/api-extractor-model.apiconstructsignature.containerkey.md new file mode 100644 index 000000000..7f98d0e4a --- /dev/null +++ b/pages/api/api-extractor-model.apiconstructsignature.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiConstructSignature](./api-extractor-model.apiconstructsignature.md) > [containerKey](./api-extractor-model.apiconstructsignature.containerkey.md) + +## ApiConstructSignature.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apiconstructsignature.getcontainerkey.md b/pages/api/api-extractor-model.apiconstructsignature.getcontainerkey.md new file mode 100644 index 000000000..b8d39205a --- /dev/null +++ b/pages/api/api-extractor-model.apiconstructsignature.getcontainerkey.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiConstructSignature](./api-extractor-model.apiconstructsignature.md) > [getContainerKey](./api-extractor-model.apiconstructsignature.getcontainerkey.md) + +## ApiConstructSignature.getContainerKey() method + +Signature: + +```typescript +static getContainerKey(overloadIndex: number): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| overloadIndex | number | | + +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apiconstructsignature.kind.md b/pages/api/api-extractor-model.apiconstructsignature.kind.md new file mode 100644 index 000000000..938d1ec3d --- /dev/null +++ b/pages/api/api-extractor-model.apiconstructsignature.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiConstructSignature](./api-extractor-model.apiconstructsignature.md) > [kind](./api-extractor-model.apiconstructsignature.kind.md) + +## ApiConstructSignature.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apiconstructsignature.md b/pages/api/api-extractor-model.apiconstructsignature.md new file mode 100644 index 000000000..41ae87a81 --- /dev/null +++ b/pages/api/api-extractor-model.apiconstructsignature.md @@ -0,0 +1,75 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiConstructSignature](./api-extractor-model.apiconstructsignature.md) + +## ApiConstructSignature class + +Represents a TypeScript construct signature that belongs to an `ApiInterface`. + +Signature: + +```typescript +export declare class ApiConstructSignature extends ApiConstructSignature_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apiconstructsignature._constructor_.md) | | Constructs a new instance of the ApiConstructSignature class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apiconstructsignature.containerkey.md) | | string | | +| [kind](./api-extractor-model.apiconstructsignature.kind.md) | | ApiItemKind | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apiconstructsignature.buildcanonicalreference.md) | | (BETA) | +| [getContainerKey(overloadIndex)](./api-extractor-model.apiconstructsignature.getcontainerkey.md) | static | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiConstructSignature` represents a construct signature using the `new` keyword such as in this example: + +```ts +export interface IVector { + x: number; + y: number; +} + +export interface IVectorConstructor { + // A construct signature: + new(x: number, y: number): IVector; +} + +export function createVector(vectorConstructor: IVectorConstructor, + x: number, y: number): IVector { + return new vectorConstructor(x, y); +} + +class Vector implements IVector { + public x: number; + public y: number; + public constructor(x: number, y: number) { + this.x = x; + this.y = y; + } +} + +let vector: Vector = createVector(Vector, 1, 2); + +``` +Compare with [ApiConstructor](./api-extractor-model.apiconstructor.md), which describes the class constructor itself. + diff --git a/pages/api/api-extractor-model.apideclareditem._constructor_.md b/pages/api/api-extractor-model.apideclareditem._constructor_.md new file mode 100644 index 000000000..0a9b92343 --- /dev/null +++ b/pages/api/api-extractor-model.apideclareditem._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) > [(constructor)](./api-extractor-model.apideclareditem._constructor_.md) + +## ApiDeclaredItem.(constructor) + +Constructs a new instance of the `ApiDeclaredItem` class + +Signature: + +```typescript +constructor(options: IApiDeclaredItemOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiDeclaredItemOptions | | + diff --git a/pages/api/api-extractor-model.apideclareditem.buildexcerpt.md b/pages/api/api-extractor-model.apideclareditem.buildexcerpt.md new file mode 100644 index 000000000..2b9186133 --- /dev/null +++ b/pages/api/api-extractor-model.apideclareditem.buildexcerpt.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) > [buildExcerpt](./api-extractor-model.apideclareditem.buildexcerpt.md) + +## ApiDeclaredItem.buildExcerpt() method + +Constructs a new [Excerpt](./api-extractor-model.excerpt.md) corresponding to the provided token range. + +Signature: + +```typescript +buildExcerpt(tokenRange: IExcerptTokenRange): Excerpt; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| tokenRange | IExcerptTokenRange | | + +Returns: + +`Excerpt` + diff --git a/pages/api/api-extractor-model.apideclareditem.excerpt.md b/pages/api/api-extractor-model.apideclareditem.excerpt.md new file mode 100644 index 000000000..8cc0dd73f --- /dev/null +++ b/pages/api/api-extractor-model.apideclareditem.excerpt.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) > [excerpt](./api-extractor-model.apideclareditem.excerpt.md) + +## ApiDeclaredItem.excerpt property + +The source code excerpt where the API item is declared. + +Signature: + +```typescript +readonly excerpt: Excerpt; +``` diff --git a/pages/api/api-extractor-model.apideclareditem.excerpttokens.md b/pages/api/api-extractor-model.apideclareditem.excerpttokens.md new file mode 100644 index 000000000..e7b9d292b --- /dev/null +++ b/pages/api/api-extractor-model.apideclareditem.excerpttokens.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) > [excerptTokens](./api-extractor-model.apideclareditem.excerpttokens.md) + +## ApiDeclaredItem.excerptTokens property + +The individual source code tokens that comprise the main excerpt. + +Signature: + +```typescript +readonly excerptTokens: ReadonlyArray; +``` diff --git a/pages/api/api-extractor-model.apideclareditem.getexcerptwithmodifiers.md b/pages/api/api-extractor-model.apideclareditem.getexcerptwithmodifiers.md new file mode 100644 index 000000000..e5b185977 --- /dev/null +++ b/pages/api/api-extractor-model.apideclareditem.getexcerptwithmodifiers.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) > [getExcerptWithModifiers](./api-extractor-model.apideclareditem.getexcerptwithmodifiers.md) + +## ApiDeclaredItem.getExcerptWithModifiers() method + +If the API item has certain important modifier tags such as `@sealed`, `@virtual`, or `@override`, this prepends them as a doc comment above the excerpt. + +Signature: + +```typescript +getExcerptWithModifiers(): string; +``` +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apideclareditem.md b/pages/api/api-extractor-model.apideclareditem.md new file mode 100644 index 000000000..ff605dab2 --- /dev/null +++ b/pages/api/api-extractor-model.apideclareditem.md @@ -0,0 +1,47 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) + +## ApiDeclaredItem class + +The base class for API items that have an associated source code excerpt containing a TypeScript declaration. + +Signature: + +```typescript +export declare class ApiDeclaredItem extends ApiDocumentedItem +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apideclareditem._constructor_.md) | | Constructs a new instance of the ApiDeclaredItem class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [excerpt](./api-extractor-model.apideclareditem.excerpt.md) | | Excerpt | The source code excerpt where the API item is declared. | +| [excerptTokens](./api-extractor-model.apideclareditem.excerpttokens.md) | | ReadonlyArray<ExcerptToken> | The individual source code tokens that comprise the main excerpt. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildExcerpt(tokenRange)](./api-extractor-model.apideclareditem.buildexcerpt.md) | | Constructs a new [Excerpt](./api-extractor-model.excerpt.md) corresponding to the provided token range. | +| [getExcerptWithModifiers()](./api-extractor-model.apideclareditem.getexcerptwithmodifiers.md) | | If the API item has certain important modifier tags such as @sealed, @virtual, or @override, this prepends them as a doc comment above the excerpt. | +| [onDeserializeInto(options, context, jsonObject)](./api-extractor-model.apideclareditem.ondeserializeinto.md) | static | | +| [serializeInto(jsonObject)](./api-extractor-model.apideclareditem.serializeinto.md) | | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +Most `ApiItem` subclasses have declarations and thus extend `ApiDeclaredItem`. Counterexamples include `ApiModel` and `ApiPackage`, which do not have any corresponding TypeScript source code. + diff --git a/pages/api/api-extractor-model.apideclareditem.ondeserializeinto.md b/pages/api/api-extractor-model.apideclareditem.ondeserializeinto.md new file mode 100644 index 000000000..e4abbed77 --- /dev/null +++ b/pages/api/api-extractor-model.apideclareditem.ondeserializeinto.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) > [onDeserializeInto](./api-extractor-model.apideclareditem.ondeserializeinto.md) + +## ApiDeclaredItem.onDeserializeInto() method + + +Signature: + +```typescript +/** @override */ +static onDeserializeInto(options: Partial, context: DeserializerContext, jsonObject: IApiDeclaredItemJson): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | Partial<IApiDeclaredItemOptions> | | +| context | DeserializerContext | | +| jsonObject | IApiDeclaredItemJson | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apideclareditem.serializeinto.md b/pages/api/api-extractor-model.apideclareditem.serializeinto.md new file mode 100644 index 000000000..1b8d3436e --- /dev/null +++ b/pages/api/api-extractor-model.apideclareditem.serializeinto.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) > [serializeInto](./api-extractor-model.apideclareditem.serializeinto.md) + +## ApiDeclaredItem.serializeInto() method + + +Signature: + +```typescript +/** @override */ +serializeInto(jsonObject: Partial): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Partial<IApiDeclaredItemJson> | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apidocumenteditem._constructor_.md b/pages/api/api-extractor-model.apidocumenteditem._constructor_.md new file mode 100644 index 000000000..cabe64600 --- /dev/null +++ b/pages/api/api-extractor-model.apidocumenteditem._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiDocumentedItem](./api-extractor-model.apidocumenteditem.md) > [(constructor)](./api-extractor-model.apidocumenteditem._constructor_.md) + +## ApiDocumentedItem.(constructor) + +Constructs a new instance of the `ApiDocumentedItem` class + +Signature: + +```typescript +constructor(options: IApiDocumentedItemOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiDocumentedItemOptions | | + diff --git a/pages/api/api-extractor-model.apidocumenteditem.md b/pages/api/api-extractor-model.apidocumenteditem.md new file mode 100644 index 000000000..96e4d1737 --- /dev/null +++ b/pages/api/api-extractor-model.apidocumenteditem.md @@ -0,0 +1,42 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiDocumentedItem](./api-extractor-model.apidocumenteditem.md) + +## ApiDocumentedItem class + +An abstract base class for API declarations that can have an associated TSDoc comment. + +Signature: + +```typescript +export declare class ApiDocumentedItem extends ApiItem +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apidocumenteditem._constructor_.md) | | Constructs a new instance of the ApiDocumentedItem class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [tsdocComment](./api-extractor-model.apidocumenteditem.tsdoccomment.md) | | tsdoc.DocComment | undefined | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [onDeserializeInto(options, context, jsonObject)](./api-extractor-model.apidocumenteditem.ondeserializeinto.md) | static | | +| [serializeInto(jsonObject)](./api-extractor-model.apidocumenteditem.serializeinto.md) | | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + diff --git a/pages/api/api-extractor-model.apidocumenteditem.ondeserializeinto.md b/pages/api/api-extractor-model.apidocumenteditem.ondeserializeinto.md new file mode 100644 index 000000000..e3723a742 --- /dev/null +++ b/pages/api/api-extractor-model.apidocumenteditem.ondeserializeinto.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiDocumentedItem](./api-extractor-model.apidocumenteditem.md) > [onDeserializeInto](./api-extractor-model.apidocumenteditem.ondeserializeinto.md) + +## ApiDocumentedItem.onDeserializeInto() method + + +Signature: + +```typescript +/** @override */ +static onDeserializeInto(options: Partial, context: DeserializerContext, jsonObject: IApiItemJson): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | Partial<IApiDocumentedItemOptions> | | +| context | DeserializerContext | | +| jsonObject | IApiItemJson | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apidocumenteditem.serializeinto.md b/pages/api/api-extractor-model.apidocumenteditem.serializeinto.md new file mode 100644 index 000000000..0dbb39c65 --- /dev/null +++ b/pages/api/api-extractor-model.apidocumenteditem.serializeinto.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiDocumentedItem](./api-extractor-model.apidocumenteditem.md) > [serializeInto](./api-extractor-model.apidocumenteditem.serializeinto.md) + +## ApiDocumentedItem.serializeInto() method + + +Signature: + +```typescript +/** @override */ +serializeInto(jsonObject: Partial): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Partial<IApiDocumentedItemJson> | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apidocumenteditem.tsdoccomment.md b/pages/api/api-extractor-model.apidocumenteditem.tsdoccomment.md new file mode 100644 index 000000000..66402d392 --- /dev/null +++ b/pages/api/api-extractor-model.apidocumenteditem.tsdoccomment.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiDocumentedItem](./api-extractor-model.apidocumenteditem.md) > [tsdocComment](./api-extractor-model.apidocumenteditem.tsdoccomment.md) + +## ApiDocumentedItem.tsdocComment property + +Signature: + +```typescript +readonly tsdocComment: tsdoc.DocComment | undefined; +``` diff --git a/pages/api/api-extractor-model.apientrypoint._constructor_.md b/pages/api/api-extractor-model.apientrypoint._constructor_.md new file mode 100644 index 000000000..c264bb2e9 --- /dev/null +++ b/pages/api/api-extractor-model.apientrypoint._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEntryPoint](./api-extractor-model.apientrypoint.md) > [(constructor)](./api-extractor-model.apientrypoint._constructor_.md) + +## ApiEntryPoint.(constructor) + +Constructs a new instance of the `ApiEntryPoint` class + +Signature: + +```typescript +constructor(options: IApiEntryPointOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiEntryPointOptions | | + diff --git a/pages/api/api-extractor-model.apientrypoint.buildcanonicalreference.md b/pages/api/api-extractor-model.apientrypoint.buildcanonicalreference.md new file mode 100644 index 000000000..847721223 --- /dev/null +++ b/pages/api/api-extractor-model.apientrypoint.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEntryPoint](./api-extractor-model.apientrypoint.md) > [buildCanonicalReference](./api-extractor-model.apientrypoint.buildcanonicalreference.md) + +## ApiEntryPoint.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apientrypoint.containerkey.md b/pages/api/api-extractor-model.apientrypoint.containerkey.md new file mode 100644 index 000000000..35ccd00f5 --- /dev/null +++ b/pages/api/api-extractor-model.apientrypoint.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEntryPoint](./api-extractor-model.apientrypoint.md) > [containerKey](./api-extractor-model.apientrypoint.containerkey.md) + +## ApiEntryPoint.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apientrypoint.importpath.md b/pages/api/api-extractor-model.apientrypoint.importpath.md new file mode 100644 index 000000000..bea3a4752 --- /dev/null +++ b/pages/api/api-extractor-model.apientrypoint.importpath.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEntryPoint](./api-extractor-model.apientrypoint.md) > [importPath](./api-extractor-model.apientrypoint.importpath.md) + +## ApiEntryPoint.importPath property + +The module path for this entry point, relative to the parent `ApiPackage`. In the current implementation, this is always the empty string, indicating the default entry point. + +Signature: + +```typescript +readonly importPath: string; +``` + +## Remarks + +API Extractor does not currently support analysis of multiple entry points. If that feature is implemented in the future, then the `ApiEntryPoint.importPath` will be used to distinguish different entry points, for example: `controls/Button` in `import { Button } from "example-package/controls/Button";`. + +The `ApiEntryPoint.name` property stores the same value as `ApiEntryPoint.importPath`. + diff --git a/pages/api/api-extractor-model.apientrypoint.kind.md b/pages/api/api-extractor-model.apientrypoint.kind.md new file mode 100644 index 000000000..8509633a8 --- /dev/null +++ b/pages/api/api-extractor-model.apientrypoint.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEntryPoint](./api-extractor-model.apientrypoint.md) > [kind](./api-extractor-model.apientrypoint.kind.md) + +## ApiEntryPoint.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apientrypoint.md b/pages/api/api-extractor-model.apientrypoint.md new file mode 100644 index 000000000..6cdcfa143 --- /dev/null +++ b/pages/api/api-extractor-model.apientrypoint.md @@ -0,0 +1,58 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEntryPoint](./api-extractor-model.apientrypoint.md) + +## ApiEntryPoint class + +Represents the entry point for an NPM package. + +Signature: + +```typescript +export declare class ApiEntryPoint extends ApiEntryPoint_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apientrypoint._constructor_.md) | | Constructs a new instance of the ApiEntryPoint class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apientrypoint.containerkey.md) | | string | | +| [importPath](./api-extractor-model.apientrypoint.importpath.md) | | string | The module path for this entry point, relative to the parent ApiPackage. In the current implementation, this is always the empty string, indicating the default entry point. | +| [kind](./api-extractor-model.apientrypoint.kind.md) | | ApiItemKind | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apientrypoint.buildcanonicalreference.md) | | (BETA) | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiEntryPoint` represents the entry point to an NPM package. API Extractor does not currently support analysis of multiple entry points, but the `ApiEntryPoint` object is included to support a future feature. In the current implementation, `ApiEntryPoint.importPath` is always the empty string. + +For example, suppose the package.json file looks like this: + +```json +{ + "name": "example-library", + "version": "1.0.0", + "main": "./lib/index.js", + "typings": "./lib/index.d.ts" +} + +``` +In this example, the `ApiEntryPoint` would represent the TypeScript module for `./lib/index.js`. + diff --git a/pages/api/api-extractor-model.apienum._constructor_.md b/pages/api/api-extractor-model.apienum._constructor_.md new file mode 100644 index 000000000..01013085c --- /dev/null +++ b/pages/api/api-extractor-model.apienum._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnum](./api-extractor-model.apienum.md) > [(constructor)](./api-extractor-model.apienum._constructor_.md) + +## ApiEnum.(constructor) + +Constructs a new instance of the `ApiEnum` class + +Signature: + +```typescript +constructor(options: IApiEnumOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiEnumOptions | | + diff --git a/pages/api/api-extractor-model.apienum.addmember.md b/pages/api/api-extractor-model.apienum.addmember.md new file mode 100644 index 000000000..c33b5fc0d --- /dev/null +++ b/pages/api/api-extractor-model.apienum.addmember.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnum](./api-extractor-model.apienum.md) > [addMember](./api-extractor-model.apienum.addmember.md) + +## ApiEnum.addMember() method + + +Signature: + +```typescript +/** @override */ +addMember(member: ApiEnumMember): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| member | ApiEnumMember | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apienum.buildcanonicalreference.md b/pages/api/api-extractor-model.apienum.buildcanonicalreference.md new file mode 100644 index 000000000..7d9340a74 --- /dev/null +++ b/pages/api/api-extractor-model.apienum.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnum](./api-extractor-model.apienum.md) > [buildCanonicalReference](./api-extractor-model.apienum.buildcanonicalreference.md) + +## ApiEnum.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apienum.containerkey.md b/pages/api/api-extractor-model.apienum.containerkey.md new file mode 100644 index 000000000..9ab47bd6a --- /dev/null +++ b/pages/api/api-extractor-model.apienum.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnum](./api-extractor-model.apienum.md) > [containerKey](./api-extractor-model.apienum.containerkey.md) + +## ApiEnum.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apienum.getcontainerkey.md b/pages/api/api-extractor-model.apienum.getcontainerkey.md new file mode 100644 index 000000000..0fd587b8d --- /dev/null +++ b/pages/api/api-extractor-model.apienum.getcontainerkey.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnum](./api-extractor-model.apienum.md) > [getContainerKey](./api-extractor-model.apienum.getcontainerkey.md) + +## ApiEnum.getContainerKey() method + +Signature: + +```typescript +static getContainerKey(name: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apienum.kind.md b/pages/api/api-extractor-model.apienum.kind.md new file mode 100644 index 000000000..58e6f2dd9 --- /dev/null +++ b/pages/api/api-extractor-model.apienum.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnum](./api-extractor-model.apienum.md) > [kind](./api-extractor-model.apienum.kind.md) + +## ApiEnum.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apienum.md b/pages/api/api-extractor-model.apienum.md new file mode 100644 index 000000000..287778bd9 --- /dev/null +++ b/pages/api/api-extractor-model.apienum.md @@ -0,0 +1,56 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnum](./api-extractor-model.apienum.md) + +## ApiEnum class + +Represents a TypeScript enum declaration. + +Signature: + +```typescript +export declare class ApiEnum extends ApiEnum_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apienum._constructor_.md) | | Constructs a new instance of the ApiEnum class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apienum.containerkey.md) | | string | | +| [kind](./api-extractor-model.apienum.kind.md) | | ApiItemKind | | +| [members](./api-extractor-model.apienum.members.md) | | ReadonlyArray<ApiEnumMember> | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [addMember(member)](./api-extractor-model.apienum.addmember.md) | | | +| [buildCanonicalReference()](./api-extractor-model.apienum.buildcanonicalreference.md) | | (BETA) | +| [getContainerKey(name)](./api-extractor-model.apienum.getcontainerkey.md) | static | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiEnum` represents an enum declaration such as `FontSizes` in the example below: + +```ts +export enum FontSizes { + Small = 100, + Medium = 200, + Large = 300 +} + +``` + diff --git a/pages/api/api-extractor-model.apienum.members.md b/pages/api/api-extractor-model.apienum.members.md new file mode 100644 index 000000000..85736dacf --- /dev/null +++ b/pages/api/api-extractor-model.apienum.members.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnum](./api-extractor-model.apienum.md) > [members](./api-extractor-model.apienum.members.md) + +## ApiEnum.members property + + +Signature: + +```typescript +/** @override */ +readonly members: ReadonlyArray; +``` diff --git a/pages/api/api-extractor-model.apienummember._constructor_.md b/pages/api/api-extractor-model.apienummember._constructor_.md new file mode 100644 index 000000000..65d1a31ec --- /dev/null +++ b/pages/api/api-extractor-model.apienummember._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnumMember](./api-extractor-model.apienummember.md) > [(constructor)](./api-extractor-model.apienummember._constructor_.md) + +## ApiEnumMember.(constructor) + +Constructs a new instance of the `ApiEnumMember` class + +Signature: + +```typescript +constructor(options: IApiEnumMemberOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiEnumMemberOptions | | + diff --git a/pages/api/api-extractor-model.apienummember.buildcanonicalreference.md b/pages/api/api-extractor-model.apienummember.buildcanonicalreference.md new file mode 100644 index 000000000..6f390e377 --- /dev/null +++ b/pages/api/api-extractor-model.apienummember.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnumMember](./api-extractor-model.apienummember.md) > [buildCanonicalReference](./api-extractor-model.apienummember.buildcanonicalreference.md) + +## ApiEnumMember.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apienummember.containerkey.md b/pages/api/api-extractor-model.apienummember.containerkey.md new file mode 100644 index 000000000..22a485845 --- /dev/null +++ b/pages/api/api-extractor-model.apienummember.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnumMember](./api-extractor-model.apienummember.md) > [containerKey](./api-extractor-model.apienummember.containerkey.md) + +## ApiEnumMember.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apienummember.getcontainerkey.md b/pages/api/api-extractor-model.apienummember.getcontainerkey.md new file mode 100644 index 000000000..dca6d0ed2 --- /dev/null +++ b/pages/api/api-extractor-model.apienummember.getcontainerkey.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnumMember](./api-extractor-model.apienummember.md) > [getContainerKey](./api-extractor-model.apienummember.getcontainerkey.md) + +## ApiEnumMember.getContainerKey() method + +Signature: + +```typescript +static getContainerKey(name: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apienummember.initializerexcerpt.md b/pages/api/api-extractor-model.apienummember.initializerexcerpt.md new file mode 100644 index 000000000..00762fac4 --- /dev/null +++ b/pages/api/api-extractor-model.apienummember.initializerexcerpt.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnumMember](./api-extractor-model.apienummember.md) > [initializerExcerpt](./api-extractor-model.apienummember.initializerexcerpt.md) + +## ApiEnumMember.initializerExcerpt property + +An [Excerpt](./api-extractor-model.excerpt.md) that describes the value of the enum member. + +Signature: + +```typescript +readonly initializerExcerpt: Excerpt; +``` diff --git a/pages/api/api-extractor-model.apienummember.kind.md b/pages/api/api-extractor-model.apienummember.kind.md new file mode 100644 index 000000000..826f93216 --- /dev/null +++ b/pages/api/api-extractor-model.apienummember.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnumMember](./api-extractor-model.apienummember.md) > [kind](./api-extractor-model.apienummember.kind.md) + +## ApiEnumMember.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apienummember.md b/pages/api/api-extractor-model.apienummember.md new file mode 100644 index 000000000..257277d9d --- /dev/null +++ b/pages/api/api-extractor-model.apienummember.md @@ -0,0 +1,57 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnumMember](./api-extractor-model.apienummember.md) + +## ApiEnumMember class + +Represents a member of a TypeScript enum declaration. + +Signature: + +```typescript +export declare class ApiEnumMember extends ApiEnumMember_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apienummember._constructor_.md) | | Constructs a new instance of the ApiEnumMember class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apienummember.containerkey.md) | | string | | +| [initializerExcerpt](./api-extractor-model.apienummember.initializerexcerpt.md) | | Excerpt | An [Excerpt](./api-extractor-model.excerpt.md) that describes the value of the enum member. | +| [kind](./api-extractor-model.apienummember.kind.md) | | ApiItemKind | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apienummember.buildcanonicalreference.md) | | (BETA) | +| [getContainerKey(name)](./api-extractor-model.apienummember.getcontainerkey.md) | static | | +| [onDeserializeInto(options, context, jsonObject)](./api-extractor-model.apienummember.ondeserializeinto.md) | static | | +| [serializeInto(jsonObject)](./api-extractor-model.apienummember.serializeinto.md) | | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiEnumMember` represents an enum member such as `Small = 100` in the example below: + +```ts +export enum FontSizes { + Small = 100, + Medium = 200, + Large = 300 +} + +``` + diff --git a/pages/api/api-extractor-model.apienummember.ondeserializeinto.md b/pages/api/api-extractor-model.apienummember.ondeserializeinto.md new file mode 100644 index 000000000..062adebc9 --- /dev/null +++ b/pages/api/api-extractor-model.apienummember.ondeserializeinto.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnumMember](./api-extractor-model.apienummember.md) > [onDeserializeInto](./api-extractor-model.apienummember.ondeserializeinto.md) + +## ApiEnumMember.onDeserializeInto() method + + +Signature: + +```typescript +/** @override */ +static onDeserializeInto(options: Partial, context: DeserializerContext, jsonObject: IApiEnumMemberJson): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | Partial<IApiEnumMemberOptions> | | +| context | DeserializerContext | | +| jsonObject | IApiEnumMemberJson | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apienummember.serializeinto.md b/pages/api/api-extractor-model.apienummember.serializeinto.md new file mode 100644 index 000000000..8d3206c25 --- /dev/null +++ b/pages/api/api-extractor-model.apienummember.serializeinto.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiEnumMember](./api-extractor-model.apienummember.md) > [serializeInto](./api-extractor-model.apienummember.serializeinto.md) + +## ApiEnumMember.serializeInto() method + + +Signature: + +```typescript +/** @override */ +serializeInto(jsonObject: Partial): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Partial<IApiEnumMemberJson> | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apifunction._constructor_.md b/pages/api/api-extractor-model.apifunction._constructor_.md new file mode 100644 index 000000000..ef088a47f --- /dev/null +++ b/pages/api/api-extractor-model.apifunction._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiFunction](./api-extractor-model.apifunction.md) > [(constructor)](./api-extractor-model.apifunction._constructor_.md) + +## ApiFunction.(constructor) + +Constructs a new instance of the `ApiFunction` class + +Signature: + +```typescript +constructor(options: IApiFunctionOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiFunctionOptions | | + diff --git a/pages/api/api-extractor-model.apifunction.buildcanonicalreference.md b/pages/api/api-extractor-model.apifunction.buildcanonicalreference.md new file mode 100644 index 000000000..0f1a63bd7 --- /dev/null +++ b/pages/api/api-extractor-model.apifunction.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiFunction](./api-extractor-model.apifunction.md) > [buildCanonicalReference](./api-extractor-model.apifunction.buildcanonicalreference.md) + +## ApiFunction.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apifunction.containerkey.md b/pages/api/api-extractor-model.apifunction.containerkey.md new file mode 100644 index 000000000..13fe10f72 --- /dev/null +++ b/pages/api/api-extractor-model.apifunction.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiFunction](./api-extractor-model.apifunction.md) > [containerKey](./api-extractor-model.apifunction.containerkey.md) + +## ApiFunction.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apifunction.getcontainerkey.md b/pages/api/api-extractor-model.apifunction.getcontainerkey.md new file mode 100644 index 000000000..7d2a3d004 --- /dev/null +++ b/pages/api/api-extractor-model.apifunction.getcontainerkey.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiFunction](./api-extractor-model.apifunction.md) > [getContainerKey](./api-extractor-model.apifunction.getcontainerkey.md) + +## ApiFunction.getContainerKey() method + +Signature: + +```typescript +static getContainerKey(name: string, overloadIndex: number): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| overloadIndex | number | | + +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apifunction.kind.md b/pages/api/api-extractor-model.apifunction.kind.md new file mode 100644 index 000000000..f246d0766 --- /dev/null +++ b/pages/api/api-extractor-model.apifunction.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiFunction](./api-extractor-model.apifunction.md) > [kind](./api-extractor-model.apifunction.kind.md) + +## ApiFunction.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apifunction.md b/pages/api/api-extractor-model.apifunction.md new file mode 100644 index 000000000..07e2f8349 --- /dev/null +++ b/pages/api/api-extractor-model.apifunction.md @@ -0,0 +1,53 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiFunction](./api-extractor-model.apifunction.md) + +## ApiFunction class + +Represents a TypeScript function declaration. + +Signature: + +```typescript +export declare class ApiFunction extends ApiFunction_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apifunction._constructor_.md) | | Constructs a new instance of the ApiFunction class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apifunction.containerkey.md) | | string | | +| [kind](./api-extractor-model.apifunction.kind.md) | | ApiItemKind | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apifunction.buildcanonicalreference.md) | | (BETA) | +| [getContainerKey(name, overloadIndex)](./api-extractor-model.apifunction.getcontainerkey.md) | static | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiFunction` represents a TypeScript declaration such as this example: + +```ts +export function getAverage(x: number, y: number): number { + return (x + y) / 2.0; +} + +``` +Functions are exported by an entry point module or by a namespace. Compare with [ApiMethod](./api-extractor-model.apimethod.md), which represents a function that is a member of a class. + diff --git a/pages/api/api-extractor-model.apiindexsignature._constructor_.md b/pages/api/api-extractor-model.apiindexsignature._constructor_.md new file mode 100644 index 000000000..cdecafaad --- /dev/null +++ b/pages/api/api-extractor-model.apiindexsignature._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiIndexSignature](./api-extractor-model.apiindexsignature.md) > [(constructor)](./api-extractor-model.apiindexsignature._constructor_.md) + +## ApiIndexSignature.(constructor) + +Constructs a new instance of the `ApiIndexSignature` class + +Signature: + +```typescript +constructor(options: IApiIndexSignatureOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiIndexSignatureOptions | | + diff --git a/pages/api/api-extractor-model.apiindexsignature.buildcanonicalreference.md b/pages/api/api-extractor-model.apiindexsignature.buildcanonicalreference.md new file mode 100644 index 000000000..9706554ad --- /dev/null +++ b/pages/api/api-extractor-model.apiindexsignature.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiIndexSignature](./api-extractor-model.apiindexsignature.md) > [buildCanonicalReference](./api-extractor-model.apiindexsignature.buildcanonicalreference.md) + +## ApiIndexSignature.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apiindexsignature.containerkey.md b/pages/api/api-extractor-model.apiindexsignature.containerkey.md new file mode 100644 index 000000000..7212a2818 --- /dev/null +++ b/pages/api/api-extractor-model.apiindexsignature.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiIndexSignature](./api-extractor-model.apiindexsignature.md) > [containerKey](./api-extractor-model.apiindexsignature.containerkey.md) + +## ApiIndexSignature.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apiindexsignature.getcontainerkey.md b/pages/api/api-extractor-model.apiindexsignature.getcontainerkey.md new file mode 100644 index 000000000..777875f00 --- /dev/null +++ b/pages/api/api-extractor-model.apiindexsignature.getcontainerkey.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiIndexSignature](./api-extractor-model.apiindexsignature.md) > [getContainerKey](./api-extractor-model.apiindexsignature.getcontainerkey.md) + +## ApiIndexSignature.getContainerKey() method + +Signature: + +```typescript +static getContainerKey(overloadIndex: number): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| overloadIndex | number | | + +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apiindexsignature.kind.md b/pages/api/api-extractor-model.apiindexsignature.kind.md new file mode 100644 index 000000000..67d33dc41 --- /dev/null +++ b/pages/api/api-extractor-model.apiindexsignature.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiIndexSignature](./api-extractor-model.apiindexsignature.md) > [kind](./api-extractor-model.apiindexsignature.kind.md) + +## ApiIndexSignature.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apiindexsignature.md b/pages/api/api-extractor-model.apiindexsignature.md new file mode 100644 index 000000000..d79d88963 --- /dev/null +++ b/pages/api/api-extractor-model.apiindexsignature.md @@ -0,0 +1,56 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiIndexSignature](./api-extractor-model.apiindexsignature.md) + +## ApiIndexSignature class + +Represents a TypeScript index signature. + +Signature: + +```typescript +export declare class ApiIndexSignature extends ApiIndexSignature_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apiindexsignature._constructor_.md) | | Constructs a new instance of the ApiIndexSignature class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apiindexsignature.containerkey.md) | | string | | +| [kind](./api-extractor-model.apiindexsignature.kind.md) | | ApiItemKind | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apiindexsignature.buildcanonicalreference.md) | | (BETA) | +| [getContainerKey(overloadIndex)](./api-extractor-model.apiindexsignature.getcontainerkey.md) | static | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiIndexSignature` represents a TypeScript declaration such as `[x: number]: number` in this example: + +```ts +export interface INumberTable { + // An index signature + [value: number]: number; + + // An overloaded index signature + [name: string]: number; +} + +``` + diff --git a/pages/api/api-extractor-model.apiinterface._constructor_.md b/pages/api/api-extractor-model.apiinterface._constructor_.md new file mode 100644 index 000000000..02c2a0963 --- /dev/null +++ b/pages/api/api-extractor-model.apiinterface._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiInterface](./api-extractor-model.apiinterface.md) > [(constructor)](./api-extractor-model.apiinterface._constructor_.md) + +## ApiInterface.(constructor) + +Constructs a new instance of the `ApiInterface` class + +Signature: + +```typescript +constructor(options: IApiInterfaceOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiInterfaceOptions | | + diff --git a/pages/api/api-extractor-model.apiinterface.buildcanonicalreference.md b/pages/api/api-extractor-model.apiinterface.buildcanonicalreference.md new file mode 100644 index 000000000..2439f6807 --- /dev/null +++ b/pages/api/api-extractor-model.apiinterface.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiInterface](./api-extractor-model.apiinterface.md) > [buildCanonicalReference](./api-extractor-model.apiinterface.buildcanonicalreference.md) + +## ApiInterface.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apiinterface.containerkey.md b/pages/api/api-extractor-model.apiinterface.containerkey.md new file mode 100644 index 000000000..ea7739ce3 --- /dev/null +++ b/pages/api/api-extractor-model.apiinterface.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiInterface](./api-extractor-model.apiinterface.md) > [containerKey](./api-extractor-model.apiinterface.containerkey.md) + +## ApiInterface.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apiinterface.extendstypes.md b/pages/api/api-extractor-model.apiinterface.extendstypes.md new file mode 100644 index 000000000..32284b1f0 --- /dev/null +++ b/pages/api/api-extractor-model.apiinterface.extendstypes.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiInterface](./api-extractor-model.apiinterface.md) > [extendsTypes](./api-extractor-model.apiinterface.extendstypes.md) + +## ApiInterface.extendsTypes property + +The list of base interfaces that this interface inherits from using the `extends` keyword. + +Signature: + +```typescript +readonly extendsTypes: ReadonlyArray; +``` diff --git a/pages/api/api-extractor-model.apiinterface.getcontainerkey.md b/pages/api/api-extractor-model.apiinterface.getcontainerkey.md new file mode 100644 index 000000000..7ebd194cb --- /dev/null +++ b/pages/api/api-extractor-model.apiinterface.getcontainerkey.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiInterface](./api-extractor-model.apiinterface.md) > [getContainerKey](./api-extractor-model.apiinterface.getcontainerkey.md) + +## ApiInterface.getContainerKey() method + +Signature: + +```typescript +static getContainerKey(name: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apiinterface.kind.md b/pages/api/api-extractor-model.apiinterface.kind.md new file mode 100644 index 000000000..748061427 --- /dev/null +++ b/pages/api/api-extractor-model.apiinterface.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiInterface](./api-extractor-model.apiinterface.md) > [kind](./api-extractor-model.apiinterface.kind.md) + +## ApiInterface.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apiinterface.md b/pages/api/api-extractor-model.apiinterface.md new file mode 100644 index 000000000..39bb5f3ce --- /dev/null +++ b/pages/api/api-extractor-model.apiinterface.md @@ -0,0 +1,54 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiInterface](./api-extractor-model.apiinterface.md) + +## ApiInterface class + +Represents a TypeScript class declaration. + +Signature: + +```typescript +export declare class ApiInterface extends ApiInterface_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apiinterface._constructor_.md) | | Constructs a new instance of the ApiInterface class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apiinterface.containerkey.md) | | string | | +| [extendsTypes](./api-extractor-model.apiinterface.extendstypes.md) | | ReadonlyArray<HeritageType> | The list of base interfaces that this interface inherits from using the extends keyword. | +| [kind](./api-extractor-model.apiinterface.kind.md) | | ApiItemKind | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apiinterface.buildcanonicalreference.md) | | (BETA) | +| [getContainerKey(name)](./api-extractor-model.apiinterface.getcontainerkey.md) | static | | +| [onDeserializeInto(options, context, jsonObject)](./api-extractor-model.apiinterface.ondeserializeinto.md) | static | | +| [serializeInto(jsonObject)](./api-extractor-model.apiinterface.serializeinto.md) | | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiInterface` represents a TypeScript declaration such as this: + +```ts +export interface X extends Y { +} + +``` + diff --git a/pages/api/api-extractor-model.apiinterface.ondeserializeinto.md b/pages/api/api-extractor-model.apiinterface.ondeserializeinto.md new file mode 100644 index 000000000..9aa152813 --- /dev/null +++ b/pages/api/api-extractor-model.apiinterface.ondeserializeinto.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiInterface](./api-extractor-model.apiinterface.md) > [onDeserializeInto](./api-extractor-model.apiinterface.ondeserializeinto.md) + +## ApiInterface.onDeserializeInto() method + + +Signature: + +```typescript +/** @override */ +static onDeserializeInto(options: Partial, context: DeserializerContext, jsonObject: IApiInterfaceJson): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | Partial<IApiInterfaceOptions> | | +| context | DeserializerContext | | +| jsonObject | IApiInterfaceJson | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apiinterface.serializeinto.md b/pages/api/api-extractor-model.apiinterface.serializeinto.md new file mode 100644 index 000000000..ce2ecf45b --- /dev/null +++ b/pages/api/api-extractor-model.apiinterface.serializeinto.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiInterface](./api-extractor-model.apiinterface.md) > [serializeInto](./api-extractor-model.apiinterface.serializeinto.md) + +## ApiInterface.serializeInto() method + + +Signature: + +```typescript +/** @override */ +serializeInto(jsonObject: Partial): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Partial<IApiInterfaceJson> | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apiitem._constructor_.md b/pages/api/api-extractor-model.apiitem._constructor_.md new file mode 100644 index 000000000..de1d43594 --- /dev/null +++ b/pages/api/api-extractor-model.apiitem._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItem](./api-extractor-model.apiitem.md) > [(constructor)](./api-extractor-model.apiitem._constructor_.md) + +## ApiItem.(constructor) + +Constructs a new instance of the `ApiItem` class + +Signature: + +```typescript +constructor(options: IApiItemOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiItemOptions | | + diff --git a/pages/api/api-extractor-model.apiitem.buildcanonicalreference.md b/pages/api/api-extractor-model.apiitem.buildcanonicalreference.md new file mode 100644 index 000000000..878a9a47a --- /dev/null +++ b/pages/api/api-extractor-model.apiitem.buildcanonicalreference.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItem](./api-extractor-model.apiitem.md) > [buildCanonicalReference](./api-extractor-model.apiitem.buildcanonicalreference.md) + +## ApiItem.buildCanonicalReference() method + +Builds the cached object used by the `canonicalReference` property. + +Signature: + +```typescript +/** @virtual */ +protected buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apiitem.canonicalreference.md b/pages/api/api-extractor-model.apiitem.canonicalreference.md new file mode 100644 index 000000000..09950e35a --- /dev/null +++ b/pages/api/api-extractor-model.apiitem.canonicalreference.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItem](./api-extractor-model.apiitem.md) > [canonicalReference](./api-extractor-model.apiitem.canonicalreference.md) + +## ApiItem.canonicalReference 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. +> + +Warning: This API is used internally by API extractor but is not yet ready for general usage. + +Signature: + +```typescript +readonly canonicalReference: DeclarationReference; +``` + +## Remarks + +Returns a `DeclarationReference` object using the experimental new declaration reference notation. + diff --git a/pages/api/api-extractor-model.apiitem.containerkey.md b/pages/api/api-extractor-model.apiitem.containerkey.md new file mode 100644 index 000000000..f8549452a --- /dev/null +++ b/pages/api/api-extractor-model.apiitem.containerkey.md @@ -0,0 +1,24 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItem](./api-extractor-model.apiitem.md) > [containerKey](./api-extractor-model.apiitem.containerkey.md) + +## ApiItem.containerKey property + +Returns a string key that can be used to efficiently retrieve an `ApiItem` from an `ApiItemContainerMixin`. The key is unique within the container. Its format is undocumented and may change at any time. + +Signature: + +```typescript +/** @virtual */ +readonly containerKey: string; +``` + +## Remarks + +Use the `getContainerKey()` static member to construct the key. Each subclass has a different implementation of this function, according to the aspects that are important for identifying it. + diff --git a/pages/api/api-extractor-model.apiitem.deserialize.md b/pages/api/api-extractor-model.apiitem.deserialize.md new file mode 100644 index 000000000..c33014496 --- /dev/null +++ b/pages/api/api-extractor-model.apiitem.deserialize.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItem](./api-extractor-model.apiitem.md) > [deserialize](./api-extractor-model.apiitem.deserialize.md) + +## ApiItem.deserialize() method + +Signature: + +```typescript +static deserialize(jsonObject: IApiItemJson, context: DeserializerContext): ApiItem; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | IApiItemJson | | +| context | DeserializerContext | | + +Returns: + +`ApiItem` + diff --git a/pages/api/api-extractor-model.apiitem.displayname.md b/pages/api/api-extractor-model.apiitem.displayname.md new file mode 100644 index 000000000..065d26b6e --- /dev/null +++ b/pages/api/api-extractor-model.apiitem.displayname.md @@ -0,0 +1,24 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItem](./api-extractor-model.apiitem.md) > [displayName](./api-extractor-model.apiitem.displayname.md) + +## ApiItem.displayName property + +Returns a name for this object that can be used in diagnostic messages, for example. + +Signature: + +```typescript +/** @virtual */ +readonly displayName: string; +``` + +## Remarks + +For an object that inherits ApiNameMixin, this will return the declared name (e.g. the name of a TypeScript function). Otherwise, it will return a string such as "(call signature)" or "(model)". + diff --git a/pages/api/api-extractor-model.apiitem.getassociatedpackage.md b/pages/api/api-extractor-model.apiitem.getassociatedpackage.md new file mode 100644 index 000000000..3047f7d74 --- /dev/null +++ b/pages/api/api-extractor-model.apiitem.getassociatedpackage.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItem](./api-extractor-model.apiitem.md) > [getAssociatedPackage](./api-extractor-model.apiitem.getassociatedpackage.md) + +## ApiItem.getAssociatedPackage() method + +If this item is an ApiPackage or has an ApiPackage as one of its parents, then that object is returned. Otherwise undefined is returned. + +Signature: + +```typescript +getAssociatedPackage(): ApiPackage | undefined; +``` +Returns: + +`ApiPackage | undefined` + diff --git a/pages/api/api-extractor-model.apiitem.gethierarchy.md b/pages/api/api-extractor-model.apiitem.gethierarchy.md new file mode 100644 index 000000000..005785c29 --- /dev/null +++ b/pages/api/api-extractor-model.apiitem.gethierarchy.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItem](./api-extractor-model.apiitem.md) > [getHierarchy](./api-extractor-model.apiitem.gethierarchy.md) + +## ApiItem.getHierarchy() method + +Returns the chain of ancestors, starting from the root of the tree, and ending with the this item. + +Signature: + +```typescript +getHierarchy(): ReadonlyArray; +``` +Returns: + +`ReadonlyArray` + diff --git a/pages/api/api-extractor-model.apiitem.getscopednamewithinpackage.md b/pages/api/api-extractor-model.apiitem.getscopednamewithinpackage.md new file mode 100644 index 000000000..70c06d7e1 --- /dev/null +++ b/pages/api/api-extractor-model.apiitem.getscopednamewithinpackage.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItem](./api-extractor-model.apiitem.md) > [getScopedNameWithinPackage](./api-extractor-model.apiitem.getscopednamewithinpackage.md) + +## ApiItem.getScopedNameWithinPackage() method + +This returns a scoped name such as `"Namespace1.Namespace2.MyClass.myMember()"`. It does not include the package name or entry point. + +Signature: + +```typescript +getScopedNameWithinPackage(): string; +``` +Returns: + +`string` + +## Remarks + +If called on an ApiEntrypoint, ApiPackage, or ApiModel item, the result is an empty string. + diff --git a/pages/api/api-extractor-model.apiitem.getsortkey.md b/pages/api/api-extractor-model.apiitem.getsortkey.md new file mode 100644 index 000000000..48332e7f7 --- /dev/null +++ b/pages/api/api-extractor-model.apiitem.getsortkey.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItem](./api-extractor-model.apiitem.md) > [getSortKey](./api-extractor-model.apiitem.getsortkey.md) + +## ApiItem.getSortKey() method + + +Signature: + +```typescript +/** @virtual */ +getSortKey(): string; +``` +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apiitem.kind.md b/pages/api/api-extractor-model.apiitem.kind.md new file mode 100644 index 000000000..58f97ca8b --- /dev/null +++ b/pages/api/api-extractor-model.apiitem.kind.md @@ -0,0 +1,19 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItem](./api-extractor-model.apiitem.md) > [kind](./api-extractor-model.apiitem.kind.md) + +## ApiItem.kind property + +Identifies the subclass of the `ApiItem` base class. + +Signature: + +```typescript +/** @virtual */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apiitem.md b/pages/api/api-extractor-model.apiitem.md new file mode 100644 index 000000000..b30505114 --- /dev/null +++ b/pages/api/api-extractor-model.apiitem.md @@ -0,0 +1,53 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItem](./api-extractor-model.apiitem.md) + +## ApiItem class + +The abstract base class for all members of an `ApiModel` object. + +Signature: + +```typescript +export declare class ApiItem +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apiitem._constructor_.md) | | Constructs a new instance of the ApiItem class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [canonicalReference](./api-extractor-model.apiitem.canonicalreference.md) | | DeclarationReference | (BETA) Warning: This API is used internally by API extractor but is not yet ready for general usage. | +| [containerKey](./api-extractor-model.apiitem.containerkey.md) | | string | Returns a string key that can be used to efficiently retrieve an ApiItem from an ApiItemContainerMixin. The key is unique within the container. Its format is undocumented and may change at any time. | +| [displayName](./api-extractor-model.apiitem.displayname.md) | | string | Returns a name for this object that can be used in diagnostic messages, for example. | +| [kind](./api-extractor-model.apiitem.kind.md) | | ApiItemKind | Identifies the subclass of the ApiItem base class. | +| [members](./api-extractor-model.apiitem.members.md) | | ReadonlyArray<ApiItem> | This property supports a visitor pattern for walking the tree. For items with ApiItemContainerMixin, it returns the contained items. Otherwise it returns an empty array. | +| [parent](./api-extractor-model.apiitem.parent.md) | | ApiItem | undefined | If this item was added to a ApiItemContainerMixin item, then this returns the container item. If this is an Parameter that was added to a method or function, then this returns the function item. Otherwise, it returns undefined. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apiitem.buildcanonicalreference.md) | | Builds the cached object used by the canonicalReference property. | +| [deserialize(jsonObject, context)](./api-extractor-model.apiitem.deserialize.md) | static | | +| [getAssociatedPackage()](./api-extractor-model.apiitem.getassociatedpackage.md) | | If this item is an ApiPackage or has an ApiPackage as one of its parents, then that object is returned. Otherwise undefined is returned. | +| [getHierarchy()](./api-extractor-model.apiitem.gethierarchy.md) | | Returns the chain of ancestors, starting from the root of the tree, and ending with the this item. | +| [getScopedNameWithinPackage()](./api-extractor-model.apiitem.getscopednamewithinpackage.md) | | This returns a scoped name such as "Namespace1.Namespace2.MyClass.myMember()". It does not include the package name or entry point. | +| [getSortKey()](./api-extractor-model.apiitem.getsortkey.md) | | | +| [onDeserializeInto(options, context, jsonObject)](./api-extractor-model.apiitem.ondeserializeinto.md) | static | | +| [serializeInto(jsonObject)](./api-extractor-model.apiitem.serializeinto.md) | | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + diff --git a/pages/api/api-extractor-model.apiitem.members.md b/pages/api/api-extractor-model.apiitem.members.md new file mode 100644 index 000000000..71a5cb300 --- /dev/null +++ b/pages/api/api-extractor-model.apiitem.members.md @@ -0,0 +1,19 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItem](./api-extractor-model.apiitem.md) > [members](./api-extractor-model.apiitem.members.md) + +## ApiItem.members property + +This property supports a visitor pattern for walking the tree. For items with ApiItemContainerMixin, it returns the contained items. Otherwise it returns an empty array. + +Signature: + +```typescript +/** @virtual */ +readonly members: ReadonlyArray; +``` diff --git a/pages/api/api-extractor-model.apiitem.ondeserializeinto.md b/pages/api/api-extractor-model.apiitem.ondeserializeinto.md new file mode 100644 index 000000000..09721a237 --- /dev/null +++ b/pages/api/api-extractor-model.apiitem.ondeserializeinto.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItem](./api-extractor-model.apiitem.md) > [onDeserializeInto](./api-extractor-model.apiitem.ondeserializeinto.md) + +## ApiItem.onDeserializeInto() method + + +Signature: + +```typescript +/** @virtual */ +static onDeserializeInto(options: Partial, context: DeserializerContext, jsonObject: IApiItemJson): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | Partial<IApiItemOptions> | | +| context | DeserializerContext | | +| jsonObject | IApiItemJson | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apiitem.parent.md b/pages/api/api-extractor-model.apiitem.parent.md new file mode 100644 index 000000000..1b3738688 --- /dev/null +++ b/pages/api/api-extractor-model.apiitem.parent.md @@ -0,0 +1,19 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItem](./api-extractor-model.apiitem.md) > [parent](./api-extractor-model.apiitem.parent.md) + +## ApiItem.parent property + +If this item was added to a ApiItemContainerMixin item, then this returns the container item. If this is an Parameter that was added to a method or function, then this returns the function item. Otherwise, it returns undefined. + +Signature: + +```typescript +/** @virtual */ +readonly parent: ApiItem | undefined; +``` diff --git a/pages/api/api-extractor-model.apiitem.serializeinto.md b/pages/api/api-extractor-model.apiitem.serializeinto.md new file mode 100644 index 000000000..6dd2a4ed7 --- /dev/null +++ b/pages/api/api-extractor-model.apiitem.serializeinto.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItem](./api-extractor-model.apiitem.md) > [serializeInto](./api-extractor-model.apiitem.serializeinto.md) + +## ApiItem.serializeInto() method + + +Signature: + +```typescript +/** @virtual */ +serializeInto(jsonObject: Partial): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Partial<IApiItemJson> | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apiitemcontainermixin.addmember.md b/pages/api/api-extractor-model.apiitemcontainermixin.addmember.md new file mode 100644 index 000000000..3d869a590 --- /dev/null +++ b/pages/api/api-extractor-model.apiitemcontainermixin.addmember.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItemContainerMixin](./api-extractor-model.apiitemcontainermixin.md) > [addMember](./api-extractor-model.apiitemcontainermixin.addmember.md) + +## ApiItemContainerMixin.addMember() method + +Adds a new member to the container. + +Signature: + +```typescript +addMember(member: ApiItem): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| member | ApiItem | | + +Returns: + +`void` + +## Remarks + +An ApiItem cannot be added to more than one container. + diff --git a/pages/api/api-extractor-model.apiitemcontainermixin.findmembersbyname.md b/pages/api/api-extractor-model.apiitemcontainermixin.findmembersbyname.md new file mode 100644 index 000000000..37a893dfc --- /dev/null +++ b/pages/api/api-extractor-model.apiitemcontainermixin.findmembersbyname.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItemContainerMixin](./api-extractor-model.apiitemcontainermixin.md) > [findMembersByName](./api-extractor-model.apiitemcontainermixin.findmembersbyname.md) + +## ApiItemContainerMixin.findMembersByName() method + +Returns a list of members with the specified name. + +Signature: + +```typescript +findMembersByName(name: string): ReadonlyArray; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +Returns: + +`ReadonlyArray` + diff --git a/pages/api/api-extractor-model.apiitemcontainermixin.isbaseclassof.md b/pages/api/api-extractor-model.apiitemcontainermixin.isbaseclassof.md new file mode 100644 index 000000000..613c0e812 --- /dev/null +++ b/pages/api/api-extractor-model.apiitemcontainermixin.isbaseclassof.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItemContainerMixin](./api-extractor-model.apiitemcontainermixin.md) > [isBaseClassOf](./api-extractor-model.apiitemcontainermixin.isbaseclassof.md) + +## ApiItemContainerMixin.isBaseClassOf() function + +A type guard that tests whether the specified `ApiItem` subclass extends the `ApiItemContainerMixin` mixin. + +Signature: + +```typescript +function isBaseClassOf(apiItem: ApiItem): apiItem is ApiItemContainerMixin; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| apiItem | ApiItem | | + +Returns: + +`apiItem is ApiItemContainerMixin` + +## Remarks + +The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of the mixin function produces a different subclass. (This could be mitigated by `Symbol.hasInstance`, however the TypeScript type system cannot invoke a runtime test.) + diff --git a/pages/api/api-extractor-model.apiitemcontainermixin.md b/pages/api/api-extractor-model.apiitemcontainermixin.md new file mode 100644 index 000000000..1874e0e81 --- /dev/null +++ b/pages/api/api-extractor-model.apiitemcontainermixin.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItemContainerMixin](./api-extractor-model.apiitemcontainermixin.md) + +## ApiItemContainerMixin namespace + +Static members for . + +Signature: + +```typescript +export declare namespace ApiItemContainerMixin +``` + +## Functions + +| Function | Description | +| --- | --- | +| [isBaseClassOf(apiItem)](./api-extractor-model.apiitemcontainermixin.isbaseclassof.md) | A type guard that tests whether the specified ApiItem subclass extends the ApiItemContainerMixin mixin. | + diff --git a/pages/api/api-extractor-model.apiitemcontainermixin.members.md b/pages/api/api-extractor-model.apiitemcontainermixin.members.md new file mode 100644 index 000000000..ef32b71b6 --- /dev/null +++ b/pages/api/api-extractor-model.apiitemcontainermixin.members.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItemContainerMixin](./api-extractor-model.apiitemcontainermixin.md) > [members](./api-extractor-model.apiitemcontainermixin.members.md) + +## ApiItemContainerMixin.members property + +Returns the members of this container, sorted alphabetically. + +Signature: + +```typescript +readonly members: ReadonlyArray; +``` diff --git a/pages/api/api-extractor-model.apiitemcontainermixin.serializeinto.md b/pages/api/api-extractor-model.apiitemcontainermixin.serializeinto.md new file mode 100644 index 000000000..0edccd9d9 --- /dev/null +++ b/pages/api/api-extractor-model.apiitemcontainermixin.serializeinto.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItemContainerMixin](./api-extractor-model.apiitemcontainermixin.md) > [serializeInto](./api-extractor-model.apiitemcontainermixin.serializeinto.md) + +## ApiItemContainerMixin.serializeInto() method + + +Signature: + +```typescript +/** @override */ +serializeInto(jsonObject: Partial): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Partial<IApiItemJson> | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apiitemcontainermixin.trygetmemberbykey.md b/pages/api/api-extractor-model.apiitemcontainermixin.trygetmemberbykey.md new file mode 100644 index 000000000..b5ad764a0 --- /dev/null +++ b/pages/api/api-extractor-model.apiitemcontainermixin.trygetmemberbykey.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItemContainerMixin](./api-extractor-model.apiitemcontainermixin.md) > [tryGetMemberByKey](./api-extractor-model.apiitemcontainermixin.trygetmemberbykey.md) + +## ApiItemContainerMixin.tryGetMemberByKey() method + +Attempts to retrieve a member using its containerKey, or returns `undefined` if no matching member was found. + +Signature: + +```typescript +tryGetMemberByKey(containerKey: string): ApiItem | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| containerKey | string | | + +Returns: + +`ApiItem | undefined` + +## Remarks + +Use the `getContainerKey()` static member to construct the key. Each subclass has a different implementation of this function, according to the aspects that are important for identifying it. + +See [ApiItem.containerKey](./api-extractor-model.apiitem.containerkey.md) for more information. + diff --git a/pages/api/api-extractor-model.apiitemkind.md b/pages/api/api-extractor-model.apiitemkind.md new file mode 100644 index 000000000..1f4fb41d8 --- /dev/null +++ b/pages/api/api-extractor-model.apiitemkind.md @@ -0,0 +1,44 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiItemKind](./api-extractor-model.apiitemkind.md) + +## ApiItemKind enum + +The type returned by the [ApiItem.kind](./api-extractor-model.apiitem.kind.md) property, which can be used to easily distinguish subclasses of [ApiItem](./api-extractor-model.apiitem.md). + +Signature: + +```typescript +export declare const enum ApiItemKind +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| CallSignature | "CallSignature" | | +| Class | "Class" | | +| Constructor | "Constructor" | | +| ConstructSignature | "ConstructSignature" | | +| EntryPoint | "EntryPoint" | | +| Enum | "Enum" | | +| EnumMember | "EnumMember" | | +| Function | "Function" | | +| IndexSignature | "IndexSignature" | | +| Interface | "Interface" | | +| Method | "Method" | | +| MethodSignature | "MethodSignature" | | +| Model | "Model" | | +| Namespace | "Namespace" | | +| None | "None" | | +| Package | "Package" | | +| Property | "Property" | | +| PropertySignature | "PropertySignature" | | +| TypeAlias | "TypeAlias" | | +| Variable | "Variable" | | + diff --git a/pages/api/api-extractor-model.apimethod._constructor_.md b/pages/api/api-extractor-model.apimethod._constructor_.md new file mode 100644 index 000000000..db9e8a502 --- /dev/null +++ b/pages/api/api-extractor-model.apimethod._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiMethod](./api-extractor-model.apimethod.md) > [(constructor)](./api-extractor-model.apimethod._constructor_.md) + +## ApiMethod.(constructor) + +Constructs a new instance of the `ApiMethod` class + +Signature: + +```typescript +constructor(options: IApiMethodOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiMethodOptions | | + diff --git a/pages/api/api-extractor-model.apimethod.buildcanonicalreference.md b/pages/api/api-extractor-model.apimethod.buildcanonicalreference.md new file mode 100644 index 000000000..2bfc6e7a7 --- /dev/null +++ b/pages/api/api-extractor-model.apimethod.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiMethod](./api-extractor-model.apimethod.md) > [buildCanonicalReference](./api-extractor-model.apimethod.buildcanonicalreference.md) + +## ApiMethod.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apimethod.containerkey.md b/pages/api/api-extractor-model.apimethod.containerkey.md new file mode 100644 index 000000000..22d2022c8 --- /dev/null +++ b/pages/api/api-extractor-model.apimethod.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiMethod](./api-extractor-model.apimethod.md) > [containerKey](./api-extractor-model.apimethod.containerkey.md) + +## ApiMethod.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apimethod.getcontainerkey.md b/pages/api/api-extractor-model.apimethod.getcontainerkey.md new file mode 100644 index 000000000..d718e62e9 --- /dev/null +++ b/pages/api/api-extractor-model.apimethod.getcontainerkey.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiMethod](./api-extractor-model.apimethod.md) > [getContainerKey](./api-extractor-model.apimethod.getcontainerkey.md) + +## ApiMethod.getContainerKey() method + +Signature: + +```typescript +static getContainerKey(name: string, isStatic: boolean, overloadIndex: number): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| isStatic | boolean | | +| overloadIndex | number | | + +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apimethod.kind.md b/pages/api/api-extractor-model.apimethod.kind.md new file mode 100644 index 000000000..cbb28a7a4 --- /dev/null +++ b/pages/api/api-extractor-model.apimethod.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiMethod](./api-extractor-model.apimethod.md) > [kind](./api-extractor-model.apimethod.kind.md) + +## ApiMethod.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apimethod.md b/pages/api/api-extractor-model.apimethod.md new file mode 100644 index 000000000..5ba8a288c --- /dev/null +++ b/pages/api/api-extractor-model.apimethod.md @@ -0,0 +1,53 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiMethod](./api-extractor-model.apimethod.md) + +## ApiMethod class + +Represents a TypeScript member function declaration that belongs to an `ApiClass`. + +Signature: + +```typescript +export declare class ApiMethod extends ApiMethod_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apimethod._constructor_.md) | | Constructs a new instance of the ApiMethod class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apimethod.containerkey.md) | | string | | +| [kind](./api-extractor-model.apimethod.kind.md) | | ApiItemKind | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apimethod.buildcanonicalreference.md) | | (BETA) | +| [getContainerKey(name, isStatic, overloadIndex)](./api-extractor-model.apimethod.getcontainerkey.md) | static | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiMethod` represents a TypeScript declaration such as the `render` member function in this example: + +```ts +export class Widget { + public render(): void { } +} + +``` +Compare with [ApiMethodSignature](./api-extractor-model.apimethodsignature.md), which represents a method belonging to an interface. For example, a class method can be `static` but an interface method cannot. + diff --git a/pages/api/api-extractor-model.apimethodsignature._constructor_.md b/pages/api/api-extractor-model.apimethodsignature._constructor_.md new file mode 100644 index 000000000..a1d10a9f8 --- /dev/null +++ b/pages/api/api-extractor-model.apimethodsignature._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiMethodSignature](./api-extractor-model.apimethodsignature.md) > [(constructor)](./api-extractor-model.apimethodsignature._constructor_.md) + +## ApiMethodSignature.(constructor) + +Constructs a new instance of the `ApiMethodSignature` class + +Signature: + +```typescript +constructor(options: IApiMethodSignatureOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiMethodSignatureOptions | | + diff --git a/pages/api/api-extractor-model.apimethodsignature.buildcanonicalreference.md b/pages/api/api-extractor-model.apimethodsignature.buildcanonicalreference.md new file mode 100644 index 000000000..040bc516b --- /dev/null +++ b/pages/api/api-extractor-model.apimethodsignature.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiMethodSignature](./api-extractor-model.apimethodsignature.md) > [buildCanonicalReference](./api-extractor-model.apimethodsignature.buildcanonicalreference.md) + +## ApiMethodSignature.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apimethodsignature.containerkey.md b/pages/api/api-extractor-model.apimethodsignature.containerkey.md new file mode 100644 index 000000000..f3b8413a4 --- /dev/null +++ b/pages/api/api-extractor-model.apimethodsignature.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiMethodSignature](./api-extractor-model.apimethodsignature.md) > [containerKey](./api-extractor-model.apimethodsignature.containerkey.md) + +## ApiMethodSignature.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apimethodsignature.getcontainerkey.md b/pages/api/api-extractor-model.apimethodsignature.getcontainerkey.md new file mode 100644 index 000000000..da441f8a2 --- /dev/null +++ b/pages/api/api-extractor-model.apimethodsignature.getcontainerkey.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiMethodSignature](./api-extractor-model.apimethodsignature.md) > [getContainerKey](./api-extractor-model.apimethodsignature.getcontainerkey.md) + +## ApiMethodSignature.getContainerKey() method + +Signature: + +```typescript +static getContainerKey(name: string, overloadIndex: number): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| overloadIndex | number | | + +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apimethodsignature.kind.md b/pages/api/api-extractor-model.apimethodsignature.kind.md new file mode 100644 index 000000000..5f51ceca6 --- /dev/null +++ b/pages/api/api-extractor-model.apimethodsignature.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiMethodSignature](./api-extractor-model.apimethodsignature.md) > [kind](./api-extractor-model.apimethodsignature.kind.md) + +## ApiMethodSignature.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apimethodsignature.md b/pages/api/api-extractor-model.apimethodsignature.md new file mode 100644 index 000000000..c61ad5822 --- /dev/null +++ b/pages/api/api-extractor-model.apimethodsignature.md @@ -0,0 +1,53 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiMethodSignature](./api-extractor-model.apimethodsignature.md) + +## ApiMethodSignature class + +Represents a TypeScript member function declaration that belongs to an `ApiInterface`. + +Signature: + +```typescript +export declare class ApiMethodSignature extends ApiMethodSignature_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apimethodsignature._constructor_.md) | | Constructs a new instance of the ApiMethodSignature class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apimethodsignature.containerkey.md) | | string | | +| [kind](./api-extractor-model.apimethodsignature.kind.md) | | ApiItemKind | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apimethodsignature.buildcanonicalreference.md) | | (BETA) | +| [getContainerKey(name, overloadIndex)](./api-extractor-model.apimethodsignature.getcontainerkey.md) | static | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiMethodSignature` represents a TypeScript declaration such as the `render` member function in this example: + +```ts +export interface IWidget { + render(): void; +} + +``` +Compare with [ApiMethod](./api-extractor-model.apimethod.md), which represents a method belonging to a class. For example, a class method can be `static` but an interface method cannot. + diff --git a/pages/api/api-extractor-model.apimodel._constructor_.md b/pages/api/api-extractor-model.apimodel._constructor_.md new file mode 100644 index 000000000..7de89163c --- /dev/null +++ b/pages/api/api-extractor-model.apimodel._constructor_.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiModel](./api-extractor-model.apimodel.md) > [(constructor)](./api-extractor-model.apimodel._constructor_.md) + +## ApiModel.(constructor) + +Constructs a new instance of the `ApiModel` class + +Signature: + +```typescript +constructor(); +``` diff --git a/pages/api/api-extractor-model.apimodel.addmember.md b/pages/api/api-extractor-model.apimodel.addmember.md new file mode 100644 index 000000000..ea5845929 --- /dev/null +++ b/pages/api/api-extractor-model.apimodel.addmember.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiModel](./api-extractor-model.apimodel.md) > [addMember](./api-extractor-model.apimodel.addmember.md) + +## ApiModel.addMember() method + + +Signature: + +```typescript +/** @override */ +addMember(member: ApiPackage): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| member | ApiPackage | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apimodel.buildcanonicalreference.md b/pages/api/api-extractor-model.apimodel.buildcanonicalreference.md new file mode 100644 index 000000000..ee2a9658e --- /dev/null +++ b/pages/api/api-extractor-model.apimodel.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiModel](./api-extractor-model.apimodel.md) > [buildCanonicalReference](./api-extractor-model.apimodel.buildcanonicalreference.md) + +## ApiModel.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apimodel.containerkey.md b/pages/api/api-extractor-model.apimodel.containerkey.md new file mode 100644 index 000000000..1962ad09b --- /dev/null +++ b/pages/api/api-extractor-model.apimodel.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiModel](./api-extractor-model.apimodel.md) > [containerKey](./api-extractor-model.apimodel.containerkey.md) + +## ApiModel.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apimodel.kind.md b/pages/api/api-extractor-model.apimodel.kind.md new file mode 100644 index 000000000..389275f95 --- /dev/null +++ b/pages/api/api-extractor-model.apimodel.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiModel](./api-extractor-model.apimodel.md) > [kind](./api-extractor-model.apimodel.kind.md) + +## ApiModel.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apimodel.loadpackage.md b/pages/api/api-extractor-model.apimodel.loadpackage.md new file mode 100644 index 000000000..924a08ddb --- /dev/null +++ b/pages/api/api-extractor-model.apimodel.loadpackage.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiModel](./api-extractor-model.apimodel.md) > [loadPackage](./api-extractor-model.apimodel.loadpackage.md) + +## ApiModel.loadPackage() method + +Signature: + +```typescript +loadPackage(apiJsonFilename: string): ApiPackage; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| apiJsonFilename | string | | + +Returns: + +`ApiPackage` + diff --git a/pages/api/api-extractor-model.apimodel.md b/pages/api/api-extractor-model.apimodel.md new file mode 100644 index 000000000..54de5f5da --- /dev/null +++ b/pages/api/api-extractor-model.apimodel.md @@ -0,0 +1,70 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiModel](./api-extractor-model.apimodel.md) + +## ApiModel class + +A serializable representation of a collection of API declarations. + +Signature: + +```typescript +export declare class ApiModel extends ApiModel_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)()](./api-extractor-model.apimodel._constructor_.md) | | Constructs a new instance of the ApiModel class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apimodel.containerkey.md) | | string | | +| [kind](./api-extractor-model.apimodel.kind.md) | | ApiItemKind | | +| [packages](./api-extractor-model.apimodel.packages.md) | | ReadonlyArray<ApiPackage> | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [addMember(member)](./api-extractor-model.apimodel.addmember.md) | | | +| [buildCanonicalReference()](./api-extractor-model.apimodel.buildcanonicalreference.md) | | (BETA) | +| [loadPackage(apiJsonFilename)](./api-extractor-model.apimodel.loadpackage.md) | | | +| [resolveDeclarationReference(declarationReference, contextApiItem)](./api-extractor-model.apimodel.resolvedeclarationreference.md) | | | +| [tryGetPackageByName(packageName)](./api-extractor-model.apimodel.trygetpackagebyname.md) | | Efficiently finds a package by the NPM package name. | + +## Remarks + +An `ApiModel` represents a collection of API declarations that can be serialized to disk. It captures all the important information needed to generate documentation, without any reliance on the TypeScript compiler engine. + +An `ApiModel` acts as the root of a tree of objects that all inherit from the `ApiItem` base class. The tree children are determined by the mixin base class. The model contains packages. Packages have an entry point (today, only one). And the entry point can contain various types of API declarations. The container relationships might look like this: + +``` +Things that can contain other things: + +- ApiModel + - ApiPackage + - ApiEntryPoint + - ApiClass + - ApiMethod + - ApiProperty + - ApiEnum + - ApiEnumMember + - ApiInterface + - ApiMethodSignature + - ApiPropertySignature + - ApiNamespace + - (ApiClass, ApiEnum, ApiInterace, ...) + + +``` +Normally, API Extractor writes an .api.json file to disk for each project that it builds. Then, a tool like API Documenter can load the various `ApiPackage` objects into a single `ApiModel` and process them as a group. This is useful because compilation generally occurs separately (e.g. because projects may reside in different Git repos, or because they build with different TypeScript compiler configurations that may be incompatible), whereas API Documenter cannot detect broken hyperlinks without seeing the entire documentation set. + diff --git a/pages/api/api-extractor-model.apimodel.packages.md b/pages/api/api-extractor-model.apimodel.packages.md new file mode 100644 index 000000000..7160511f4 --- /dev/null +++ b/pages/api/api-extractor-model.apimodel.packages.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiModel](./api-extractor-model.apimodel.md) > [packages](./api-extractor-model.apimodel.packages.md) + +## ApiModel.packages property + +Signature: + +```typescript +readonly packages: ReadonlyArray; +``` diff --git a/pages/api/api-extractor-model.apimodel.resolvedeclarationreference.md b/pages/api/api-extractor-model.apimodel.resolvedeclarationreference.md new file mode 100644 index 000000000..1e99764f0 --- /dev/null +++ b/pages/api/api-extractor-model.apimodel.resolvedeclarationreference.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiModel](./api-extractor-model.apimodel.md) > [resolveDeclarationReference](./api-extractor-model.apimodel.resolvedeclarationreference.md) + +## ApiModel.resolveDeclarationReference() method + +Signature: + +```typescript +resolveDeclarationReference(declarationReference: DocDeclarationReference, contextApiItem: ApiItem | undefined): IResolveDeclarationReferenceResult; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| declarationReference | DocDeclarationReference | | +| contextApiItem | ApiItem | undefined | | + +Returns: + +`IResolveDeclarationReferenceResult` + diff --git a/pages/api/api-extractor-model.apimodel.trygetpackagebyname.md b/pages/api/api-extractor-model.apimodel.trygetpackagebyname.md new file mode 100644 index 000000000..56e87a811 --- /dev/null +++ b/pages/api/api-extractor-model.apimodel.trygetpackagebyname.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiModel](./api-extractor-model.apimodel.md) > [tryGetPackageByName](./api-extractor-model.apimodel.trygetpackagebyname.md) + +## ApiModel.tryGetPackageByName() method + +Efficiently finds a package by the NPM package name. + +Signature: + +```typescript +tryGetPackageByName(packageName: string): ApiPackage | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| packageName | string | | + +Returns: + +`ApiPackage | undefined` + +## Remarks + +If the NPM scope is omitted in the package name, it will still be found provided that it is an unambiguous match. For example, it's often convenient to write `{@link node-core-library#JsonFile}` instead of `{@link @microsoft/node-core-library#JsonFile}`. + diff --git a/pages/api/api-extractor-model.apinamemixin.isbaseclassof.md b/pages/api/api-extractor-model.apinamemixin.isbaseclassof.md new file mode 100644 index 000000000..01b35980b --- /dev/null +++ b/pages/api/api-extractor-model.apinamemixin.isbaseclassof.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiNameMixin](./api-extractor-model.apinamemixin.md) > [isBaseClassOf](./api-extractor-model.apinamemixin.isbaseclassof.md) + +## ApiNameMixin.isBaseClassOf() function + +A type guard that tests whether the specified `ApiItem` subclass extends the `ApiNameMixin` mixin. + +Signature: + +```typescript +function isBaseClassOf(apiItem: ApiItem): apiItem is ApiNameMixin; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| apiItem | ApiItem | | + +Returns: + +`apiItem is ApiNameMixin` + +## Remarks + +The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of the mixin function produces a different subclass. (This could be mitigated by `Symbol.hasInstance`, however the TypeScript type system cannot invoke a runtime test.) + diff --git a/pages/api/api-extractor-model.apinamemixin.md b/pages/api/api-extractor-model.apinamemixin.md new file mode 100644 index 000000000..792ed466f --- /dev/null +++ b/pages/api/api-extractor-model.apinamemixin.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiNameMixin](./api-extractor-model.apinamemixin.md) + +## ApiNameMixin namespace + +Static members for . + +Signature: + +```typescript +export declare namespace ApiNameMixin +``` + +## Functions + +| Function | Description | +| --- | --- | +| [isBaseClassOf(apiItem)](./api-extractor-model.apinamemixin.isbaseclassof.md) | A type guard that tests whether the specified ApiItem subclass extends the ApiNameMixin mixin. | + diff --git a/pages/api/api-extractor-model.apinamemixin.name.md b/pages/api/api-extractor-model.apinamemixin.name.md new file mode 100644 index 000000000..849d67772 --- /dev/null +++ b/pages/api/api-extractor-model.apinamemixin.name.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiNameMixin](./api-extractor-model.apinamemixin.md) > [name](./api-extractor-model.apinamemixin.name.md) + +## ApiNameMixin.name property + +The exported name of this API item. + +Signature: + +```typescript +readonly name: string; +``` + +## Remarks + +Note that due tue type aliasing, the exported name may be different from the locally declared name. + diff --git a/pages/api/api-extractor-model.apinamemixin.serializeinto.md b/pages/api/api-extractor-model.apinamemixin.serializeinto.md new file mode 100644 index 000000000..6ca5cc139 --- /dev/null +++ b/pages/api/api-extractor-model.apinamemixin.serializeinto.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiNameMixin](./api-extractor-model.apinamemixin.md) > [serializeInto](./api-extractor-model.apinamemixin.serializeinto.md) + +## ApiNameMixin.serializeInto() method + + +Signature: + +```typescript +/** @override */ +serializeInto(jsonObject: Partial): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Partial<IApiItemJson> | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apinamespace._constructor_.md b/pages/api/api-extractor-model.apinamespace._constructor_.md new file mode 100644 index 000000000..bf32d038e --- /dev/null +++ b/pages/api/api-extractor-model.apinamespace._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiNamespace](./api-extractor-model.apinamespace.md) > [(constructor)](./api-extractor-model.apinamespace._constructor_.md) + +## ApiNamespace.(constructor) + +Constructs a new instance of the `ApiNamespace` class + +Signature: + +```typescript +constructor(options: IApiNamespaceOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiNamespaceOptions | | + diff --git a/pages/api/api-extractor-model.apinamespace.buildcanonicalreference.md b/pages/api/api-extractor-model.apinamespace.buildcanonicalreference.md new file mode 100644 index 000000000..6ea9e95a5 --- /dev/null +++ b/pages/api/api-extractor-model.apinamespace.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiNamespace](./api-extractor-model.apinamespace.md) > [buildCanonicalReference](./api-extractor-model.apinamespace.buildcanonicalreference.md) + +## ApiNamespace.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apinamespace.containerkey.md b/pages/api/api-extractor-model.apinamespace.containerkey.md new file mode 100644 index 000000000..aa5b911d7 --- /dev/null +++ b/pages/api/api-extractor-model.apinamespace.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiNamespace](./api-extractor-model.apinamespace.md) > [containerKey](./api-extractor-model.apinamespace.containerkey.md) + +## ApiNamespace.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apinamespace.getcontainerkey.md b/pages/api/api-extractor-model.apinamespace.getcontainerkey.md new file mode 100644 index 000000000..1305cd03f --- /dev/null +++ b/pages/api/api-extractor-model.apinamespace.getcontainerkey.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiNamespace](./api-extractor-model.apinamespace.md) > [getContainerKey](./api-extractor-model.apinamespace.getcontainerkey.md) + +## ApiNamespace.getContainerKey() method + +Signature: + +```typescript +static getContainerKey(name: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apinamespace.kind.md b/pages/api/api-extractor-model.apinamespace.kind.md new file mode 100644 index 000000000..8da3e19f4 --- /dev/null +++ b/pages/api/api-extractor-model.apinamespace.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiNamespace](./api-extractor-model.apinamespace.md) > [kind](./api-extractor-model.apinamespace.kind.md) + +## ApiNamespace.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apinamespace.md b/pages/api/api-extractor-model.apinamespace.md new file mode 100644 index 000000000..b5dcf1a10 --- /dev/null +++ b/pages/api/api-extractor-model.apinamespace.md @@ -0,0 +1,56 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiNamespace](./api-extractor-model.apinamespace.md) + +## ApiNamespace class + +Represents a TypeScript namespace declaration. + +Signature: + +```typescript +export declare class ApiNamespace extends ApiNamespace_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apinamespace._constructor_.md) | | Constructs a new instance of the ApiNamespace class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apinamespace.containerkey.md) | | string | | +| [kind](./api-extractor-model.apinamespace.kind.md) | | ApiItemKind | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apinamespace.buildcanonicalreference.md) | | (BETA) | +| [getContainerKey(name)](./api-extractor-model.apinamespace.getcontainerkey.md) | static | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiNamespace` represents a TypeScript declaration such `X` or `Y` in this example: + +```ts +export namespace X { + export namespace Y { + export interface IWidget { + render(): void; + } + } +} + +``` + diff --git a/pages/api/api-extractor-model.apipackage._constructor_.md b/pages/api/api-extractor-model.apipackage._constructor_.md new file mode 100644 index 000000000..99838ee37 --- /dev/null +++ b/pages/api/api-extractor-model.apipackage._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPackage](./api-extractor-model.apipackage.md) > [(constructor)](./api-extractor-model.apipackage._constructor_.md) + +## ApiPackage.(constructor) + +Constructs a new instance of the `ApiPackage` class + +Signature: + +```typescript +constructor(options: IApiPackageOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiPackageOptions | | + diff --git a/pages/api/api-extractor-model.apipackage.addmember.md b/pages/api/api-extractor-model.apipackage.addmember.md new file mode 100644 index 000000000..7ff6b737a --- /dev/null +++ b/pages/api/api-extractor-model.apipackage.addmember.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPackage](./api-extractor-model.apipackage.md) > [addMember](./api-extractor-model.apipackage.addmember.md) + +## ApiPackage.addMember() method + + +Signature: + +```typescript +/** @override */ +addMember(member: ApiEntryPoint): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| member | ApiEntryPoint | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apipackage.buildcanonicalreference.md b/pages/api/api-extractor-model.apipackage.buildcanonicalreference.md new file mode 100644 index 000000000..1143a75b8 --- /dev/null +++ b/pages/api/api-extractor-model.apipackage.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPackage](./api-extractor-model.apipackage.md) > [buildCanonicalReference](./api-extractor-model.apipackage.buildcanonicalreference.md) + +## ApiPackage.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apipackage.containerkey.md b/pages/api/api-extractor-model.apipackage.containerkey.md new file mode 100644 index 000000000..1e79172c2 --- /dev/null +++ b/pages/api/api-extractor-model.apipackage.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPackage](./api-extractor-model.apipackage.md) > [containerKey](./api-extractor-model.apipackage.containerkey.md) + +## ApiPackage.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apipackage.entrypoints.md b/pages/api/api-extractor-model.apipackage.entrypoints.md new file mode 100644 index 000000000..847bbd400 --- /dev/null +++ b/pages/api/api-extractor-model.apipackage.entrypoints.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPackage](./api-extractor-model.apipackage.md) > [entryPoints](./api-extractor-model.apipackage.entrypoints.md) + +## ApiPackage.entryPoints property + +Signature: + +```typescript +readonly entryPoints: ReadonlyArray; +``` diff --git a/pages/api/api-extractor-model.apipackage.findentrypointsbypath.md b/pages/api/api-extractor-model.apipackage.findentrypointsbypath.md new file mode 100644 index 000000000..b96f769f4 --- /dev/null +++ b/pages/api/api-extractor-model.apipackage.findentrypointsbypath.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPackage](./api-extractor-model.apipackage.md) > [findEntryPointsByPath](./api-extractor-model.apipackage.findentrypointsbypath.md) + +## ApiPackage.findEntryPointsByPath() method + +Signature: + +```typescript +findEntryPointsByPath(importPath: string): ReadonlyArray; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| importPath | string | | + +Returns: + +`ReadonlyArray` + diff --git a/pages/api/api-extractor-model.apipackage.kind.md b/pages/api/api-extractor-model.apipackage.kind.md new file mode 100644 index 000000000..8b20e8280 --- /dev/null +++ b/pages/api/api-extractor-model.apipackage.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPackage](./api-extractor-model.apipackage.md) > [kind](./api-extractor-model.apipackage.kind.md) + +## ApiPackage.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apipackage.loadfromjsonfile.md b/pages/api/api-extractor-model.apipackage.loadfromjsonfile.md new file mode 100644 index 000000000..806b8c46c --- /dev/null +++ b/pages/api/api-extractor-model.apipackage.loadfromjsonfile.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPackage](./api-extractor-model.apipackage.md) > [loadFromJsonFile](./api-extractor-model.apipackage.loadfromjsonfile.md) + +## ApiPackage.loadFromJsonFile() method + +Signature: + +```typescript +static loadFromJsonFile(apiJsonFilename: string): ApiPackage; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| apiJsonFilename | string | | + +Returns: + +`ApiPackage` + diff --git a/pages/api/api-extractor-model.apipackage.md b/pages/api/api-extractor-model.apipackage.md new file mode 100644 index 000000000..691a2764b --- /dev/null +++ b/pages/api/api-extractor-model.apipackage.md @@ -0,0 +1,47 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPackage](./api-extractor-model.apipackage.md) + +## ApiPackage class + +Represents an NPM package containing API declarations. + +Signature: + +```typescript +export declare class ApiPackage extends ApiPackage_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apipackage._constructor_.md) | | Constructs a new instance of the ApiPackage class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apipackage.containerkey.md) | | string | | +| [entryPoints](./api-extractor-model.apipackage.entrypoints.md) | | ReadonlyArray<ApiEntryPoint> | | +| [kind](./api-extractor-model.apipackage.kind.md) | | ApiItemKind | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [addMember(member)](./api-extractor-model.apipackage.addmember.md) | | | +| [buildCanonicalReference()](./api-extractor-model.apipackage.buildcanonicalreference.md) | | (BETA) | +| [findEntryPointsByPath(importPath)](./api-extractor-model.apipackage.findentrypointsbypath.md) | | | +| [loadFromJsonFile(apiJsonFilename)](./api-extractor-model.apipackage.loadfromjsonfile.md) | static | | +| [saveToJsonFile(apiJsonFilename, options)](./api-extractor-model.apipackage.savetojsonfile.md) | | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + diff --git a/pages/api/api-extractor-model.apipackage.savetojsonfile.md b/pages/api/api-extractor-model.apipackage.savetojsonfile.md new file mode 100644 index 000000000..e449c473a --- /dev/null +++ b/pages/api/api-extractor-model.apipackage.savetojsonfile.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPackage](./api-extractor-model.apipackage.md) > [saveToJsonFile](./api-extractor-model.apipackage.savetojsonfile.md) + +## ApiPackage.saveToJsonFile() method + +Signature: + +```typescript +saveToJsonFile(apiJsonFilename: string, options?: IApiPackageSaveOptions): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| apiJsonFilename | string | | +| options | IApiPackageSaveOptions | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apiparameterlistmixin.isbaseclassof.md b/pages/api/api-extractor-model.apiparameterlistmixin.isbaseclassof.md new file mode 100644 index 000000000..77201def7 --- /dev/null +++ b/pages/api/api-extractor-model.apiparameterlistmixin.isbaseclassof.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiParameterListMixin](./api-extractor-model.apiparameterlistmixin.md) > [isBaseClassOf](./api-extractor-model.apiparameterlistmixin.isbaseclassof.md) + +## ApiParameterListMixin.isBaseClassOf() function + +A type guard that tests whether the specified `ApiItem` subclass extends the `ApiParameterListMixin` mixin. + +Signature: + +```typescript +function isBaseClassOf(apiItem: ApiItem): apiItem is ApiParameterListMixin; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| apiItem | ApiItem | | + +Returns: + +`apiItem is ApiParameterListMixin` + +## Remarks + +The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of the mixin function produces a different subclass. (This could be mitigated by `Symbol.hasInstance`, however the TypeScript type system cannot invoke a runtime test.) + diff --git a/pages/api/api-extractor-model.apiparameterlistmixin.md b/pages/api/api-extractor-model.apiparameterlistmixin.md new file mode 100644 index 000000000..5d30582b7 --- /dev/null +++ b/pages/api/api-extractor-model.apiparameterlistmixin.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiParameterListMixin](./api-extractor-model.apiparameterlistmixin.md) + +## ApiParameterListMixin namespace + +Static members for . + +Signature: + +```typescript +export declare namespace ApiParameterListMixin +``` + +## Functions + +| Function | Description | +| --- | --- | +| [isBaseClassOf(apiItem)](./api-extractor-model.apiparameterlistmixin.isbaseclassof.md) | A type guard that tests whether the specified ApiItem subclass extends the ApiParameterListMixin mixin. | + diff --git a/pages/api/api-extractor-model.apiparameterlistmixin.overloadindex.md b/pages/api/api-extractor-model.apiparameterlistmixin.overloadindex.md new file mode 100644 index 000000000..46c6bb767 --- /dev/null +++ b/pages/api/api-extractor-model.apiparameterlistmixin.overloadindex.md @@ -0,0 +1,40 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiParameterListMixin](./api-extractor-model.apiparameterlistmixin.md) > [overloadIndex](./api-extractor-model.apiparameterlistmixin.overloadindex.md) + +## ApiParameterListMixin.overloadIndex property + +When a function has multiple overloaded declarations, this zero-based integer index can be used to unqiuely identify them. + +Signature: + +```typescript +readonly overloadIndex: number; +``` + +## Remarks + +Consider this overloaded declaration: + +```ts +export namespace Versioning { + // TSDoc: Versioning.(addVersions:1) + export function addVersions(x: number, y: number): number; + + // TSDoc: Versioning.(addVersions:2) + export function addVersions(x: string, y: string): string; + + // (implementation) + export function addVersions(x: number|string, y: number|string): number|string { + // . . . + } +} + +``` +In the above example, there are two overloaded declarations. The overload using numbers will have `overloadIndex = 1`. The overload using strings will have `overloadIndex = 2`. The third declaration that accepts all possible inputs is considered part of the implementation, and is not processed by API Extractor. + diff --git a/pages/api/api-extractor-model.apiparameterlistmixin.parameters.md b/pages/api/api-extractor-model.apiparameterlistmixin.parameters.md new file mode 100644 index 000000000..1abbca861 --- /dev/null +++ b/pages/api/api-extractor-model.apiparameterlistmixin.parameters.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiParameterListMixin](./api-extractor-model.apiparameterlistmixin.md) > [parameters](./api-extractor-model.apiparameterlistmixin.parameters.md) + +## ApiParameterListMixin.parameters property + +The function parameters. + +Signature: + +```typescript +readonly parameters: ReadonlyArray; +``` diff --git a/pages/api/api-extractor-model.apiparameterlistmixin.serializeinto.md b/pages/api/api-extractor-model.apiparameterlistmixin.serializeinto.md new file mode 100644 index 000000000..76665c90e --- /dev/null +++ b/pages/api/api-extractor-model.apiparameterlistmixin.serializeinto.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiParameterListMixin](./api-extractor-model.apiparameterlistmixin.md) > [serializeInto](./api-extractor-model.apiparameterlistmixin.serializeinto.md) + +## ApiParameterListMixin.serializeInto() method + +Signature: + +```typescript +serializeInto(jsonObject: Partial): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Partial<IApiItemJson> | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apiproperty._constructor_.md b/pages/api/api-extractor-model.apiproperty._constructor_.md new file mode 100644 index 000000000..08873035d --- /dev/null +++ b/pages/api/api-extractor-model.apiproperty._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiProperty](./api-extractor-model.apiproperty.md) > [(constructor)](./api-extractor-model.apiproperty._constructor_.md) + +## ApiProperty.(constructor) + +Constructs a new instance of the `ApiProperty` class + +Signature: + +```typescript +constructor(options: IApiPropertyOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiPropertyOptions | | + diff --git a/pages/api/api-extractor-model.apiproperty.buildcanonicalreference.md b/pages/api/api-extractor-model.apiproperty.buildcanonicalreference.md new file mode 100644 index 000000000..3632b1722 --- /dev/null +++ b/pages/api/api-extractor-model.apiproperty.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiProperty](./api-extractor-model.apiproperty.md) > [buildCanonicalReference](./api-extractor-model.apiproperty.buildcanonicalreference.md) + +## ApiProperty.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apiproperty.containerkey.md b/pages/api/api-extractor-model.apiproperty.containerkey.md new file mode 100644 index 000000000..7d956be18 --- /dev/null +++ b/pages/api/api-extractor-model.apiproperty.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiProperty](./api-extractor-model.apiproperty.md) > [containerKey](./api-extractor-model.apiproperty.containerkey.md) + +## ApiProperty.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apiproperty.getcontainerkey.md b/pages/api/api-extractor-model.apiproperty.getcontainerkey.md new file mode 100644 index 000000000..b1b8493c3 --- /dev/null +++ b/pages/api/api-extractor-model.apiproperty.getcontainerkey.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiProperty](./api-extractor-model.apiproperty.md) > [getContainerKey](./api-extractor-model.apiproperty.getcontainerkey.md) + +## ApiProperty.getContainerKey() method + +Signature: + +```typescript +static getContainerKey(name: string, isStatic: boolean): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| isStatic | boolean | | + +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apiproperty.kind.md b/pages/api/api-extractor-model.apiproperty.kind.md new file mode 100644 index 000000000..8b925adeb --- /dev/null +++ b/pages/api/api-extractor-model.apiproperty.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiProperty](./api-extractor-model.apiproperty.md) > [kind](./api-extractor-model.apiproperty.kind.md) + +## ApiProperty.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apiproperty.md b/pages/api/api-extractor-model.apiproperty.md new file mode 100644 index 000000000..39fe6a4c8 --- /dev/null +++ b/pages/api/api-extractor-model.apiproperty.md @@ -0,0 +1,65 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiProperty](./api-extractor-model.apiproperty.md) + +## ApiProperty class + +Represents a TypeScript property declaration that belongs to an `ApiClass`. + +Signature: + +```typescript +export declare class ApiProperty extends ApiProperty_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apiproperty._constructor_.md) | | Constructs a new instance of the ApiProperty class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apiproperty.containerkey.md) | | string | | +| [kind](./api-extractor-model.apiproperty.kind.md) | | ApiItemKind | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apiproperty.buildcanonicalreference.md) | | (BETA) | +| [getContainerKey(name, isStatic)](./api-extractor-model.apiproperty.getcontainerkey.md) | static | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiProperty` represents a TypeScript declaration such as the `width` and `height` members in this example: + +```ts +export class Widget { + public width: number = 100; + + public get height(): number { + if (this.isSquashed()) { + return 0; + } else { + return this.clientArea.height; + } + } +} + +``` +Note that member variables are also considered to be properties. + +If the property has both a getter function and setter function, they will be represented by a single `ApiProperty` and must have a single documentation comment. + +Compare with [ApiPropertySignature](./api-extractor-model.apipropertysignature.md), which represents a property belonging to an interface. For example, a class property can be `static` but an interface property cannot. + diff --git a/pages/api/api-extractor-model.apipropertyitem._constructor_.md b/pages/api/api-extractor-model.apipropertyitem._constructor_.md new file mode 100644 index 000000000..5b83be072 --- /dev/null +++ b/pages/api/api-extractor-model.apipropertyitem._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPropertyItem](./api-extractor-model.apipropertyitem.md) > [(constructor)](./api-extractor-model.apipropertyitem._constructor_.md) + +## ApiPropertyItem.(constructor) + +Constructs a new instance of the `ApiPropertyItem` class + +Signature: + +```typescript +constructor(options: IApiPropertyItemOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiPropertyItemOptions | | + diff --git a/pages/api/api-extractor-model.apipropertyitem.iseventproperty.md b/pages/api/api-extractor-model.apipropertyitem.iseventproperty.md new file mode 100644 index 000000000..05285e19b --- /dev/null +++ b/pages/api/api-extractor-model.apipropertyitem.iseventproperty.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPropertyItem](./api-extractor-model.apipropertyitem.md) > [isEventProperty](./api-extractor-model.apipropertyitem.iseventproperty.md) + +## ApiPropertyItem.isEventProperty property + +Returns true if this property should be documented as an event. + +Signature: + +```typescript +readonly isEventProperty: boolean; +``` + +## Remarks + +The `@eventProperty` TSDoc modifier can be added to readonly properties to indicate that they return an event object that event handlers can be attached to. The event-handling API is implementation-defined, but typically the return type would be a class with members such as `addHandler()` and `removeHandler()`. The documentation should display such properties under an "Events" heading instead of the usual "Properties" heading. + diff --git a/pages/api/api-extractor-model.apipropertyitem.md b/pages/api/api-extractor-model.apipropertyitem.md new file mode 100644 index 000000000..fe43ed363 --- /dev/null +++ b/pages/api/api-extractor-model.apipropertyitem.md @@ -0,0 +1,39 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPropertyItem](./api-extractor-model.apipropertyitem.md) + +## ApiPropertyItem class + +The abstract base class for [ApiProperty](./api-extractor-model.apiproperty.md) and [ApiPropertySignature](./api-extractor-model.apipropertysignature.md). + +Signature: + +```typescript +export declare class ApiPropertyItem extends ApiPropertyItem_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apipropertyitem._constructor_.md) | | Constructs a new instance of the ApiPropertyItem class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [isEventProperty](./api-extractor-model.apipropertyitem.iseventproperty.md) | | boolean | Returns true if this property should be documented as an event. | +| [propertyTypeExcerpt](./api-extractor-model.apipropertyitem.propertytypeexcerpt.md) | | Excerpt | An [Excerpt](./api-extractor-model.excerpt.md) that describes the type of the property. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [onDeserializeInto(options, context, jsonObject)](./api-extractor-model.apipropertyitem.ondeserializeinto.md) | static | | +| [serializeInto(jsonObject)](./api-extractor-model.apipropertyitem.serializeinto.md) | | | + diff --git a/pages/api/api-extractor-model.apipropertyitem.ondeserializeinto.md b/pages/api/api-extractor-model.apipropertyitem.ondeserializeinto.md new file mode 100644 index 000000000..1fe5eb6a1 --- /dev/null +++ b/pages/api/api-extractor-model.apipropertyitem.ondeserializeinto.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPropertyItem](./api-extractor-model.apipropertyitem.md) > [onDeserializeInto](./api-extractor-model.apipropertyitem.ondeserializeinto.md) + +## ApiPropertyItem.onDeserializeInto() method + + +Signature: + +```typescript +/** @override */ +static onDeserializeInto(options: Partial, context: DeserializerContext, jsonObject: IApiPropertyItemJson): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | Partial<IApiPropertyItemOptions> | | +| context | DeserializerContext | | +| jsonObject | IApiPropertyItemJson | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apipropertyitem.propertytypeexcerpt.md b/pages/api/api-extractor-model.apipropertyitem.propertytypeexcerpt.md new file mode 100644 index 000000000..917e5af72 --- /dev/null +++ b/pages/api/api-extractor-model.apipropertyitem.propertytypeexcerpt.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPropertyItem](./api-extractor-model.apipropertyitem.md) > [propertyTypeExcerpt](./api-extractor-model.apipropertyitem.propertytypeexcerpt.md) + +## ApiPropertyItem.propertyTypeExcerpt property + +An [Excerpt](./api-extractor-model.excerpt.md) that describes the type of the property. + +Signature: + +```typescript +readonly propertyTypeExcerpt: Excerpt; +``` diff --git a/pages/api/api-extractor-model.apipropertyitem.serializeinto.md b/pages/api/api-extractor-model.apipropertyitem.serializeinto.md new file mode 100644 index 000000000..4d0ae088c --- /dev/null +++ b/pages/api/api-extractor-model.apipropertyitem.serializeinto.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPropertyItem](./api-extractor-model.apipropertyitem.md) > [serializeInto](./api-extractor-model.apipropertyitem.serializeinto.md) + +## ApiPropertyItem.serializeInto() method + + +Signature: + +```typescript +/** @override */ +serializeInto(jsonObject: Partial): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Partial<IApiPropertyItemJson> | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apipropertysignature._constructor_.md b/pages/api/api-extractor-model.apipropertysignature._constructor_.md new file mode 100644 index 000000000..05d90c7b1 --- /dev/null +++ b/pages/api/api-extractor-model.apipropertysignature._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPropertySignature](./api-extractor-model.apipropertysignature.md) > [(constructor)](./api-extractor-model.apipropertysignature._constructor_.md) + +## ApiPropertySignature.(constructor) + +Constructs a new instance of the `ApiPropertySignature` class + +Signature: + +```typescript +constructor(options: IApiPropertySignatureOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiPropertySignatureOptions | | + diff --git a/pages/api/api-extractor-model.apipropertysignature.buildcanonicalreference.md b/pages/api/api-extractor-model.apipropertysignature.buildcanonicalreference.md new file mode 100644 index 000000000..086b4de47 --- /dev/null +++ b/pages/api/api-extractor-model.apipropertysignature.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPropertySignature](./api-extractor-model.apipropertysignature.md) > [buildCanonicalReference](./api-extractor-model.apipropertysignature.buildcanonicalreference.md) + +## ApiPropertySignature.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apipropertysignature.containerkey.md b/pages/api/api-extractor-model.apipropertysignature.containerkey.md new file mode 100644 index 000000000..b45987dd1 --- /dev/null +++ b/pages/api/api-extractor-model.apipropertysignature.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPropertySignature](./api-extractor-model.apipropertysignature.md) > [containerKey](./api-extractor-model.apipropertysignature.containerkey.md) + +## ApiPropertySignature.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apipropertysignature.getcontainerkey.md b/pages/api/api-extractor-model.apipropertysignature.getcontainerkey.md new file mode 100644 index 000000000..668d054e8 --- /dev/null +++ b/pages/api/api-extractor-model.apipropertysignature.getcontainerkey.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPropertySignature](./api-extractor-model.apipropertysignature.md) > [getContainerKey](./api-extractor-model.apipropertysignature.getcontainerkey.md) + +## ApiPropertySignature.getContainerKey() method + +Signature: + +```typescript +static getContainerKey(name: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apipropertysignature.kind.md b/pages/api/api-extractor-model.apipropertysignature.kind.md new file mode 100644 index 000000000..7c2ee44bd --- /dev/null +++ b/pages/api/api-extractor-model.apipropertysignature.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPropertySignature](./api-extractor-model.apipropertysignature.md) > [kind](./api-extractor-model.apipropertysignature.kind.md) + +## ApiPropertySignature.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apipropertysignature.md b/pages/api/api-extractor-model.apipropertysignature.md new file mode 100644 index 000000000..6a2968b90 --- /dev/null +++ b/pages/api/api-extractor-model.apipropertysignature.md @@ -0,0 +1,54 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiPropertySignature](./api-extractor-model.apipropertysignature.md) + +## ApiPropertySignature class + +Represents a TypeScript property declaration that belongs to an `ApiInterface`. + +Signature: + +```typescript +export declare class ApiPropertySignature extends ApiPropertyItem +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apipropertysignature._constructor_.md) | | Constructs a new instance of the ApiPropertySignature class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apipropertysignature.containerkey.md) | | string | | +| [kind](./api-extractor-model.apipropertysignature.kind.md) | | ApiItemKind | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apipropertysignature.buildcanonicalreference.md) | | (BETA) | +| [getContainerKey(name)](./api-extractor-model.apipropertysignature.getcontainerkey.md) | static | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiPropertySignature` represents a TypeScript declaration such as the `width` and `height` members in this example: + +```ts +export interface IWidget { + readonly width: number; + height: number; +} + +``` +Compare with [ApiProperty](./api-extractor-model.apiproperty.md), which represents a property belonging to a class. For example, a class property can be `static` but an interface property cannot. + diff --git a/pages/api/api-extractor-model.apireleasetagmixin.isbaseclassof.md b/pages/api/api-extractor-model.apireleasetagmixin.isbaseclassof.md new file mode 100644 index 000000000..99cf7db87 --- /dev/null +++ b/pages/api/api-extractor-model.apireleasetagmixin.isbaseclassof.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiReleaseTagMixin](./api-extractor-model.apireleasetagmixin.md) > [isBaseClassOf](./api-extractor-model.apireleasetagmixin.isbaseclassof.md) + +## ApiReleaseTagMixin.isBaseClassOf() function + +A type guard that tests whether the specified `ApiItem` subclass extends the `ApiReleaseTagMixin` mixin. + +Signature: + +```typescript +function isBaseClassOf(apiItem: ApiItem): apiItem is ApiReleaseTagMixin; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| apiItem | ApiItem | | + +Returns: + +`apiItem is ApiReleaseTagMixin` + +## Remarks + +The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of the mixin function produces a different subclass. (This could be mitigated by `Symbol.hasInstance`, however the TypeScript type system cannot invoke a runtime test.) + diff --git a/pages/api/api-extractor-model.apireleasetagmixin.md b/pages/api/api-extractor-model.apireleasetagmixin.md new file mode 100644 index 000000000..1f9944dd0 --- /dev/null +++ b/pages/api/api-extractor-model.apireleasetagmixin.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiReleaseTagMixin](./api-extractor-model.apireleasetagmixin.md) + +## ApiReleaseTagMixin namespace + +Static members for . + +Signature: + +```typescript +export declare namespace ApiReleaseTagMixin +``` + +## Functions + +| Function | Description | +| --- | --- | +| [isBaseClassOf(apiItem)](./api-extractor-model.apireleasetagmixin.isbaseclassof.md) | A type guard that tests whether the specified ApiItem subclass extends the ApiReleaseTagMixin mixin. | + diff --git a/pages/api/api-extractor-model.apireleasetagmixin.releasetag.md b/pages/api/api-extractor-model.apireleasetagmixin.releasetag.md new file mode 100644 index 000000000..2f871d34b --- /dev/null +++ b/pages/api/api-extractor-model.apireleasetagmixin.releasetag.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiReleaseTagMixin](./api-extractor-model.apireleasetagmixin.md) > [releaseTag](./api-extractor-model.apireleasetagmixin.releasetag.md) + +## ApiReleaseTagMixin.releaseTag property + +The effective release tag for this declaration. If it is not explicitly specified, the value may be inherited from a containing declaration. + +Signature: + +```typescript +readonly releaseTag: ReleaseTag; +``` + +## Remarks + +For example, an `ApiEnumMember` may inherit its release tag from the containing `ApiEnum`. + diff --git a/pages/api/api-extractor-model.apireleasetagmixin.serializeinto.md b/pages/api/api-extractor-model.apireleasetagmixin.serializeinto.md new file mode 100644 index 000000000..56827de42 --- /dev/null +++ b/pages/api/api-extractor-model.apireleasetagmixin.serializeinto.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiReleaseTagMixin](./api-extractor-model.apireleasetagmixin.md) > [serializeInto](./api-extractor-model.apireleasetagmixin.serializeinto.md) + +## ApiReleaseTagMixin.serializeInto() method + + +Signature: + +```typescript +/** @override */ +serializeInto(jsonObject: Partial): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Partial<IApiItemJson> | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apireturntypemixin.isbaseclassof.md b/pages/api/api-extractor-model.apireturntypemixin.isbaseclassof.md new file mode 100644 index 000000000..0ecc94330 --- /dev/null +++ b/pages/api/api-extractor-model.apireturntypemixin.isbaseclassof.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiReturnTypeMixin](./api-extractor-model.apireturntypemixin.md) > [isBaseClassOf](./api-extractor-model.apireturntypemixin.isbaseclassof.md) + +## ApiReturnTypeMixin.isBaseClassOf() function + +A type guard that tests whether the specified `ApiItem` subclass extends the `ApiReturnTypeMixin` mixin. + +Signature: + +```typescript +function isBaseClassOf(apiItem: ApiItem): apiItem is ApiReturnTypeMixin; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| apiItem | ApiItem | | + +Returns: + +`apiItem is ApiReturnTypeMixin` + +## Remarks + +The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of the mixin function produces a different subclass. (This could be mitigated by `Symbol.hasInstance`, however the TypeScript type system cannot invoke a runtime test.) + diff --git a/pages/api/api-extractor-model.apireturntypemixin.md b/pages/api/api-extractor-model.apireturntypemixin.md new file mode 100644 index 000000000..d18b894bd --- /dev/null +++ b/pages/api/api-extractor-model.apireturntypemixin.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiReturnTypeMixin](./api-extractor-model.apireturntypemixin.md) + +## ApiReturnTypeMixin namespace + +Static members for . + +Signature: + +```typescript +export declare namespace ApiReturnTypeMixin +``` + +## Functions + +| Function | Description | +| --- | --- | +| [isBaseClassOf(apiItem)](./api-extractor-model.apireturntypemixin.isbaseclassof.md) | A type guard that tests whether the specified ApiItem subclass extends the ApiReturnTypeMixin mixin. | + diff --git a/pages/api/api-extractor-model.apireturntypemixin.returntypeexcerpt.md b/pages/api/api-extractor-model.apireturntypemixin.returntypeexcerpt.md new file mode 100644 index 000000000..b33354d5d --- /dev/null +++ b/pages/api/api-extractor-model.apireturntypemixin.returntypeexcerpt.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiReturnTypeMixin](./api-extractor-model.apireturntypemixin.md) > [returnTypeExcerpt](./api-extractor-model.apireturntypemixin.returntypeexcerpt.md) + +## ApiReturnTypeMixin.returnTypeExcerpt property + +An [Excerpt](./api-extractor-model.excerpt.md) that describes the type of the function's return value. + +Signature: + +```typescript +readonly returnTypeExcerpt: Excerpt; +``` diff --git a/pages/api/api-extractor-model.apireturntypemixin.serializeinto.md b/pages/api/api-extractor-model.apireturntypemixin.serializeinto.md new file mode 100644 index 000000000..203239ba9 --- /dev/null +++ b/pages/api/api-extractor-model.apireturntypemixin.serializeinto.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiReturnTypeMixin](./api-extractor-model.apireturntypemixin.md) > [serializeInto](./api-extractor-model.apireturntypemixin.serializeinto.md) + +## ApiReturnTypeMixin.serializeInto() method + + +Signature: + +```typescript +/** @override */ +serializeInto(jsonObject: Partial): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Partial<IApiReturnTypeMixinJson> | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apistaticmixin.isbaseclassof.md b/pages/api/api-extractor-model.apistaticmixin.isbaseclassof.md new file mode 100644 index 000000000..b6c34a849 --- /dev/null +++ b/pages/api/api-extractor-model.apistaticmixin.isbaseclassof.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiStaticMixin](./api-extractor-model.apistaticmixin.md) > [isBaseClassOf](./api-extractor-model.apistaticmixin.isbaseclassof.md) + +## ApiStaticMixin.isBaseClassOf() function + +A type guard that tests whether the specified `ApiItem` subclass extends the `ApiStaticMixin` mixin. + +Signature: + +```typescript +function isBaseClassOf(apiItem: ApiItem): apiItem is ApiStaticMixin; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| apiItem | ApiItem | | + +Returns: + +`apiItem is ApiStaticMixin` + +## Remarks + +The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of the mixin function produces a different subclass. (This could be mitigated by `Symbol.hasInstance`, however the TypeScript type system cannot invoke a runtime test.) + diff --git a/pages/api/api-extractor-model.apistaticmixin.isstatic.md b/pages/api/api-extractor-model.apistaticmixin.isstatic.md new file mode 100644 index 000000000..5f2495528 --- /dev/null +++ b/pages/api/api-extractor-model.apistaticmixin.isstatic.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiStaticMixin](./api-extractor-model.apistaticmixin.md) > [isStatic](./api-extractor-model.apistaticmixin.isstatic.md) + +## ApiStaticMixin.isStatic property + +Whether the declaration has the TypeScript `static` keyword. + +Signature: + +```typescript +readonly isStatic: boolean; +``` diff --git a/pages/api/api-extractor-model.apistaticmixin.md b/pages/api/api-extractor-model.apistaticmixin.md new file mode 100644 index 000000000..b930784f6 --- /dev/null +++ b/pages/api/api-extractor-model.apistaticmixin.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiStaticMixin](./api-extractor-model.apistaticmixin.md) + +## ApiStaticMixin namespace + +Static members for . + +Signature: + +```typescript +export declare namespace ApiStaticMixin +``` + +## Functions + +| Function | Description | +| --- | --- | +| [isBaseClassOf(apiItem)](./api-extractor-model.apistaticmixin.isbaseclassof.md) | A type guard that tests whether the specified ApiItem subclass extends the ApiStaticMixin mixin. | + diff --git a/pages/api/api-extractor-model.apistaticmixin.serializeinto.md b/pages/api/api-extractor-model.apistaticmixin.serializeinto.md new file mode 100644 index 000000000..302c24946 --- /dev/null +++ b/pages/api/api-extractor-model.apistaticmixin.serializeinto.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiStaticMixin](./api-extractor-model.apistaticmixin.md) > [serializeInto](./api-extractor-model.apistaticmixin.serializeinto.md) + +## ApiStaticMixin.serializeInto() method + + +Signature: + +```typescript +/** @override */ +serializeInto(jsonObject: Partial): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Partial<IApiItemJson> | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apitypealias._constructor_.md b/pages/api/api-extractor-model.apitypealias._constructor_.md new file mode 100644 index 000000000..6137372bf --- /dev/null +++ b/pages/api/api-extractor-model.apitypealias._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiTypeAlias](./api-extractor-model.apitypealias.md) > [(constructor)](./api-extractor-model.apitypealias._constructor_.md) + +## ApiTypeAlias.(constructor) + +Constructs a new instance of the `ApiTypeAlias` class + +Signature: + +```typescript +constructor(options: IApiTypeAliasOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiTypeAliasOptions | | + diff --git a/pages/api/api-extractor-model.apitypealias.buildcanonicalreference.md b/pages/api/api-extractor-model.apitypealias.buildcanonicalreference.md new file mode 100644 index 000000000..388157fb3 --- /dev/null +++ b/pages/api/api-extractor-model.apitypealias.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiTypeAlias](./api-extractor-model.apitypealias.md) > [buildCanonicalReference](./api-extractor-model.apitypealias.buildcanonicalreference.md) + +## ApiTypeAlias.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apitypealias.containerkey.md b/pages/api/api-extractor-model.apitypealias.containerkey.md new file mode 100644 index 000000000..d98436fc1 --- /dev/null +++ b/pages/api/api-extractor-model.apitypealias.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiTypeAlias](./api-extractor-model.apitypealias.md) > [containerKey](./api-extractor-model.apitypealias.containerkey.md) + +## ApiTypeAlias.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apitypealias.getcontainerkey.md b/pages/api/api-extractor-model.apitypealias.getcontainerkey.md new file mode 100644 index 000000000..f51deb4cf --- /dev/null +++ b/pages/api/api-extractor-model.apitypealias.getcontainerkey.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiTypeAlias](./api-extractor-model.apitypealias.md) > [getContainerKey](./api-extractor-model.apitypealias.getcontainerkey.md) + +## ApiTypeAlias.getContainerKey() method + +Signature: + +```typescript +static getContainerKey(name: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apitypealias.kind.md b/pages/api/api-extractor-model.apitypealias.kind.md new file mode 100644 index 000000000..9c66f15e6 --- /dev/null +++ b/pages/api/api-extractor-model.apitypealias.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiTypeAlias](./api-extractor-model.apitypealias.md) > [kind](./api-extractor-model.apitypealias.kind.md) + +## ApiTypeAlias.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apitypealias.md b/pages/api/api-extractor-model.apitypealias.md new file mode 100644 index 000000000..df3d78ce6 --- /dev/null +++ b/pages/api/api-extractor-model.apitypealias.md @@ -0,0 +1,63 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiTypeAlias](./api-extractor-model.apitypealias.md) + +## ApiTypeAlias class + +Represents a TypeScript type alias declaration. + +Signature: + +```typescript +export declare class ApiTypeAlias extends ApiTypeAlias_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apitypealias._constructor_.md) | | Constructs a new instance of the ApiTypeAlias class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apitypealias.containerkey.md) | | string | | +| [kind](./api-extractor-model.apitypealias.kind.md) | | ApiItemKind | | +| [typeExcerpt](./api-extractor-model.apitypealias.typeexcerpt.md) | | Excerpt | An [Excerpt](./api-extractor-model.excerpt.md) that describes the type of the alias. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apitypealias.buildcanonicalreference.md) | | (BETA) | +| [getContainerKey(name)](./api-extractor-model.apitypealias.getcontainerkey.md) | static | | +| [onDeserializeInto(options, context, jsonObject)](./api-extractor-model.apitypealias.ondeserializeinto.md) | static | | +| [serializeInto(jsonObject)](./api-extractor-model.apitypealias.serializeinto.md) | | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiTypeAlias` represents a definition such as one of these examples: + +```ts +// A union type: +export type Shape = Square | Triangle | Circle; + +// A generic type alias: +export type BoxedValue = { value: T }; + +export type BoxedArray = { array: T[] }; + +// A conditional type alias: +export type Boxed = T extends any[] ? BoxedArray : BoxedValue; + + +``` + diff --git a/pages/api/api-extractor-model.apitypealias.ondeserializeinto.md b/pages/api/api-extractor-model.apitypealias.ondeserializeinto.md new file mode 100644 index 000000000..4a14501a4 --- /dev/null +++ b/pages/api/api-extractor-model.apitypealias.ondeserializeinto.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiTypeAlias](./api-extractor-model.apitypealias.md) > [onDeserializeInto](./api-extractor-model.apitypealias.ondeserializeinto.md) + +## ApiTypeAlias.onDeserializeInto() method + + +Signature: + +```typescript +/** @override */ +static onDeserializeInto(options: Partial, context: DeserializerContext, jsonObject: IApiTypeAliasJson): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | Partial<IApiTypeAliasOptions> | | +| context | DeserializerContext | | +| jsonObject | IApiTypeAliasJson | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apitypealias.serializeinto.md b/pages/api/api-extractor-model.apitypealias.serializeinto.md new file mode 100644 index 000000000..6db1bf8a6 --- /dev/null +++ b/pages/api/api-extractor-model.apitypealias.serializeinto.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiTypeAlias](./api-extractor-model.apitypealias.md) > [serializeInto](./api-extractor-model.apitypealias.serializeinto.md) + +## ApiTypeAlias.serializeInto() method + + +Signature: + +```typescript +/** @override */ +serializeInto(jsonObject: Partial): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Partial<IApiTypeAliasJson> | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apitypealias.typeexcerpt.md b/pages/api/api-extractor-model.apitypealias.typeexcerpt.md new file mode 100644 index 000000000..6ab106213 --- /dev/null +++ b/pages/api/api-extractor-model.apitypealias.typeexcerpt.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiTypeAlias](./api-extractor-model.apitypealias.md) > [typeExcerpt](./api-extractor-model.apitypealias.typeexcerpt.md) + +## ApiTypeAlias.typeExcerpt property + +An [Excerpt](./api-extractor-model.excerpt.md) that describes the type of the alias. + +Signature: + +```typescript +readonly typeExcerpt: Excerpt; +``` + +## Remarks + +In the example below, the `typeExcerpt` would correspond to the subexpression `T extends any[] ? BoxedArray : BoxedValue;`: + +```ts +export type Boxed = T extends any[] ? BoxedArray : BoxedValue; + +``` + diff --git a/pages/api/api-extractor-model.apitypeparameterlistmixin.isbaseclassof.md b/pages/api/api-extractor-model.apitypeparameterlistmixin.isbaseclassof.md new file mode 100644 index 000000000..57dc9c2c7 --- /dev/null +++ b/pages/api/api-extractor-model.apitypeparameterlistmixin.isbaseclassof.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiTypeParameterListMixin](./api-extractor-model.apitypeparameterlistmixin.md) > [isBaseClassOf](./api-extractor-model.apitypeparameterlistmixin.isbaseclassof.md) + +## ApiTypeParameterListMixin.isBaseClassOf() function + +A type guard that tests whether the specified `ApiItem` subclass extends the `ApiParameterListMixin` mixin. + +Signature: + +```typescript +function isBaseClassOf(apiItem: ApiItem): apiItem is ApiTypeParameterListMixin; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| apiItem | ApiItem | | + +Returns: + +`apiItem is ApiTypeParameterListMixin` + +## Remarks + +The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of the mixin function produces a different subclass. (This could be mitigated by `Symbol.hasInstance`, however the TypeScript type system cannot invoke a runtime test.) + diff --git a/pages/api/api-extractor-model.apitypeparameterlistmixin.md b/pages/api/api-extractor-model.apitypeparameterlistmixin.md new file mode 100644 index 000000000..4ed82c66a --- /dev/null +++ b/pages/api/api-extractor-model.apitypeparameterlistmixin.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiTypeParameterListMixin](./api-extractor-model.apitypeparameterlistmixin.md) + +## ApiTypeParameterListMixin namespace + +Static members for . + +Signature: + +```typescript +export declare namespace ApiTypeParameterListMixin +``` + +## Functions + +| Function | Description | +| --- | --- | +| [isBaseClassOf(apiItem)](./api-extractor-model.apitypeparameterlistmixin.isbaseclassof.md) | A type guard that tests whether the specified ApiItem subclass extends the ApiParameterListMixin mixin. | + diff --git a/pages/api/api-extractor-model.apitypeparameterlistmixin.serializeinto.md b/pages/api/api-extractor-model.apitypeparameterlistmixin.serializeinto.md new file mode 100644 index 000000000..e24e969bb --- /dev/null +++ b/pages/api/api-extractor-model.apitypeparameterlistmixin.serializeinto.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiTypeParameterListMixin](./api-extractor-model.apitypeparameterlistmixin.md) > [serializeInto](./api-extractor-model.apitypeparameterlistmixin.serializeinto.md) + +## ApiTypeParameterListMixin.serializeInto() method + +Signature: + +```typescript +serializeInto(jsonObject: Partial): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Partial<IApiItemJson> | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apitypeparameterlistmixin.typeparameters.md b/pages/api/api-extractor-model.apitypeparameterlistmixin.typeparameters.md new file mode 100644 index 000000000..ce9321e8e --- /dev/null +++ b/pages/api/api-extractor-model.apitypeparameterlistmixin.typeparameters.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiTypeParameterListMixin](./api-extractor-model.apitypeparameterlistmixin.md) > [typeParameters](./api-extractor-model.apitypeparameterlistmixin.typeparameters.md) + +## ApiTypeParameterListMixin.typeParameters property + +The type parameters. + +Signature: + +```typescript +readonly typeParameters: ReadonlyArray; +``` diff --git a/pages/api/api-extractor-model.apivariable._constructor_.md b/pages/api/api-extractor-model.apivariable._constructor_.md new file mode 100644 index 000000000..f85a0e43d --- /dev/null +++ b/pages/api/api-extractor-model.apivariable._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiVariable](./api-extractor-model.apivariable.md) > [(constructor)](./api-extractor-model.apivariable._constructor_.md) + +## ApiVariable.(constructor) + +Constructs a new instance of the `ApiVariable` class + +Signature: + +```typescript +constructor(options: IApiVariableOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IApiVariableOptions | | + diff --git a/pages/api/api-extractor-model.apivariable.buildcanonicalreference.md b/pages/api/api-extractor-model.apivariable.buildcanonicalreference.md new file mode 100644 index 000000000..dca407742 --- /dev/null +++ b/pages/api/api-extractor-model.apivariable.buildcanonicalreference.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiVariable](./api-extractor-model.apivariable.md) > [buildCanonicalReference](./api-extractor-model.apivariable.buildcanonicalreference.md) + +## ApiVariable.buildCanonicalReference() method + +> 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. +> + + +Signature: + +```typescript +/** @override */ +buildCanonicalReference(): DeclarationReference; +``` +Returns: + +`DeclarationReference` + diff --git a/pages/api/api-extractor-model.apivariable.containerkey.md b/pages/api/api-extractor-model.apivariable.containerkey.md new file mode 100644 index 000000000..78ff6c171 --- /dev/null +++ b/pages/api/api-extractor-model.apivariable.containerkey.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiVariable](./api-extractor-model.apivariable.md) > [containerKey](./api-extractor-model.apivariable.containerkey.md) + +## ApiVariable.containerKey property + + +Signature: + +```typescript +/** @override */ +readonly containerKey: string; +``` diff --git a/pages/api/api-extractor-model.apivariable.getcontainerkey.md b/pages/api/api-extractor-model.apivariable.getcontainerkey.md new file mode 100644 index 000000000..e624be905 --- /dev/null +++ b/pages/api/api-extractor-model.apivariable.getcontainerkey.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiVariable](./api-extractor-model.apivariable.md) > [getContainerKey](./api-extractor-model.apivariable.getcontainerkey.md) + +## ApiVariable.getContainerKey() method + +Signature: + +```typescript +static getContainerKey(name: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +Returns: + +`string` + diff --git a/pages/api/api-extractor-model.apivariable.kind.md b/pages/api/api-extractor-model.apivariable.kind.md new file mode 100644 index 000000000..447cbbb03 --- /dev/null +++ b/pages/api/api-extractor-model.apivariable.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiVariable](./api-extractor-model.apivariable.md) > [kind](./api-extractor-model.apivariable.kind.md) + +## ApiVariable.kind property + + +Signature: + +```typescript +/** @override */ +readonly kind: ApiItemKind; +``` diff --git a/pages/api/api-extractor-model.apivariable.md b/pages/api/api-extractor-model.apivariable.md new file mode 100644 index 000000000..d0d44084c --- /dev/null +++ b/pages/api/api-extractor-model.apivariable.md @@ -0,0 +1,57 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiVariable](./api-extractor-model.apivariable.md) + +## ApiVariable class + +Represents a TypeScript variable declaration. + +Signature: + +```typescript +export declare class ApiVariable extends ApiVariable_base +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.apivariable._constructor_.md) | | Constructs a new instance of the ApiVariable class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [containerKey](./api-extractor-model.apivariable.containerkey.md) | | string | | +| [kind](./api-extractor-model.apivariable.kind.md) | | ApiItemKind | | +| [variableTypeExcerpt](./api-extractor-model.apivariable.variabletypeexcerpt.md) | | Excerpt | An [Excerpt](./api-extractor-model.excerpt.md) that describes the type of the variable. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [buildCanonicalReference()](./api-extractor-model.apivariable.buildcanonicalreference.md) | | (BETA) | +| [getContainerKey(name)](./api-extractor-model.apivariable.getcontainerkey.md) | static | | +| [onDeserializeInto(options, context, jsonObject)](./api-extractor-model.apivariable.ondeserializeinto.md) | static | | +| [serializeInto(jsonObject)](./api-extractor-model.apivariable.serializeinto.md) | | | + +## Remarks + +This is part of the [ApiModel](./api-extractor-model.apimodel.md) hierarchy of classes, which are serializable representations of API declarations. + +`ApiVariable` represents an exported `const` or `let` object such as these examples: + +```ts +// A variable declaration +export let verboseLogging: boolean; + +// A constant variable declaration with an initializer +export const canvas: IWidget = createCanvas(); + +``` + diff --git a/pages/api/api-extractor-model.apivariable.ondeserializeinto.md b/pages/api/api-extractor-model.apivariable.ondeserializeinto.md new file mode 100644 index 000000000..2e924ffa0 --- /dev/null +++ b/pages/api/api-extractor-model.apivariable.ondeserializeinto.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiVariable](./api-extractor-model.apivariable.md) > [onDeserializeInto](./api-extractor-model.apivariable.ondeserializeinto.md) + +## ApiVariable.onDeserializeInto() method + + +Signature: + +```typescript +/** @override */ +static onDeserializeInto(options: Partial, context: DeserializerContext, jsonObject: IApiVariableJson): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | Partial<IApiVariableOptions> | | +| context | DeserializerContext | | +| jsonObject | IApiVariableJson | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apivariable.serializeinto.md b/pages/api/api-extractor-model.apivariable.serializeinto.md new file mode 100644 index 000000000..20d380b45 --- /dev/null +++ b/pages/api/api-extractor-model.apivariable.serializeinto.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiVariable](./api-extractor-model.apivariable.md) > [serializeInto](./api-extractor-model.apivariable.serializeinto.md) + +## ApiVariable.serializeInto() method + + +Signature: + +```typescript +/** @override */ +serializeInto(jsonObject: Partial): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Partial<IApiVariableJson> | | + +Returns: + +`void` + diff --git a/pages/api/api-extractor-model.apivariable.variabletypeexcerpt.md b/pages/api/api-extractor-model.apivariable.variabletypeexcerpt.md new file mode 100644 index 000000000..6c55cb5d5 --- /dev/null +++ b/pages/api/api-extractor-model.apivariable.variabletypeexcerpt.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ApiVariable](./api-extractor-model.apivariable.md) > [variableTypeExcerpt](./api-extractor-model.apivariable.variabletypeexcerpt.md) + +## ApiVariable.variableTypeExcerpt property + +An [Excerpt](./api-extractor-model.excerpt.md) that describes the type of the variable. + +Signature: + +```typescript +readonly variableTypeExcerpt: Excerpt; +``` diff --git a/pages/api/api-extractor-model.constructor.md b/pages/api/api-extractor-model.constructor.md new file mode 100644 index 000000000..f1f04c20b --- /dev/null +++ b/pages/api/api-extractor-model.constructor.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [Constructor](./api-extractor-model.constructor.md) + +## Constructor type + +This abstraction is used by the mixin pattern. It describes a class constructor. + +Signature: + +```typescript +export declare type Constructor = new (...args: any[]) => T; +``` diff --git a/pages/api/api-extractor-model.excerpt._constructor_.md b/pages/api/api-extractor-model.excerpt._constructor_.md new file mode 100644 index 000000000..8e422637d --- /dev/null +++ b/pages/api/api-extractor-model.excerpt._constructor_.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [Excerpt](./api-extractor-model.excerpt.md) > [(constructor)](./api-extractor-model.excerpt._constructor_.md) + +## Excerpt.(constructor) + +Constructs a new instance of the `Excerpt` class + +Signature: + +```typescript +constructor(tokens: ReadonlyArray, tokenRange: IExcerptTokenRange); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| tokens | ReadonlyArray<ExcerptToken> | | +| tokenRange | IExcerptTokenRange | | + diff --git a/pages/api/api-extractor-model.excerpt.isempty.md b/pages/api/api-extractor-model.excerpt.isempty.md new file mode 100644 index 000000000..9834015b0 --- /dev/null +++ b/pages/api/api-extractor-model.excerpt.isempty.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [Excerpt](./api-extractor-model.excerpt.md) > [isEmpty](./api-extractor-model.excerpt.isempty.md) + +## Excerpt.isEmpty property + +Signature: + +```typescript +readonly isEmpty: boolean; +``` diff --git a/pages/api/api-extractor-model.excerpt.md b/pages/api/api-extractor-model.excerpt.md new file mode 100644 index 000000000..4f04e5857 --- /dev/null +++ b/pages/api/api-extractor-model.excerpt.md @@ -0,0 +1,40 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [Excerpt](./api-extractor-model.excerpt.md) + +## Excerpt class + +This class is used by [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) to represent a source code excerpt containing a TypeScript declaration. + +Signature: + +```typescript +export declare class Excerpt +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(tokens, tokenRange)](./api-extractor-model.excerpt._constructor_.md) | | Constructs a new instance of the Excerpt class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [isEmpty](./api-extractor-model.excerpt.isempty.md) | | boolean | | +| [text](./api-extractor-model.excerpt.text.md) | | string | | +| [tokenRange](./api-extractor-model.excerpt.tokenrange.md) | | Readonly<IExcerptTokenRange> | | +| [tokens](./api-extractor-model.excerpt.tokens.md) | | ReadonlyArray<ExcerptToken> | | + +## Remarks + +The main excerpt is parsed into an array of tokens, and the main excerpt's token range will span all of these tokens. The declaration may also have have "captured" excerpts, which are other subranges of tokens. For example, if the main excerpt is a function declaration, it will also have a captured excerpt corresponding to the return type of the function. + +An excerpt may be empty (i.e. a token range containing zero tokens). For example, if a function's return value is not explicitly declared, then the returnTypeExcerpt will be empty. By contrast, a class constructor cannot have a return value, so ApiConstructor has no returnTypeExcerpt property at all. + diff --git a/pages/api/api-extractor-model.excerpt.text.md b/pages/api/api-extractor-model.excerpt.text.md new file mode 100644 index 000000000..6f961dd0d --- /dev/null +++ b/pages/api/api-extractor-model.excerpt.text.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [Excerpt](./api-extractor-model.excerpt.md) > [text](./api-extractor-model.excerpt.text.md) + +## Excerpt.text property + +Signature: + +```typescript +readonly text: string; +``` diff --git a/pages/api/api-extractor-model.excerpt.tokenrange.md b/pages/api/api-extractor-model.excerpt.tokenrange.md new file mode 100644 index 000000000..22d4b0caa --- /dev/null +++ b/pages/api/api-extractor-model.excerpt.tokenrange.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [Excerpt](./api-extractor-model.excerpt.md) > [tokenRange](./api-extractor-model.excerpt.tokenrange.md) + +## Excerpt.tokenRange property + +Signature: + +```typescript +readonly tokenRange: Readonly; +``` diff --git a/pages/api/api-extractor-model.excerpt.tokens.md b/pages/api/api-extractor-model.excerpt.tokens.md new file mode 100644 index 000000000..365b6cbb5 --- /dev/null +++ b/pages/api/api-extractor-model.excerpt.tokens.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [Excerpt](./api-extractor-model.excerpt.md) > [tokens](./api-extractor-model.excerpt.tokens.md) + +## Excerpt.tokens property + +Signature: + +```typescript +readonly tokens: ReadonlyArray; +``` diff --git a/pages/api/api-extractor-model.excerpttoken._constructor_.md b/pages/api/api-extractor-model.excerpttoken._constructor_.md new file mode 100644 index 000000000..3a1a748d3 --- /dev/null +++ b/pages/api/api-extractor-model.excerpttoken._constructor_.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ExcerptToken](./api-extractor-model.excerpttoken.md) > [(constructor)](./api-extractor-model.excerpttoken._constructor_.md) + +## ExcerptToken.(constructor) + +Constructs a new instance of the `ExcerptToken` class + +Signature: + +```typescript +constructor(kind: ExcerptTokenKind, text: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| kind | ExcerptTokenKind | | +| text | string | | + diff --git a/pages/api/api-extractor-model.excerpttoken.kind.md b/pages/api/api-extractor-model.excerpttoken.kind.md new file mode 100644 index 000000000..f2f6b3c6d --- /dev/null +++ b/pages/api/api-extractor-model.excerpttoken.kind.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ExcerptToken](./api-extractor-model.excerpttoken.md) > [kind](./api-extractor-model.excerpttoken.kind.md) + +## ExcerptToken.kind property + +Signature: + +```typescript +readonly kind: ExcerptTokenKind; +``` diff --git a/pages/api/api-extractor-model.excerpttoken.md b/pages/api/api-extractor-model.excerpttoken.md new file mode 100644 index 000000000..5df6aafd6 --- /dev/null +++ b/pages/api/api-extractor-model.excerpttoken.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ExcerptToken](./api-extractor-model.excerpttoken.md) + +## ExcerptToken class + + +Signature: + +```typescript +export declare class ExcerptToken +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(kind, text)](./api-extractor-model.excerpttoken._constructor_.md) | | Constructs a new instance of the ExcerptToken class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [kind](./api-extractor-model.excerpttoken.kind.md) | | ExcerptTokenKind | | +| [text](./api-extractor-model.excerpttoken.text.md) | | string | | + diff --git a/pages/api/api-extractor-model.excerpttoken.text.md b/pages/api/api-extractor-model.excerpttoken.text.md new file mode 100644 index 000000000..37b818c2a --- /dev/null +++ b/pages/api/api-extractor-model.excerpttoken.text.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ExcerptToken](./api-extractor-model.excerpttoken.md) > [text](./api-extractor-model.excerpttoken.text.md) + +## ExcerptToken.text property + +Signature: + +```typescript +readonly text: string; +``` diff --git a/pages/api/api-extractor-model.excerpttokenkind.md b/pages/api/api-extractor-model.excerpttokenkind.md new file mode 100644 index 000000000..14fb16d04 --- /dev/null +++ b/pages/api/api-extractor-model.excerpttokenkind.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ExcerptTokenKind](./api-extractor-model.excerpttokenkind.md) + +## ExcerptTokenKind enum + + +Signature: + +```typescript +export declare const enum ExcerptTokenKind +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Content | "Content" | | +| Reference | "Reference" | | + diff --git a/pages/api/api-extractor-model.heritagetype._constructor_.md b/pages/api/api-extractor-model.heritagetype._constructor_.md new file mode 100644 index 000000000..b1999c1bc --- /dev/null +++ b/pages/api/api-extractor-model.heritagetype._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [HeritageType](./api-extractor-model.heritagetype.md) > [(constructor)](./api-extractor-model.heritagetype._constructor_.md) + +## HeritageType.(constructor) + +Constructs a new instance of the `HeritageType` class + +Signature: + +```typescript +constructor(excerpt: Excerpt); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| excerpt | Excerpt | | + diff --git a/pages/api/api-extractor-model.heritagetype.excerpt.md b/pages/api/api-extractor-model.heritagetype.excerpt.md new file mode 100644 index 000000000..372ed70f3 --- /dev/null +++ b/pages/api/api-extractor-model.heritagetype.excerpt.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [HeritageType](./api-extractor-model.heritagetype.md) > [excerpt](./api-extractor-model.heritagetype.excerpt.md) + +## HeritageType.excerpt property + +An excerpt corresponding to the referenced type. + +Signature: + +```typescript +readonly excerpt: Excerpt; +``` + +## Remarks + +For example, consider this declaration: + +```ts +export class Widget extends Controls.WidgetBase implements Controls.IWidget, IDisposable { + // . . . +} + +``` +The excerpt might be `Controls.WidgetBase`, `Controls.IWidget`, or `IDisposable`. + diff --git a/pages/api/api-extractor-model.heritagetype.md b/pages/api/api-extractor-model.heritagetype.md new file mode 100644 index 000000000..b3c98f4e5 --- /dev/null +++ b/pages/api/api-extractor-model.heritagetype.md @@ -0,0 +1,43 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [HeritageType](./api-extractor-model.heritagetype.md) + +## HeritageType class + +Represents a type referenced via an "extends" or "implements" heritage clause for a TypeScript class. + +Signature: + +```typescript +export declare class HeritageType +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(excerpt)](./api-extractor-model.heritagetype._constructor_.md) | | Constructs a new instance of the HeritageType class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [excerpt](./api-extractor-model.heritagetype.excerpt.md) | | Excerpt | An excerpt corresponding to the referenced type. | + +## Remarks + +For example, consider this declaration: + +```ts +export class Widget extends Controls.WidgetBase implements Controls.IWidget, IDisposable { + // . . . +} + +``` +The heritage types are `Controls.WidgetBase`, `Controls.IWidget`, and `IDisposable`. + diff --git a/pages/api/api-extractor-model.iapicallsignatureoptions.md b/pages/api/api-extractor-model.iapicallsignatureoptions.md new file mode 100644 index 000000000..db83adc1f --- /dev/null +++ b/pages/api/api-extractor-model.iapicallsignatureoptions.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiCallSignatureOptions](./api-extractor-model.iapicallsignatureoptions.md) + +## IApiCallSignatureOptions interface + +Constructor options for [ApiCallSignature](./api-extractor-model.apicallsignature.md). + +Signature: + +```typescript +export interface IApiCallSignatureOptions extends IApiTypeParameterListMixinOptions, IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiDeclaredItemOptions +``` diff --git a/pages/api/api-extractor-model.iapiclassoptions.extendstokenrange.md b/pages/api/api-extractor-model.iapiclassoptions.extendstokenrange.md new file mode 100644 index 000000000..67786e087 --- /dev/null +++ b/pages/api/api-extractor-model.iapiclassoptions.extendstokenrange.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiClassOptions](./api-extractor-model.iapiclassoptions.md) > [extendsTokenRange](./api-extractor-model.iapiclassoptions.extendstokenrange.md) + +## IApiClassOptions.extendsTokenRange property + +Signature: + +```typescript +extendsTokenRange: IExcerptTokenRange | undefined; +``` diff --git a/pages/api/api-extractor-model.iapiclassoptions.implementstokenranges.md b/pages/api/api-extractor-model.iapiclassoptions.implementstokenranges.md new file mode 100644 index 000000000..f40be6465 --- /dev/null +++ b/pages/api/api-extractor-model.iapiclassoptions.implementstokenranges.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiClassOptions](./api-extractor-model.iapiclassoptions.md) > [implementsTokenRanges](./api-extractor-model.iapiclassoptions.implementstokenranges.md) + +## IApiClassOptions.implementsTokenRanges property + +Signature: + +```typescript +implementsTokenRanges: IExcerptTokenRange[]; +``` diff --git a/pages/api/api-extractor-model.iapiclassoptions.md b/pages/api/api-extractor-model.iapiclassoptions.md new file mode 100644 index 000000000..31ee105a5 --- /dev/null +++ b/pages/api/api-extractor-model.iapiclassoptions.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiClassOptions](./api-extractor-model.iapiclassoptions.md) + +## IApiClassOptions interface + +Constructor options for [ApiClass](./api-extractor-model.apiclass.md). + +Signature: + +```typescript +export interface IApiClassOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions, IApiTypeParameterListMixinOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [extendsTokenRange](./api-extractor-model.iapiclassoptions.extendstokenrange.md) | IExcerptTokenRange | undefined | | +| [implementsTokenRanges](./api-extractor-model.iapiclassoptions.implementstokenranges.md) | IExcerptTokenRange[] | | + diff --git a/pages/api/api-extractor-model.iapiconstructoroptions.md b/pages/api/api-extractor-model.iapiconstructoroptions.md new file mode 100644 index 000000000..29785367d --- /dev/null +++ b/pages/api/api-extractor-model.iapiconstructoroptions.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiConstructorOptions](./api-extractor-model.iapiconstructoroptions.md) + +## IApiConstructorOptions interface + +Constructor options for [ApiConstructor](./api-extractor-model.apiconstructor.md). + +Signature: + +```typescript +export interface IApiConstructorOptions extends IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions +``` diff --git a/pages/api/api-extractor-model.iapiconstructsignatureoptions.md b/pages/api/api-extractor-model.iapiconstructsignatureoptions.md new file mode 100644 index 000000000..34a91097a --- /dev/null +++ b/pages/api/api-extractor-model.iapiconstructsignatureoptions.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiConstructSignatureOptions](./api-extractor-model.iapiconstructsignatureoptions.md) + +## IApiConstructSignatureOptions interface + +Constructor options for [ApiConstructor](./api-extractor-model.apiconstructor.md). + +Signature: + +```typescript +export interface IApiConstructSignatureOptions extends IApiTypeParameterListMixinOptions, IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiDeclaredItemOptions +``` diff --git a/pages/api/api-extractor-model.iapideclareditemoptions.excerpttokens.md b/pages/api/api-extractor-model.iapideclareditemoptions.excerpttokens.md new file mode 100644 index 000000000..dd0f651a2 --- /dev/null +++ b/pages/api/api-extractor-model.iapideclareditemoptions.excerpttokens.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiDeclaredItemOptions](./api-extractor-model.iapideclareditemoptions.md) > [excerptTokens](./api-extractor-model.iapideclareditemoptions.excerpttokens.md) + +## IApiDeclaredItemOptions.excerptTokens property + +Signature: + +```typescript +excerptTokens: IExcerptToken[]; +``` diff --git a/pages/api/api-extractor-model.iapideclareditemoptions.md b/pages/api/api-extractor-model.iapideclareditemoptions.md new file mode 100644 index 000000000..c16ebffe5 --- /dev/null +++ b/pages/api/api-extractor-model.iapideclareditemoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiDeclaredItemOptions](./api-extractor-model.iapideclareditemoptions.md) + +## IApiDeclaredItemOptions interface + +Constructor options for [ApiDeclaredItem](./api-extractor-model.apideclareditem.md). + +Signature: + +```typescript +export interface IApiDeclaredItemOptions extends IApiDocumentedItemOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [excerptTokens](./api-extractor-model.iapideclareditemoptions.excerpttokens.md) | IExcerptToken[] | | + diff --git a/pages/api/api-extractor-model.iapidocumenteditemoptions.doccomment.md b/pages/api/api-extractor-model.iapidocumenteditemoptions.doccomment.md new file mode 100644 index 000000000..0e6ba7426 --- /dev/null +++ b/pages/api/api-extractor-model.iapidocumenteditemoptions.doccomment.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiDocumentedItemOptions](./api-extractor-model.iapidocumenteditemoptions.md) > [docComment](./api-extractor-model.iapidocumenteditemoptions.doccomment.md) + +## IApiDocumentedItemOptions.docComment property + +Signature: + +```typescript +docComment: tsdoc.DocComment | undefined; +``` diff --git a/pages/api/api-extractor-model.iapidocumenteditemoptions.md b/pages/api/api-extractor-model.iapidocumenteditemoptions.md new file mode 100644 index 000000000..1fec93d2b --- /dev/null +++ b/pages/api/api-extractor-model.iapidocumenteditemoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiDocumentedItemOptions](./api-extractor-model.iapidocumenteditemoptions.md) + +## IApiDocumentedItemOptions interface + +Constructor options for [ApiDocumentedItem](./api-extractor-model.apidocumenteditem.md). + +Signature: + +```typescript +export interface IApiDocumentedItemOptions extends IApiItemOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [docComment](./api-extractor-model.iapidocumenteditemoptions.doccomment.md) | tsdoc.DocComment | undefined | | + diff --git a/pages/api/api-extractor-model.iapientrypointoptions.md b/pages/api/api-extractor-model.iapientrypointoptions.md new file mode 100644 index 000000000..775e7c237 --- /dev/null +++ b/pages/api/api-extractor-model.iapientrypointoptions.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiEntryPointOptions](./api-extractor-model.iapientrypointoptions.md) + +## IApiEntryPointOptions interface + +Constructor options for [ApiEntryPoint](./api-extractor-model.apientrypoint.md). + +Signature: + +```typescript +export interface IApiEntryPointOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions +``` diff --git a/pages/api/api-extractor-model.iapienummemberoptions.initializertokenrange.md b/pages/api/api-extractor-model.iapienummemberoptions.initializertokenrange.md new file mode 100644 index 000000000..0f85fb2ae --- /dev/null +++ b/pages/api/api-extractor-model.iapienummemberoptions.initializertokenrange.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiEnumMemberOptions](./api-extractor-model.iapienummemberoptions.md) > [initializerTokenRange](./api-extractor-model.iapienummemberoptions.initializertokenrange.md) + +## IApiEnumMemberOptions.initializerTokenRange property + +Signature: + +```typescript +initializerTokenRange: IExcerptTokenRange; +``` diff --git a/pages/api/api-extractor-model.iapienummemberoptions.md b/pages/api/api-extractor-model.iapienummemberoptions.md new file mode 100644 index 000000000..c1a0160d5 --- /dev/null +++ b/pages/api/api-extractor-model.iapienummemberoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiEnumMemberOptions](./api-extractor-model.iapienummemberoptions.md) + +## IApiEnumMemberOptions interface + +Constructor options for [ApiEnumMember](./api-extractor-model.apienummember.md). + +Signature: + +```typescript +export interface IApiEnumMemberOptions extends IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [initializerTokenRange](./api-extractor-model.iapienummemberoptions.initializertokenrange.md) | IExcerptTokenRange | | + diff --git a/pages/api/api-extractor-model.iapienumoptions.md b/pages/api/api-extractor-model.iapienumoptions.md new file mode 100644 index 000000000..f1ccc528d --- /dev/null +++ b/pages/api/api-extractor-model.iapienumoptions.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiEnumOptions](./api-extractor-model.iapienumoptions.md) + +## IApiEnumOptions interface + +Constructor options for [ApiEnum](./api-extractor-model.apienum.md). + +Signature: + +```typescript +export interface IApiEnumOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions +``` diff --git a/pages/api/api-extractor-model.iapifunctionoptions.md b/pages/api/api-extractor-model.iapifunctionoptions.md new file mode 100644 index 000000000..d70b1775f --- /dev/null +++ b/pages/api/api-extractor-model.iapifunctionoptions.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiFunctionOptions](./api-extractor-model.iapifunctionoptions.md) + +## IApiFunctionOptions interface + +Constructor options for [ApiFunction](./api-extractor-model.apifunction.md). + +Signature: + +```typescript +export interface IApiFunctionOptions extends IApiNameMixinOptions, IApiTypeParameterListMixinOptions, IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiDeclaredItemOptions +``` diff --git a/pages/api/api-extractor-model.iapiindexsignatureoptions.md b/pages/api/api-extractor-model.iapiindexsignatureoptions.md new file mode 100644 index 000000000..0ba5a310a --- /dev/null +++ b/pages/api/api-extractor-model.iapiindexsignatureoptions.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiIndexSignatureOptions](./api-extractor-model.iapiindexsignatureoptions.md) + +## IApiIndexSignatureOptions interface + +Constructor options for [ApiIndexSignature](./api-extractor-model.apiindexsignature.md). + +Signature: + +```typescript +export interface IApiIndexSignatureOptions extends IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiDeclaredItemOptions +``` diff --git a/pages/api/api-extractor-model.iapiinterfaceoptions.extendstokenranges.md b/pages/api/api-extractor-model.iapiinterfaceoptions.extendstokenranges.md new file mode 100644 index 000000000..926e0622e --- /dev/null +++ b/pages/api/api-extractor-model.iapiinterfaceoptions.extendstokenranges.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiInterfaceOptions](./api-extractor-model.iapiinterfaceoptions.md) > [extendsTokenRanges](./api-extractor-model.iapiinterfaceoptions.extendstokenranges.md) + +## IApiInterfaceOptions.extendsTokenRanges property + +Signature: + +```typescript +extendsTokenRanges: IExcerptTokenRange[]; +``` diff --git a/pages/api/api-extractor-model.iapiinterfaceoptions.md b/pages/api/api-extractor-model.iapiinterfaceoptions.md new file mode 100644 index 000000000..3d3e45cb2 --- /dev/null +++ b/pages/api/api-extractor-model.iapiinterfaceoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiInterfaceOptions](./api-extractor-model.iapiinterfaceoptions.md) + +## IApiInterfaceOptions interface + +Constructor options for [ApiInterface](./api-extractor-model.apiinterface.md). + +Signature: + +```typescript +export interface IApiInterfaceOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiTypeParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [extendsTokenRanges](./api-extractor-model.iapiinterfaceoptions.extendstokenranges.md) | IExcerptTokenRange[] | | + diff --git a/pages/api/api-extractor-model.iapiitemconstructor.md b/pages/api/api-extractor-model.iapiitemconstructor.md new file mode 100644 index 000000000..d9a4f99bd --- /dev/null +++ b/pages/api/api-extractor-model.iapiitemconstructor.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiItemConstructor](./api-extractor-model.iapiitemconstructor.md) + +## IApiItemConstructor interface + +This abstraction is used by the mixin pattern. It describes a class type that inherits from [ApiItem](./api-extractor-model.apiitem.md). + +Signature: + +```typescript +export interface IApiItemConstructor extends Constructor, PropertiesOf +``` diff --git a/pages/api/api-extractor-model.iapiitemcontainermixinoptions.md b/pages/api/api-extractor-model.iapiitemcontainermixinoptions.md new file mode 100644 index 000000000..d344bf8a5 --- /dev/null +++ b/pages/api/api-extractor-model.iapiitemcontainermixinoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiItemContainerMixinOptions](./api-extractor-model.iapiitemcontainermixinoptions.md) + +## IApiItemContainerMixinOptions interface + +Constructor options for . + +Signature: + +```typescript +export interface IApiItemContainerMixinOptions extends IApiItemOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [members](./api-extractor-model.iapiitemcontainermixinoptions.members.md) | ApiItem[] | | + diff --git a/pages/api/api-extractor-model.iapiitemcontainermixinoptions.members.md b/pages/api/api-extractor-model.iapiitemcontainermixinoptions.members.md new file mode 100644 index 000000000..b26d0f182 --- /dev/null +++ b/pages/api/api-extractor-model.iapiitemcontainermixinoptions.members.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiItemContainerMixinOptions](./api-extractor-model.iapiitemcontainermixinoptions.md) > [members](./api-extractor-model.iapiitemcontainermixinoptions.members.md) + +## IApiItemContainerMixinOptions.members property + +Signature: + +```typescript +members?: ApiItem[]; +``` diff --git a/pages/api/api-extractor-model.iapiitemoptions.md b/pages/api/api-extractor-model.iapiitemoptions.md new file mode 100644 index 000000000..6bf5dba40 --- /dev/null +++ b/pages/api/api-extractor-model.iapiitemoptions.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiItemOptions](./api-extractor-model.iapiitemoptions.md) + +## IApiItemOptions interface + +Constructor options for [ApiItem](./api-extractor-model.apiitem.md). + +Signature: + +```typescript +export interface IApiItemOptions +``` diff --git a/pages/api/api-extractor-model.iapimethodoptions.md b/pages/api/api-extractor-model.iapimethodoptions.md new file mode 100644 index 000000000..04ee10c25 --- /dev/null +++ b/pages/api/api-extractor-model.iapimethodoptions.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiMethodOptions](./api-extractor-model.iapimethodoptions.md) + +## IApiMethodOptions interface + +Constructor options for [ApiMethod](./api-extractor-model.apimethod.md). + +Signature: + +```typescript +export interface IApiMethodOptions extends IApiNameMixinOptions, IApiTypeParameterListMixinOptions, IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiStaticMixinOptions, IApiDeclaredItemOptions +``` diff --git a/pages/api/api-extractor-model.iapimethodsignatureoptions.md b/pages/api/api-extractor-model.iapimethodsignatureoptions.md new file mode 100644 index 000000000..430af3650 --- /dev/null +++ b/pages/api/api-extractor-model.iapimethodsignatureoptions.md @@ -0,0 +1,17 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiMethodSignatureOptions](./api-extractor-model.iapimethodsignatureoptions.md) + +## IApiMethodSignatureOptions interface + + +Signature: + +```typescript +export interface IApiMethodSignatureOptions extends IApiNameMixinOptions, IApiTypeParameterListMixinOptions, IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiDeclaredItemOptions +``` diff --git a/pages/api/api-extractor-model.iapinamemixinoptions.md b/pages/api/api-extractor-model.iapinamemixinoptions.md new file mode 100644 index 000000000..2c5fa847b --- /dev/null +++ b/pages/api/api-extractor-model.iapinamemixinoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiNameMixinOptions](./api-extractor-model.iapinamemixinoptions.md) + +## IApiNameMixinOptions interface + +Constructor options for [IApiNameMixinOptions](./api-extractor-model.iapinamemixinoptions.md). + +Signature: + +```typescript +export interface IApiNameMixinOptions extends IApiItemOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [name](./api-extractor-model.iapinamemixinoptions.name.md) | string | | + diff --git a/pages/api/api-extractor-model.iapinamemixinoptions.name.md b/pages/api/api-extractor-model.iapinamemixinoptions.name.md new file mode 100644 index 000000000..0f75e816b --- /dev/null +++ b/pages/api/api-extractor-model.iapinamemixinoptions.name.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiNameMixinOptions](./api-extractor-model.iapinamemixinoptions.md) > [name](./api-extractor-model.iapinamemixinoptions.name.md) + +## IApiNameMixinOptions.name property + +Signature: + +```typescript +name: string; +``` diff --git a/pages/api/api-extractor-model.iapinamespaceoptions.md b/pages/api/api-extractor-model.iapinamespaceoptions.md new file mode 100644 index 000000000..faf8795a8 --- /dev/null +++ b/pages/api/api-extractor-model.iapinamespaceoptions.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiNamespaceOptions](./api-extractor-model.iapinamespaceoptions.md) + +## IApiNamespaceOptions interface + +Constructor options for [ApiClass](./api-extractor-model.apiclass.md). + +Signature: + +```typescript +export interface IApiNamespaceOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions +``` diff --git a/pages/api/api-extractor-model.iapipackageoptions.md b/pages/api/api-extractor-model.iapipackageoptions.md new file mode 100644 index 000000000..d14dab2eb --- /dev/null +++ b/pages/api/api-extractor-model.iapipackageoptions.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiPackageOptions](./api-extractor-model.iapipackageoptions.md) + +## IApiPackageOptions interface + +Constructor options for [ApiPackage](./api-extractor-model.apipackage.md). + +Signature: + +```typescript +export interface IApiPackageOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions, IApiDocumentedItemOptions +``` diff --git a/pages/api/api-extractor-model.iapipackagesaveoptions.md b/pages/api/api-extractor-model.iapipackagesaveoptions.md new file mode 100644 index 000000000..8f4370068 --- /dev/null +++ b/pages/api/api-extractor-model.iapipackagesaveoptions.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiPackageSaveOptions](./api-extractor-model.iapipackagesaveoptions.md) + +## IApiPackageSaveOptions interface + +Options for [ApiPackage.saveToJsonFile()](./api-extractor-model.apipackage.savetojsonfile.md). + +Signature: + +```typescript +export interface IApiPackageSaveOptions extends IJsonFileSaveOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [testMode](./api-extractor-model.iapipackagesaveoptions.testmode.md) | boolean | Set to true only when invoking API Extractor's test harness. | +| [toolPackage](./api-extractor-model.iapipackagesaveoptions.toolpackage.md) | string | Optionally specifies a value for the "toolPackage" field in the output .api.json data file; otherwise, the value will be "api-extractor-model". | +| [toolVersion](./api-extractor-model.iapipackagesaveoptions.toolversion.md) | string | Optionally specifies a value for the "toolVersion" field in the output .api.json data file; otherwise, the value will be the current version of the api-extractor-model package. | + diff --git a/pages/api/api-extractor-model.iapipackagesaveoptions.testmode.md b/pages/api/api-extractor-model.iapipackagesaveoptions.testmode.md new file mode 100644 index 000000000..18c6b0b85 --- /dev/null +++ b/pages/api/api-extractor-model.iapipackagesaveoptions.testmode.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiPackageSaveOptions](./api-extractor-model.iapipackagesaveoptions.md) > [testMode](./api-extractor-model.iapipackagesaveoptions.testmode.md) + +## IApiPackageSaveOptions.testMode property + +Set to true only when invoking API Extractor's test harness. + +Signature: + +```typescript +testMode?: boolean; +``` + +## Remarks + +When `testMode` is true, the `toolVersion` field in the .api.json file is assigned an empty string to prevent spurious diffs in output files tracked for tests. + diff --git a/pages/api/api-extractor-model.iapipackagesaveoptions.toolpackage.md b/pages/api/api-extractor-model.iapipackagesaveoptions.toolpackage.md new file mode 100644 index 000000000..38c31050d --- /dev/null +++ b/pages/api/api-extractor-model.iapipackagesaveoptions.toolpackage.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiPackageSaveOptions](./api-extractor-model.iapipackagesaveoptions.md) > [toolPackage](./api-extractor-model.iapipackagesaveoptions.toolpackage.md) + +## IApiPackageSaveOptions.toolPackage property + +Optionally specifies a value for the "toolPackage" field in the output .api.json data file; otherwise, the value will be "api-extractor-model". + +Signature: + +```typescript +toolPackage?: string; +``` diff --git a/pages/api/api-extractor-model.iapipackagesaveoptions.toolversion.md b/pages/api/api-extractor-model.iapipackagesaveoptions.toolversion.md new file mode 100644 index 000000000..d223cf342 --- /dev/null +++ b/pages/api/api-extractor-model.iapipackagesaveoptions.toolversion.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiPackageSaveOptions](./api-extractor-model.iapipackagesaveoptions.md) > [toolVersion](./api-extractor-model.iapipackagesaveoptions.toolversion.md) + +## IApiPackageSaveOptions.toolVersion property + +Optionally specifies a value for the "toolVersion" field in the output .api.json data file; otherwise, the value will be the current version of the api-extractor-model package. + +Signature: + +```typescript +toolVersion?: string; +``` diff --git a/pages/api/api-extractor-model.iapiparameterlistmixinoptions.md b/pages/api/api-extractor-model.iapiparameterlistmixinoptions.md new file mode 100644 index 000000000..2e46d0811 --- /dev/null +++ b/pages/api/api-extractor-model.iapiparameterlistmixinoptions.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiParameterListMixinOptions](./api-extractor-model.iapiparameterlistmixinoptions.md) + +## IApiParameterListMixinOptions interface + +Constructor options for . + +Signature: + +```typescript +export interface IApiParameterListMixinOptions extends IApiItemOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [overloadIndex](./api-extractor-model.iapiparameterlistmixinoptions.overloadindex.md) | number | | +| [parameters](./api-extractor-model.iapiparameterlistmixinoptions.parameters.md) | IApiParameterOptions[] | | + diff --git a/pages/api/api-extractor-model.iapiparameterlistmixinoptions.overloadindex.md b/pages/api/api-extractor-model.iapiparameterlistmixinoptions.overloadindex.md new file mode 100644 index 000000000..d4a172112 --- /dev/null +++ b/pages/api/api-extractor-model.iapiparameterlistmixinoptions.overloadindex.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiParameterListMixinOptions](./api-extractor-model.iapiparameterlistmixinoptions.md) > [overloadIndex](./api-extractor-model.iapiparameterlistmixinoptions.overloadindex.md) + +## IApiParameterListMixinOptions.overloadIndex property + +Signature: + +```typescript +overloadIndex: number; +``` diff --git a/pages/api/api-extractor-model.iapiparameterlistmixinoptions.parameters.md b/pages/api/api-extractor-model.iapiparameterlistmixinoptions.parameters.md new file mode 100644 index 000000000..7831fbe04 --- /dev/null +++ b/pages/api/api-extractor-model.iapiparameterlistmixinoptions.parameters.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiParameterListMixinOptions](./api-extractor-model.iapiparameterlistmixinoptions.md) > [parameters](./api-extractor-model.iapiparameterlistmixinoptions.parameters.md) + +## IApiParameterListMixinOptions.parameters property + +Signature: + +```typescript +parameters: IApiParameterOptions[]; +``` diff --git a/pages/api/api-extractor-model.iapiparameteroptions.md b/pages/api/api-extractor-model.iapiparameteroptions.md new file mode 100644 index 000000000..d6e583b91 --- /dev/null +++ b/pages/api/api-extractor-model.iapiparameteroptions.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiParameterOptions](./api-extractor-model.iapiparameteroptions.md) + +## IApiParameterOptions interface + +Represents parameter information that is part of [IApiParameterListMixinOptions](./api-extractor-model.iapiparameterlistmixinoptions.md) + +Signature: + +```typescript +export interface IApiParameterOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [parameterName](./api-extractor-model.iapiparameteroptions.parametername.md) | string | | +| [parameterTypeTokenRange](./api-extractor-model.iapiparameteroptions.parametertypetokenrange.md) | IExcerptTokenRange | | + diff --git a/pages/api/api-extractor-model.iapiparameteroptions.parametername.md b/pages/api/api-extractor-model.iapiparameteroptions.parametername.md new file mode 100644 index 000000000..4f6d57660 --- /dev/null +++ b/pages/api/api-extractor-model.iapiparameteroptions.parametername.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiParameterOptions](./api-extractor-model.iapiparameteroptions.md) > [parameterName](./api-extractor-model.iapiparameteroptions.parametername.md) + +## IApiParameterOptions.parameterName property + +Signature: + +```typescript +parameterName: string; +``` diff --git a/pages/api/api-extractor-model.iapiparameteroptions.parametertypetokenrange.md b/pages/api/api-extractor-model.iapiparameteroptions.parametertypetokenrange.md new file mode 100644 index 000000000..33a0dbda3 --- /dev/null +++ b/pages/api/api-extractor-model.iapiparameteroptions.parametertypetokenrange.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiParameterOptions](./api-extractor-model.iapiparameteroptions.md) > [parameterTypeTokenRange](./api-extractor-model.iapiparameteroptions.parametertypetokenrange.md) + +## IApiParameterOptions.parameterTypeTokenRange property + +Signature: + +```typescript +parameterTypeTokenRange: IExcerptTokenRange; +``` diff --git a/pages/api/api-extractor-model.iapipropertyitemoptions.md b/pages/api/api-extractor-model.iapipropertyitemoptions.md new file mode 100644 index 000000000..1e19d94bb --- /dev/null +++ b/pages/api/api-extractor-model.iapipropertyitemoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiPropertyItemOptions](./api-extractor-model.iapipropertyitemoptions.md) + +## IApiPropertyItemOptions interface + +Constructor options for [ApiPropertyItem](./api-extractor-model.apipropertyitem.md). + +Signature: + +```typescript +export interface IApiPropertyItemOptions extends IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [propertyTypeTokenRange](./api-extractor-model.iapipropertyitemoptions.propertytypetokenrange.md) | IExcerptTokenRange | | + diff --git a/pages/api/api-extractor-model.iapipropertyitemoptions.propertytypetokenrange.md b/pages/api/api-extractor-model.iapipropertyitemoptions.propertytypetokenrange.md new file mode 100644 index 000000000..286503461 --- /dev/null +++ b/pages/api/api-extractor-model.iapipropertyitemoptions.propertytypetokenrange.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiPropertyItemOptions](./api-extractor-model.iapipropertyitemoptions.md) > [propertyTypeTokenRange](./api-extractor-model.iapipropertyitemoptions.propertytypetokenrange.md) + +## IApiPropertyItemOptions.propertyTypeTokenRange property + +Signature: + +```typescript +propertyTypeTokenRange: IExcerptTokenRange; +``` diff --git a/pages/api/api-extractor-model.iapipropertyoptions.md b/pages/api/api-extractor-model.iapipropertyoptions.md new file mode 100644 index 000000000..57593be4c --- /dev/null +++ b/pages/api/api-extractor-model.iapipropertyoptions.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiPropertyOptions](./api-extractor-model.iapipropertyoptions.md) + +## IApiPropertyOptions interface + +Constructor options for [ApiProperty](./api-extractor-model.apiproperty.md). + +Signature: + +```typescript +export interface IApiPropertyOptions extends IApiPropertyItemOptions, IApiStaticMixinOptions +``` diff --git a/pages/api/api-extractor-model.iapipropertysignatureoptions.md b/pages/api/api-extractor-model.iapipropertysignatureoptions.md new file mode 100644 index 000000000..1fea8fffe --- /dev/null +++ b/pages/api/api-extractor-model.iapipropertysignatureoptions.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiPropertySignatureOptions](./api-extractor-model.iapipropertysignatureoptions.md) + +## IApiPropertySignatureOptions interface + +Constructor options for [ApiPropertySignature](./api-extractor-model.apipropertysignature.md). + +Signature: + +```typescript +export interface IApiPropertySignatureOptions extends IApiPropertyItemOptions +``` diff --git a/pages/api/api-extractor-model.iapireleasetagmixinoptions.md b/pages/api/api-extractor-model.iapireleasetagmixinoptions.md new file mode 100644 index 000000000..a5783fd2f --- /dev/null +++ b/pages/api/api-extractor-model.iapireleasetagmixinoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiReleaseTagMixinOptions](./api-extractor-model.iapireleasetagmixinoptions.md) + +## IApiReleaseTagMixinOptions interface + +Constructor options for . + +Signature: + +```typescript +export interface IApiReleaseTagMixinOptions extends IApiItemOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [releaseTag](./api-extractor-model.iapireleasetagmixinoptions.releasetag.md) | ReleaseTag | | + diff --git a/pages/api/api-extractor-model.iapireleasetagmixinoptions.releasetag.md b/pages/api/api-extractor-model.iapireleasetagmixinoptions.releasetag.md new file mode 100644 index 000000000..40215bf78 --- /dev/null +++ b/pages/api/api-extractor-model.iapireleasetagmixinoptions.releasetag.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiReleaseTagMixinOptions](./api-extractor-model.iapireleasetagmixinoptions.md) > [releaseTag](./api-extractor-model.iapireleasetagmixinoptions.releasetag.md) + +## IApiReleaseTagMixinOptions.releaseTag property + +Signature: + +```typescript +releaseTag: ReleaseTag; +``` diff --git a/pages/api/api-extractor-model.iapireturntypemixinoptions.md b/pages/api/api-extractor-model.iapireturntypemixinoptions.md new file mode 100644 index 000000000..bb51d2474 --- /dev/null +++ b/pages/api/api-extractor-model.iapireturntypemixinoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiReturnTypeMixinOptions](./api-extractor-model.iapireturntypemixinoptions.md) + +## IApiReturnTypeMixinOptions interface + +Constructor options for . + +Signature: + +```typescript +export interface IApiReturnTypeMixinOptions extends IApiItemOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [returnTypeTokenRange](./api-extractor-model.iapireturntypemixinoptions.returntypetokenrange.md) | IExcerptTokenRange | | + diff --git a/pages/api/api-extractor-model.iapireturntypemixinoptions.returntypetokenrange.md b/pages/api/api-extractor-model.iapireturntypemixinoptions.returntypetokenrange.md new file mode 100644 index 000000000..855af22c2 --- /dev/null +++ b/pages/api/api-extractor-model.iapireturntypemixinoptions.returntypetokenrange.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiReturnTypeMixinOptions](./api-extractor-model.iapireturntypemixinoptions.md) > [returnTypeTokenRange](./api-extractor-model.iapireturntypemixinoptions.returntypetokenrange.md) + +## IApiReturnTypeMixinOptions.returnTypeTokenRange property + +Signature: + +```typescript +returnTypeTokenRange: IExcerptTokenRange; +``` diff --git a/pages/api/api-extractor-model.iapistaticmixinoptions.isstatic.md b/pages/api/api-extractor-model.iapistaticmixinoptions.isstatic.md new file mode 100644 index 000000000..8b5ff268f --- /dev/null +++ b/pages/api/api-extractor-model.iapistaticmixinoptions.isstatic.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiStaticMixinOptions](./api-extractor-model.iapistaticmixinoptions.md) > [isStatic](./api-extractor-model.iapistaticmixinoptions.isstatic.md) + +## IApiStaticMixinOptions.isStatic property + +Signature: + +```typescript +isStatic: boolean; +``` diff --git a/pages/api/api-extractor-model.iapistaticmixinoptions.md b/pages/api/api-extractor-model.iapistaticmixinoptions.md new file mode 100644 index 000000000..631b8a96c --- /dev/null +++ b/pages/api/api-extractor-model.iapistaticmixinoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiStaticMixinOptions](./api-extractor-model.iapistaticmixinoptions.md) + +## IApiStaticMixinOptions interface + +Constructor options for [IApiStaticMixinOptions](./api-extractor-model.iapistaticmixinoptions.md). + +Signature: + +```typescript +export interface IApiStaticMixinOptions extends IApiItemOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [isStatic](./api-extractor-model.iapistaticmixinoptions.isstatic.md) | boolean | | + diff --git a/pages/api/api-extractor-model.iapitypealiasoptions.md b/pages/api/api-extractor-model.iapitypealiasoptions.md new file mode 100644 index 000000000..74e367915 --- /dev/null +++ b/pages/api/api-extractor-model.iapitypealiasoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiTypeAliasOptions](./api-extractor-model.iapitypealiasoptions.md) + +## IApiTypeAliasOptions interface + +Constructor options for [ApiTypeAlias](./api-extractor-model.apitypealias.md). + +Signature: + +```typescript +export interface IApiTypeAliasOptions extends IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions, IApiTypeParameterListMixinOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [typeTokenRange](./api-extractor-model.iapitypealiasoptions.typetokenrange.md) | IExcerptTokenRange | | + diff --git a/pages/api/api-extractor-model.iapitypealiasoptions.typetokenrange.md b/pages/api/api-extractor-model.iapitypealiasoptions.typetokenrange.md new file mode 100644 index 000000000..5548dc73c --- /dev/null +++ b/pages/api/api-extractor-model.iapitypealiasoptions.typetokenrange.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiTypeAliasOptions](./api-extractor-model.iapitypealiasoptions.md) > [typeTokenRange](./api-extractor-model.iapitypealiasoptions.typetokenrange.md) + +## IApiTypeAliasOptions.typeTokenRange property + +Signature: + +```typescript +typeTokenRange: IExcerptTokenRange; +``` diff --git a/pages/api/api-extractor-model.iapitypeparameterlistmixinoptions.md b/pages/api/api-extractor-model.iapitypeparameterlistmixinoptions.md new file mode 100644 index 000000000..2e4d40530 --- /dev/null +++ b/pages/api/api-extractor-model.iapitypeparameterlistmixinoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiTypeParameterListMixinOptions](./api-extractor-model.iapitypeparameterlistmixinoptions.md) + +## IApiTypeParameterListMixinOptions interface + +Constructor options for . + +Signature: + +```typescript +export interface IApiTypeParameterListMixinOptions extends IApiItemOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [typeParameters](./api-extractor-model.iapitypeparameterlistmixinoptions.typeparameters.md) | IApiTypeParameterOptions[] | | + diff --git a/pages/api/api-extractor-model.iapitypeparameterlistmixinoptions.typeparameters.md b/pages/api/api-extractor-model.iapitypeparameterlistmixinoptions.typeparameters.md new file mode 100644 index 000000000..0bef90f61 --- /dev/null +++ b/pages/api/api-extractor-model.iapitypeparameterlistmixinoptions.typeparameters.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiTypeParameterListMixinOptions](./api-extractor-model.iapitypeparameterlistmixinoptions.md) > [typeParameters](./api-extractor-model.iapitypeparameterlistmixinoptions.typeparameters.md) + +## IApiTypeParameterListMixinOptions.typeParameters property + +Signature: + +```typescript +typeParameters: IApiTypeParameterOptions[]; +``` diff --git a/pages/api/api-extractor-model.iapitypeparameteroptions.constrainttokenrange.md b/pages/api/api-extractor-model.iapitypeparameteroptions.constrainttokenrange.md new file mode 100644 index 000000000..2ba02c60e --- /dev/null +++ b/pages/api/api-extractor-model.iapitypeparameteroptions.constrainttokenrange.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiTypeParameterOptions](./api-extractor-model.iapitypeparameteroptions.md) > [constraintTokenRange](./api-extractor-model.iapitypeparameteroptions.constrainttokenrange.md) + +## IApiTypeParameterOptions.constraintTokenRange property + +Signature: + +```typescript +constraintTokenRange: IExcerptTokenRange; +``` diff --git a/pages/api/api-extractor-model.iapitypeparameteroptions.defaulttypetokenrange.md b/pages/api/api-extractor-model.iapitypeparameteroptions.defaulttypetokenrange.md new file mode 100644 index 000000000..84e15b133 --- /dev/null +++ b/pages/api/api-extractor-model.iapitypeparameteroptions.defaulttypetokenrange.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiTypeParameterOptions](./api-extractor-model.iapitypeparameteroptions.md) > [defaultTypeTokenRange](./api-extractor-model.iapitypeparameteroptions.defaulttypetokenrange.md) + +## IApiTypeParameterOptions.defaultTypeTokenRange property + +Signature: + +```typescript +defaultTypeTokenRange: IExcerptTokenRange; +``` diff --git a/pages/api/api-extractor-model.iapitypeparameteroptions.md b/pages/api/api-extractor-model.iapitypeparameteroptions.md new file mode 100644 index 000000000..67d276c87 --- /dev/null +++ b/pages/api/api-extractor-model.iapitypeparameteroptions.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiTypeParameterOptions](./api-extractor-model.iapitypeparameteroptions.md) + +## IApiTypeParameterOptions interface + +Represents parameter information that is part of [IApiTypeParameterListMixinOptions](./api-extractor-model.iapitypeparameterlistmixinoptions.md) + +Signature: + +```typescript +export interface IApiTypeParameterOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [constraintTokenRange](./api-extractor-model.iapitypeparameteroptions.constrainttokenrange.md) | IExcerptTokenRange | | +| [defaultTypeTokenRange](./api-extractor-model.iapitypeparameteroptions.defaulttypetokenrange.md) | IExcerptTokenRange | | +| [typeParameterName](./api-extractor-model.iapitypeparameteroptions.typeparametername.md) | string | | + diff --git a/pages/api/api-extractor-model.iapitypeparameteroptions.typeparametername.md b/pages/api/api-extractor-model.iapitypeparameteroptions.typeparametername.md new file mode 100644 index 000000000..810d87c47 --- /dev/null +++ b/pages/api/api-extractor-model.iapitypeparameteroptions.typeparametername.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiTypeParameterOptions](./api-extractor-model.iapitypeparameteroptions.md) > [typeParameterName](./api-extractor-model.iapitypeparameteroptions.typeparametername.md) + +## IApiTypeParameterOptions.typeParameterName property + +Signature: + +```typescript +typeParameterName: string; +``` diff --git a/pages/api/api-extractor-model.iapivariableoptions.md b/pages/api/api-extractor-model.iapivariableoptions.md new file mode 100644 index 000000000..7fbbf1883 --- /dev/null +++ b/pages/api/api-extractor-model.iapivariableoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiVariableOptions](./api-extractor-model.iapivariableoptions.md) + +## IApiVariableOptions interface + +Constructor options for [ApiVariable](./api-extractor-model.apivariable.md). + +Signature: + +```typescript +export interface IApiVariableOptions extends IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [variableTypeTokenRange](./api-extractor-model.iapivariableoptions.variabletypetokenrange.md) | IExcerptTokenRange | | + diff --git a/pages/api/api-extractor-model.iapivariableoptions.variabletypetokenrange.md b/pages/api/api-extractor-model.iapivariableoptions.variabletypetokenrange.md new file mode 100644 index 000000000..7d0dc0a2d --- /dev/null +++ b/pages/api/api-extractor-model.iapivariableoptions.variabletypetokenrange.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IApiVariableOptions](./api-extractor-model.iapivariableoptions.md) > [variableTypeTokenRange](./api-extractor-model.iapivariableoptions.variabletypetokenrange.md) + +## IApiVariableOptions.variableTypeTokenRange property + +Signature: + +```typescript +variableTypeTokenRange: IExcerptTokenRange; +``` diff --git a/pages/api/api-extractor-model.iexcerpttoken.kind.md b/pages/api/api-extractor-model.iexcerpttoken.kind.md new file mode 100644 index 000000000..e09fee8ec --- /dev/null +++ b/pages/api/api-extractor-model.iexcerpttoken.kind.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IExcerptToken](./api-extractor-model.iexcerpttoken.md) > [kind](./api-extractor-model.iexcerpttoken.kind.md) + +## IExcerptToken.kind property + +Signature: + +```typescript +readonly kind: ExcerptTokenKind; +``` diff --git a/pages/api/api-extractor-model.iexcerpttoken.md b/pages/api/api-extractor-model.iexcerpttoken.md new file mode 100644 index 000000000..de610875f --- /dev/null +++ b/pages/api/api-extractor-model.iexcerpttoken.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IExcerptToken](./api-extractor-model.iexcerpttoken.md) + +## IExcerptToken interface + + +Signature: + +```typescript +export interface IExcerptToken +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [kind](./api-extractor-model.iexcerpttoken.kind.md) | ExcerptTokenKind | | +| [text](./api-extractor-model.iexcerpttoken.text.md) | string | | + diff --git a/pages/api/api-extractor-model.iexcerpttoken.text.md b/pages/api/api-extractor-model.iexcerpttoken.text.md new file mode 100644 index 000000000..e8e8d4c8f --- /dev/null +++ b/pages/api/api-extractor-model.iexcerpttoken.text.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IExcerptToken](./api-extractor-model.iexcerpttoken.md) > [text](./api-extractor-model.iexcerpttoken.text.md) + +## IExcerptToken.text property + +Signature: + +```typescript +text: string; +``` diff --git a/pages/api/api-extractor-model.iexcerpttokenrange.endindex.md b/pages/api/api-extractor-model.iexcerpttokenrange.endindex.md new file mode 100644 index 000000000..bc9d06eda --- /dev/null +++ b/pages/api/api-extractor-model.iexcerpttokenrange.endindex.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IExcerptTokenRange](./api-extractor-model.iexcerpttokenrange.md) > [endIndex](./api-extractor-model.iexcerpttokenrange.endindex.md) + +## IExcerptTokenRange.endIndex property + +Signature: + +```typescript +endIndex: number; +``` diff --git a/pages/api/api-extractor-model.iexcerpttokenrange.md b/pages/api/api-extractor-model.iexcerpttokenrange.md new file mode 100644 index 000000000..0ab2724db --- /dev/null +++ b/pages/api/api-extractor-model.iexcerpttokenrange.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IExcerptTokenRange](./api-extractor-model.iexcerpttokenrange.md) + +## IExcerptTokenRange interface + + +Signature: + +```typescript +export interface IExcerptTokenRange +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [endIndex](./api-extractor-model.iexcerpttokenrange.endindex.md) | number | | +| [startIndex](./api-extractor-model.iexcerpttokenrange.startindex.md) | number | | + diff --git a/pages/api/api-extractor-model.iexcerpttokenrange.startindex.md b/pages/api/api-extractor-model.iexcerpttokenrange.startindex.md new file mode 100644 index 000000000..8d99cd5fb --- /dev/null +++ b/pages/api/api-extractor-model.iexcerpttokenrange.startindex.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IExcerptTokenRange](./api-extractor-model.iexcerpttokenrange.md) > [startIndex](./api-extractor-model.iexcerpttokenrange.startindex.md) + +## IExcerptTokenRange.startIndex property + +Signature: + +```typescript +startIndex: number; +``` diff --git a/pages/api/api-extractor-model.iparameteroptions.md b/pages/api/api-extractor-model.iparameteroptions.md new file mode 100644 index 000000000..75a48ced6 --- /dev/null +++ b/pages/api/api-extractor-model.iparameteroptions.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IParameterOptions](./api-extractor-model.iparameteroptions.md) + +## IParameterOptions interface + +Constructor options for [Parameter](./api-extractor-model.parameter.md). + +Signature: + +```typescript +export interface IParameterOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [name](./api-extractor-model.iparameteroptions.name.md) | string | | +| [parameterTypeExcerpt](./api-extractor-model.iparameteroptions.parametertypeexcerpt.md) | Excerpt | | +| [parent](./api-extractor-model.iparameteroptions.parent.md) | ApiParameterListMixin | | + diff --git a/pages/api/api-extractor-model.iparameteroptions.name.md b/pages/api/api-extractor-model.iparameteroptions.name.md new file mode 100644 index 000000000..4cf9bd98e --- /dev/null +++ b/pages/api/api-extractor-model.iparameteroptions.name.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IParameterOptions](./api-extractor-model.iparameteroptions.md) > [name](./api-extractor-model.iparameteroptions.name.md) + +## IParameterOptions.name property + +Signature: + +```typescript +name: string; +``` diff --git a/pages/api/api-extractor-model.iparameteroptions.parametertypeexcerpt.md b/pages/api/api-extractor-model.iparameteroptions.parametertypeexcerpt.md new file mode 100644 index 000000000..b3f205e12 --- /dev/null +++ b/pages/api/api-extractor-model.iparameteroptions.parametertypeexcerpt.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IParameterOptions](./api-extractor-model.iparameteroptions.md) > [parameterTypeExcerpt](./api-extractor-model.iparameteroptions.parametertypeexcerpt.md) + +## IParameterOptions.parameterTypeExcerpt property + +Signature: + +```typescript +parameterTypeExcerpt: Excerpt; +``` diff --git a/pages/api/api-extractor-model.iparameteroptions.parent.md b/pages/api/api-extractor-model.iparameteroptions.parent.md new file mode 100644 index 000000000..16f3867fb --- /dev/null +++ b/pages/api/api-extractor-model.iparameteroptions.parent.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IParameterOptions](./api-extractor-model.iparameteroptions.md) > [parent](./api-extractor-model.iparameteroptions.parent.md) + +## IParameterOptions.parent property + +Signature: + +```typescript +parent: ApiParameterListMixin; +``` diff --git a/pages/api/api-extractor-model.iresolvedeclarationreferenceresult.errormessage.md b/pages/api/api-extractor-model.iresolvedeclarationreferenceresult.errormessage.md new file mode 100644 index 000000000..e9bf37ab8 --- /dev/null +++ b/pages/api/api-extractor-model.iresolvedeclarationreferenceresult.errormessage.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IResolveDeclarationReferenceResult](./api-extractor-model.iresolvedeclarationreferenceresult.md) > [errorMessage](./api-extractor-model.iresolvedeclarationreferenceresult.errormessage.md) + +## IResolveDeclarationReferenceResult.errorMessage property + +If resolvedApiItem is undefined, then this will always contain an error message explaining why the resolution failed. + +Signature: + +```typescript +errorMessage: string | undefined; +``` diff --git a/pages/api/api-extractor-model.iresolvedeclarationreferenceresult.md b/pages/api/api-extractor-model.iresolvedeclarationreferenceresult.md new file mode 100644 index 000000000..04135523e --- /dev/null +++ b/pages/api/api-extractor-model.iresolvedeclarationreferenceresult.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IResolveDeclarationReferenceResult](./api-extractor-model.iresolvedeclarationreferenceresult.md) + +## IResolveDeclarationReferenceResult interface + +Result object for [ApiModel.resolveDeclarationReference()](./api-extractor-model.apimodel.resolvedeclarationreference.md). + +Signature: + +```typescript +export interface IResolveDeclarationReferenceResult +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [errorMessage](./api-extractor-model.iresolvedeclarationreferenceresult.errormessage.md) | string | undefined | If resolvedApiItem is undefined, then this will always contain an error message explaining why the resolution failed. | +| [resolvedApiItem](./api-extractor-model.iresolvedeclarationreferenceresult.resolvedapiitem.md) | ApiItem | undefined | The referenced ApiItem, if the declaration reference could be resolved. | + diff --git a/pages/api/api-extractor-model.iresolvedeclarationreferenceresult.resolvedapiitem.md b/pages/api/api-extractor-model.iresolvedeclarationreferenceresult.resolvedapiitem.md new file mode 100644 index 000000000..fb42f5181 --- /dev/null +++ b/pages/api/api-extractor-model.iresolvedeclarationreferenceresult.resolvedapiitem.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [IResolveDeclarationReferenceResult](./api-extractor-model.iresolvedeclarationreferenceresult.md) > [resolvedApiItem](./api-extractor-model.iresolvedeclarationreferenceresult.resolvedapiitem.md) + +## IResolveDeclarationReferenceResult.resolvedApiItem property + +The referenced ApiItem, if the declaration reference could be resolved. + +Signature: + +```typescript +resolvedApiItem: ApiItem | undefined; +``` diff --git a/pages/api/api-extractor-model.itypeparameteroptions.constraintexcerpt.md b/pages/api/api-extractor-model.itypeparameteroptions.constraintexcerpt.md new file mode 100644 index 000000000..63af83813 --- /dev/null +++ b/pages/api/api-extractor-model.itypeparameteroptions.constraintexcerpt.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ITypeParameterOptions](./api-extractor-model.itypeparameteroptions.md) > [constraintExcerpt](./api-extractor-model.itypeparameteroptions.constraintexcerpt.md) + +## ITypeParameterOptions.constraintExcerpt property + +Signature: + +```typescript +constraintExcerpt: Excerpt; +``` diff --git a/pages/api/api-extractor-model.itypeparameteroptions.defaulttypeexcerpt.md b/pages/api/api-extractor-model.itypeparameteroptions.defaulttypeexcerpt.md new file mode 100644 index 000000000..3cd8863af --- /dev/null +++ b/pages/api/api-extractor-model.itypeparameteroptions.defaulttypeexcerpt.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ITypeParameterOptions](./api-extractor-model.itypeparameteroptions.md) > [defaultTypeExcerpt](./api-extractor-model.itypeparameteroptions.defaulttypeexcerpt.md) + +## ITypeParameterOptions.defaultTypeExcerpt property + +Signature: + +```typescript +defaultTypeExcerpt: Excerpt; +``` diff --git a/pages/api/api-extractor-model.itypeparameteroptions.md b/pages/api/api-extractor-model.itypeparameteroptions.md new file mode 100644 index 000000000..a54efd3fa --- /dev/null +++ b/pages/api/api-extractor-model.itypeparameteroptions.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ITypeParameterOptions](./api-extractor-model.itypeparameteroptions.md) + +## ITypeParameterOptions interface + +Constructor options for [TypeParameter](./api-extractor-model.typeparameter.md). + +Signature: + +```typescript +export interface ITypeParameterOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [constraintExcerpt](./api-extractor-model.itypeparameteroptions.constraintexcerpt.md) | Excerpt | | +| [defaultTypeExcerpt](./api-extractor-model.itypeparameteroptions.defaulttypeexcerpt.md) | Excerpt | | +| [name](./api-extractor-model.itypeparameteroptions.name.md) | string | | +| [parent](./api-extractor-model.itypeparameteroptions.parent.md) | ApiTypeParameterListMixin | | + diff --git a/pages/api/api-extractor-model.itypeparameteroptions.name.md b/pages/api/api-extractor-model.itypeparameteroptions.name.md new file mode 100644 index 000000000..d061986c6 --- /dev/null +++ b/pages/api/api-extractor-model.itypeparameteroptions.name.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ITypeParameterOptions](./api-extractor-model.itypeparameteroptions.md) > [name](./api-extractor-model.itypeparameteroptions.name.md) + +## ITypeParameterOptions.name property + +Signature: + +```typescript +name: string; +``` diff --git a/pages/api/api-extractor-model.itypeparameteroptions.parent.md b/pages/api/api-extractor-model.itypeparameteroptions.parent.md new file mode 100644 index 000000000..7debb5188 --- /dev/null +++ b/pages/api/api-extractor-model.itypeparameteroptions.parent.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ITypeParameterOptions](./api-extractor-model.itypeparameteroptions.md) > [parent](./api-extractor-model.itypeparameteroptions.parent.md) + +## ITypeParameterOptions.parent property + +Signature: + +```typescript +parent: ApiTypeParameterListMixin; +``` diff --git a/pages/api/api-extractor-model.md b/pages/api/api-extractor-model.md new file mode 100644 index 000000000..86075744a --- /dev/null +++ b/pages/api/api-extractor-model.md @@ -0,0 +1,136 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) + +## api-extractor-model package + +API Extractor helps you build better TypeScript library packages. It helps with validation, documentation, and reviewing of the exported API for a TypeScript library. + +## Classes + +| Class | Description | +| --- | --- | +| [ApiCallSignature](./api-extractor-model.apicallsignature.md) | Represents a TypeScript function call signature. | +| [ApiClass](./api-extractor-model.apiclass.md) | Represents a TypeScript class declaration. | +| [ApiConstructor](./api-extractor-model.apiconstructor.md) | Represents a TypeScript class constructor declaration that belongs to an ApiClass. | +| [ApiConstructSignature](./api-extractor-model.apiconstructsignature.md) | Represents a TypeScript construct signature that belongs to an ApiInterface. | +| [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) | The base class for API items that have an associated source code excerpt containing a TypeScript declaration. | +| [ApiDocumentedItem](./api-extractor-model.apidocumenteditem.md) | An abstract base class for API declarations that can have an associated TSDoc comment. | +| [ApiEntryPoint](./api-extractor-model.apientrypoint.md) | Represents the entry point for an NPM package. | +| [ApiEnum](./api-extractor-model.apienum.md) | Represents a TypeScript enum declaration. | +| [ApiEnumMember](./api-extractor-model.apienummember.md) | Represents a member of a TypeScript enum declaration. | +| [ApiFunction](./api-extractor-model.apifunction.md) | Represents a TypeScript function declaration. | +| [ApiIndexSignature](./api-extractor-model.apiindexsignature.md) | Represents a TypeScript index signature. | +| [ApiInterface](./api-extractor-model.apiinterface.md) | Represents a TypeScript class declaration. | +| [ApiItem](./api-extractor-model.apiitem.md) | The abstract base class for all members of an ApiModel object. | +| [ApiMethod](./api-extractor-model.apimethod.md) | Represents a TypeScript member function declaration that belongs to an ApiClass. | +| [ApiMethodSignature](./api-extractor-model.apimethodsignature.md) | Represents a TypeScript member function declaration that belongs to an ApiInterface. | +| [ApiModel](./api-extractor-model.apimodel.md) | A serializable representation of a collection of API declarations. | +| [ApiNamespace](./api-extractor-model.apinamespace.md) | Represents a TypeScript namespace declaration. | +| [ApiPackage](./api-extractor-model.apipackage.md) | Represents an NPM package containing API declarations. | +| [ApiProperty](./api-extractor-model.apiproperty.md) | Represents a TypeScript property declaration that belongs to an ApiClass. | +| [ApiPropertyItem](./api-extractor-model.apipropertyitem.md) | The abstract base class for [ApiProperty](./api-extractor-model.apiproperty.md) and [ApiPropertySignature](./api-extractor-model.apipropertysignature.md). | +| [ApiPropertySignature](./api-extractor-model.apipropertysignature.md) | Represents a TypeScript property declaration that belongs to an ApiInterface. | +| [ApiTypeAlias](./api-extractor-model.apitypealias.md) | Represents a TypeScript type alias declaration. | +| [ApiVariable](./api-extractor-model.apivariable.md) | Represents a TypeScript variable declaration. | +| [Excerpt](./api-extractor-model.excerpt.md) | This class is used by [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) to represent a source code excerpt containing a TypeScript declaration. | +| [ExcerptToken](./api-extractor-model.excerpttoken.md) | | +| [HeritageType](./api-extractor-model.heritagetype.md) | Represents a type referenced via an "extends" or "implements" heritage clause for a TypeScript class. | +| [Parameter](./api-extractor-model.parameter.md) | Represents a named parameter for a function-like declaration. | +| [TypeParameter](./api-extractor-model.typeparameter.md) | Represents a named type parameter for a generic declaration. | + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [ApiItemKind](./api-extractor-model.apiitemkind.md) | The type returned by the [ApiItem.kind](./api-extractor-model.apiitem.kind.md) property, which can be used to easily distinguish subclasses of [ApiItem](./api-extractor-model.apiitem.md). | +| [ExcerptTokenKind](./api-extractor-model.excerpttokenkind.md) | | +| [ReleaseTag](./api-extractor-model.releasetag.md) | A "release tag" is a custom TSDoc tag that is applied to an API to communicate the level of support provided for third-party developers. | + +## Functions + +| Function | Description | +| --- | --- | +| [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 . | +| [ApiParameterListMixin(baseClass)](./api-extractor-model.apiparameterlistmixin.md) | Mixin function for . | +| [ApiReleaseTagMixin(baseClass)](./api-extractor-model.apireleasetagmixin.md) | Mixin function for . | +| [ApiReturnTypeMixin(baseClass)](./api-extractor-model.apireturntypemixin.md) | Mixin function for . | +| [ApiStaticMixin(baseClass)](./api-extractor-model.apistaticmixin.md) | Mixin function for . | +| [ApiTypeParameterListMixin(baseClass)](./api-extractor-model.apitypeparameterlistmixin.md) | Mixin function for . | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [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. | +| [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 @internal, @alpha, @beta, or @public. 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. | +| [ApiStaticMixin](./api-extractor-model.apistaticmixin.md) | The mixin base class for API items that can have the TypeScript static keyword applied to them. | +| [ApiTypeParameterListMixin](./api-extractor-model.apitypeparameterlistmixin.md) | The mixin base class for API items that can have type parameters. | +| [IApiCallSignatureOptions](./api-extractor-model.iapicallsignatureoptions.md) | Constructor options for [ApiCallSignature](./api-extractor-model.apicallsignature.md). | +| [IApiClassOptions](./api-extractor-model.iapiclassoptions.md) | Constructor options for [ApiClass](./api-extractor-model.apiclass.md). | +| [IApiConstructorOptions](./api-extractor-model.iapiconstructoroptions.md) | Constructor options for [ApiConstructor](./api-extractor-model.apiconstructor.md). | +| [IApiConstructSignatureOptions](./api-extractor-model.iapiconstructsignatureoptions.md) | Constructor options for [ApiConstructor](./api-extractor-model.apiconstructor.md). | +| [IApiDeclaredItemOptions](./api-extractor-model.iapideclareditemoptions.md) | Constructor options for [ApiDeclaredItem](./api-extractor-model.apideclareditem.md). | +| [IApiDocumentedItemOptions](./api-extractor-model.iapidocumenteditemoptions.md) | Constructor options for [ApiDocumentedItem](./api-extractor-model.apidocumenteditem.md). | +| [IApiEntryPointOptions](./api-extractor-model.iapientrypointoptions.md) | Constructor options for [ApiEntryPoint](./api-extractor-model.apientrypoint.md). | +| [IApiEnumMemberOptions](./api-extractor-model.iapienummemberoptions.md) | Constructor options for [ApiEnumMember](./api-extractor-model.apienummember.md). | +| [IApiEnumOptions](./api-extractor-model.iapienumoptions.md) | Constructor options for [ApiEnum](./api-extractor-model.apienum.md). | +| [IApiFunctionOptions](./api-extractor-model.iapifunctionoptions.md) | Constructor options for [ApiFunction](./api-extractor-model.apifunction.md). | +| [IApiIndexSignatureOptions](./api-extractor-model.iapiindexsignatureoptions.md) | Constructor options for [ApiIndexSignature](./api-extractor-model.apiindexsignature.md). | +| [IApiInterfaceOptions](./api-extractor-model.iapiinterfaceoptions.md) | Constructor options for [ApiInterface](./api-extractor-model.apiinterface.md). | +| [IApiItemConstructor](./api-extractor-model.iapiitemconstructor.md) | This abstraction is used by the mixin pattern. It describes a class type that inherits from [ApiItem](./api-extractor-model.apiitem.md). | +| [IApiItemContainerMixinOptions](./api-extractor-model.iapiitemcontainermixinoptions.md) | Constructor options for . | +| [IApiItemOptions](./api-extractor-model.iapiitemoptions.md) | Constructor options for [ApiItem](./api-extractor-model.apiitem.md). | +| [IApiMethodOptions](./api-extractor-model.iapimethodoptions.md) | Constructor options for [ApiMethod](./api-extractor-model.apimethod.md). | +| [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). | +| [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 . | +| [IApiParameterOptions](./api-extractor-model.iapiparameteroptions.md) | Represents parameter information that is part of [IApiParameterListMixinOptions](./api-extractor-model.iapiparameterlistmixinoptions.md) | +| [IApiPropertyItemOptions](./api-extractor-model.iapipropertyitemoptions.md) | Constructor options for [ApiPropertyItem](./api-extractor-model.apipropertyitem.md). | +| [IApiPropertyOptions](./api-extractor-model.iapipropertyoptions.md) | Constructor options for [ApiProperty](./api-extractor-model.apiproperty.md). | +| [IApiPropertySignatureOptions](./api-extractor-model.iapipropertysignatureoptions.md) | Constructor options for [ApiPropertySignature](./api-extractor-model.apipropertysignature.md). | +| [IApiReleaseTagMixinOptions](./api-extractor-model.iapireleasetagmixinoptions.md) | Constructor options for . | +| [IApiReturnTypeMixinOptions](./api-extractor-model.iapireturntypemixinoptions.md) | Constructor options for . | +| [IApiStaticMixinOptions](./api-extractor-model.iapistaticmixinoptions.md) | Constructor options for [IApiStaticMixinOptions](./api-extractor-model.iapistaticmixinoptions.md). | +| [IApiTypeAliasOptions](./api-extractor-model.iapitypealiasoptions.md) | Constructor options for [ApiTypeAlias](./api-extractor-model.apitypealias.md). | +| [IApiTypeParameterListMixinOptions](./api-extractor-model.iapitypeparameterlistmixinoptions.md) | Constructor options for . | +| [IApiTypeParameterOptions](./api-extractor-model.iapitypeparameteroptions.md) | Represents parameter information that is part of [IApiTypeParameterListMixinOptions](./api-extractor-model.iapitypeparameterlistmixinoptions.md) | +| [IApiVariableOptions](./api-extractor-model.iapivariableoptions.md) | Constructor options for [ApiVariable](./api-extractor-model.apivariable.md). | +| [IExcerptToken](./api-extractor-model.iexcerpttoken.md) | | +| [IExcerptTokenRange](./api-extractor-model.iexcerpttokenrange.md) | | +| [IParameterOptions](./api-extractor-model.iparameteroptions.md) | Constructor options for [Parameter](./api-extractor-model.parameter.md). | +| [IResolveDeclarationReferenceResult](./api-extractor-model.iresolvedeclarationreferenceresult.md) | Result object for [ApiModel.resolveDeclarationReference()](./api-extractor-model.apimodel.resolvedeclarationreference.md). | +| [ITypeParameterOptions](./api-extractor-model.itypeparameteroptions.md) | Constructor options for [TypeParameter](./api-extractor-model.typeparameter.md). | + +## Namespaces + +| Namespace | Description | +| --- | --- | +| [ApiItemContainerMixin](./api-extractor-model.apiitemcontainermixin.md) | Static members for . | +| [ApiNameMixin](./api-extractor-model.apinamemixin.md) | Static members for . | +| [ApiParameterListMixin](./api-extractor-model.apiparameterlistmixin.md) | Static members for . | +| [ApiReleaseTagMixin](./api-extractor-model.apireleasetagmixin.md) | Static members for . | +| [ApiReturnTypeMixin](./api-extractor-model.apireturntypemixin.md) | Static members for . | +| [ApiStaticMixin](./api-extractor-model.apistaticmixin.md) | Static members for . | +| [ApiTypeParameterListMixin](./api-extractor-model.apitypeparameterlistmixin.md) | Static members for . | +| [ReleaseTag](./api-extractor-model.releasetag.md) | Helper functions for working with the ReleaseTag enum. | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [Constructor](./api-extractor-model.constructor.md) | This abstraction is used by the mixin pattern. It describes a class constructor. | +| [PropertiesOf](./api-extractor-model.propertiesof.md) | This abstraction is used by the mixin pattern. It describes the "static side" of a class. | + diff --git a/pages/api/api-extractor-model.parameter._constructor_.md b/pages/api/api-extractor-model.parameter._constructor_.md new file mode 100644 index 000000000..01784e346 --- /dev/null +++ b/pages/api/api-extractor-model.parameter._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [Parameter](./api-extractor-model.parameter.md) > [(constructor)](./api-extractor-model.parameter._constructor_.md) + +## Parameter.(constructor) + +Constructs a new instance of the `Parameter` class + +Signature: + +```typescript +constructor(options: IParameterOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IParameterOptions | | + diff --git a/pages/api/api-extractor-model.parameter.md b/pages/api/api-extractor-model.parameter.md new file mode 100644 index 000000000..05984b7d0 --- /dev/null +++ b/pages/api/api-extractor-model.parameter.md @@ -0,0 +1,45 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [Parameter](./api-extractor-model.parameter.md) + +## Parameter class + +Represents a named parameter for a function-like declaration. + +Signature: + +```typescript +export declare class Parameter +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.parameter._constructor_.md) | | Constructs a new instance of the Parameter class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [name](./api-extractor-model.parameter.name.md) | | string | The parameter name. | +| [parameterTypeExcerpt](./api-extractor-model.parameter.parametertypeexcerpt.md) | | Excerpt | An [Excerpt](./api-extractor-model.excerpt.md) that describes the type of the parameter. | +| [tsdocParamBlock](./api-extractor-model.parameter.tsdocparamblock.md) | | tsdoc.DocParamBlock | undefined | Returns the @param documentation for this parameter, if present. | + +## Remarks + +`Parameter` represents a TypeScript declaration such as `x: number` in this example: + +```ts +export function add(x: number, y: number): number { + return x + y; +} + +``` +`Parameter` objects belong to the collection. + diff --git a/pages/api/api-extractor-model.parameter.name.md b/pages/api/api-extractor-model.parameter.name.md new file mode 100644 index 000000000..64e75e3c4 --- /dev/null +++ b/pages/api/api-extractor-model.parameter.name.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [Parameter](./api-extractor-model.parameter.md) > [name](./api-extractor-model.parameter.name.md) + +## Parameter.name property + +The parameter name. + +Signature: + +```typescript +name: string; +``` diff --git a/pages/api/api-extractor-model.parameter.parametertypeexcerpt.md b/pages/api/api-extractor-model.parameter.parametertypeexcerpt.md new file mode 100644 index 000000000..9ab16860d --- /dev/null +++ b/pages/api/api-extractor-model.parameter.parametertypeexcerpt.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [Parameter](./api-extractor-model.parameter.md) > [parameterTypeExcerpt](./api-extractor-model.parameter.parametertypeexcerpt.md) + +## Parameter.parameterTypeExcerpt property + +An [Excerpt](./api-extractor-model.excerpt.md) that describes the type of the parameter. + +Signature: + +```typescript +readonly parameterTypeExcerpt: Excerpt; +``` diff --git a/pages/api/api-extractor-model.parameter.tsdocparamblock.md b/pages/api/api-extractor-model.parameter.tsdocparamblock.md new file mode 100644 index 000000000..d3dbacf9a --- /dev/null +++ b/pages/api/api-extractor-model.parameter.tsdocparamblock.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [Parameter](./api-extractor-model.parameter.md) > [tsdocParamBlock](./api-extractor-model.parameter.tsdocparamblock.md) + +## Parameter.tsdocParamBlock property + +Returns the `@param` documentation for this parameter, if present. + +Signature: + +```typescript +readonly tsdocParamBlock: tsdoc.DocParamBlock | undefined; +``` diff --git a/pages/api/api-extractor-model.propertiesof.md b/pages/api/api-extractor-model.propertiesof.md new file mode 100644 index 000000000..9b3b764d6 --- /dev/null +++ b/pages/api/api-extractor-model.propertiesof.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [PropertiesOf](./api-extractor-model.propertiesof.md) + +## PropertiesOf type + +This abstraction is used by the mixin pattern. It describes the "static side" of a class. + +Signature: + +```typescript +export declare type PropertiesOf = { + [K in keyof T]: T[K]; +}; +``` diff --git a/pages/api/api-extractor-model.releasetag.compare.md b/pages/api/api-extractor-model.releasetag.compare.md new file mode 100644 index 000000000..1094c0083 --- /dev/null +++ b/pages/api/api-extractor-model.releasetag.compare.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ReleaseTag](./api-extractor-model.releasetag.md) > [compare](./api-extractor-model.releasetag.compare.md) + +## ReleaseTag.compare() function + +Compares two `ReleaseTag` values. Their values must not be `ReleaseTag.None`. + +Signature: + +```typescript +function compare(a: ReleaseTag, b: ReleaseTag): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| a | ReleaseTag | | +| b | ReleaseTag | | + +Returns: + +`number` + +0 if `a` and `b` are equal, a positive number if `a` is more public than `b`, and a negative number if `a` is less public than `b`. + +## Remarks + +For example, `compareReleaseTag(ReleaseTag.Beta, ReleaseTag.Alpha)` will return a positive number because beta is more public than alpha. + diff --git a/pages/api/api-extractor-model.releasetag.gettagname.md b/pages/api/api-extractor-model.releasetag.gettagname.md new file mode 100644 index 000000000..63e25f28e --- /dev/null +++ b/pages/api/api-extractor-model.releasetag.gettagname.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ReleaseTag](./api-extractor-model.releasetag.md) > [getTagName](./api-extractor-model.releasetag.gettagname.md) + +## ReleaseTag.getTagName() function + +Returns the TSDoc tag name for a `ReleaseTag` value. + +Signature: + +```typescript +function getTagName(releaseTag: ReleaseTag): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| releaseTag | ReleaseTag | | + +Returns: + +`string` + +## Remarks + +For example, `getTagName(ReleaseTag.Internal)` would return the string `@internal`. + diff --git a/pages/api/api-extractor-model.releasetag.md b/pages/api/api-extractor-model.releasetag.md new file mode 100644 index 000000000..1da118541 --- /dev/null +++ b/pages/api/api-extractor-model.releasetag.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [ReleaseTag](./api-extractor-model.releasetag.md) + +## ReleaseTag namespace + +Helper functions for working with the `ReleaseTag` enum. + +Signature: + +```typescript +export declare namespace ReleaseTag +``` + +## Functions + +| Function | Description | +| --- | --- | +| [compare(a, b)](./api-extractor-model.releasetag.compare.md) | Compares two ReleaseTag values. Their values must not be ReleaseTag.None. | +| [getTagName(releaseTag)](./api-extractor-model.releasetag.gettagname.md) | Returns the TSDoc tag name for a ReleaseTag value. | + diff --git a/pages/api/api-extractor-model.typeparameter._constructor_.md b/pages/api/api-extractor-model.typeparameter._constructor_.md new file mode 100644 index 000000000..3e9921ea8 --- /dev/null +++ b/pages/api/api-extractor-model.typeparameter._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [TypeParameter](./api-extractor-model.typeparameter.md) > [(constructor)](./api-extractor-model.typeparameter._constructor_.md) + +## TypeParameter.(constructor) + +Constructs a new instance of the `TypeParameter` class + +Signature: + +```typescript +constructor(options: ITypeParameterOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | ITypeParameterOptions | | + diff --git a/pages/api/api-extractor-model.typeparameter.constraintexcerpt.md b/pages/api/api-extractor-model.typeparameter.constraintexcerpt.md new file mode 100644 index 000000000..0b066651e --- /dev/null +++ b/pages/api/api-extractor-model.typeparameter.constraintexcerpt.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [TypeParameter](./api-extractor-model.typeparameter.md) > [constraintExcerpt](./api-extractor-model.typeparameter.constraintexcerpt.md) + +## TypeParameter.constraintExcerpt property + +An [Excerpt](./api-extractor-model.excerpt.md) that describes the base constraint of the type parameter. + +Signature: + +```typescript +readonly constraintExcerpt: Excerpt; +``` + +## Remarks + +In the example below, the `constraintExcerpt` would correspond to the `IIdentifier` subexpression: + +```ts +class Book { + public identifier: TIdentifier; +} + +``` + diff --git a/pages/api/api-extractor-model.typeparameter.defaulttypeexcerpt.md b/pages/api/api-extractor-model.typeparameter.defaulttypeexcerpt.md new file mode 100644 index 000000000..1fdae91e8 --- /dev/null +++ b/pages/api/api-extractor-model.typeparameter.defaulttypeexcerpt.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [TypeParameter](./api-extractor-model.typeparameter.md) > [defaultTypeExcerpt](./api-extractor-model.typeparameter.defaulttypeexcerpt.md) + +## TypeParameter.defaultTypeExcerpt property + +An [Excerpt](./api-extractor-model.excerpt.md) that describes the default type of the type parameter. + +Signature: + +```typescript +readonly defaultTypeExcerpt: Excerpt; +``` + +## Remarks + +In the example below, the `defaultTypeExcerpt` would correspond to the `BarCode` subexpression: + +```ts +class Book { + public identifier: TIdentifier; +} + +``` + diff --git a/pages/api/api-extractor-model.typeparameter.md b/pages/api/api-extractor-model.typeparameter.md new file mode 100644 index 000000000..ace2b135d --- /dev/null +++ b/pages/api/api-extractor-model.typeparameter.md @@ -0,0 +1,55 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [TypeParameter](./api-extractor-model.typeparameter.md) + +## TypeParameter class + +Represents a named type parameter for a generic declaration. + +Signature: + +```typescript +export declare class TypeParameter +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./api-extractor-model.typeparameter._constructor_.md) | | Constructs a new instance of the TypeParameter class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [constraintExcerpt](./api-extractor-model.typeparameter.constraintexcerpt.md) | | Excerpt | An [Excerpt](./api-extractor-model.excerpt.md) that describes the base constraint of the type parameter. | +| [defaultTypeExcerpt](./api-extractor-model.typeparameter.defaulttypeexcerpt.md) | | Excerpt | An [Excerpt](./api-extractor-model.excerpt.md) that describes the default type of the type parameter. | +| [name](./api-extractor-model.typeparameter.name.md) | | string | The parameter name. | +| [tsdocTypeParamBlock](./api-extractor-model.typeparameter.tsdoctypeparamblock.md) | | tsdoc.DocParamBlock | undefined | Returns the @typeParam documentation for this parameter, if present. | + +## Remarks + +`TypeParameter` represents a TypeScript declaration such as `T` in this example: + +```ts +interface IIdentifier { + getCode(): string; +} + +class BarCode implements IIdentifier { + private _value: number; + public getCode(): string { return this._value.toString(); } +} + +class Book { + public identifier: TIdentifier; +} + +``` +`TypeParameter` objects belong to the collection. + diff --git a/pages/api/api-extractor-model.typeparameter.name.md b/pages/api/api-extractor-model.typeparameter.name.md new file mode 100644 index 000000000..5fb296f46 --- /dev/null +++ b/pages/api/api-extractor-model.typeparameter.name.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [TypeParameter](./api-extractor-model.typeparameter.md) > [name](./api-extractor-model.typeparameter.name.md) + +## TypeParameter.name property + +The parameter name. + +Signature: + +```typescript +name: string; +``` diff --git a/pages/api/api-extractor-model.typeparameter.tsdoctypeparamblock.md b/pages/api/api-extractor-model.typeparameter.tsdoctypeparamblock.md new file mode 100644 index 000000000..730fed74d --- /dev/null +++ b/pages/api/api-extractor-model.typeparameter.tsdoctypeparamblock.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor-model](./api-extractor-model.md) > [TypeParameter](./api-extractor-model.typeparameter.md) > [tsdocTypeParamBlock](./api-extractor-model.typeparameter.tsdoctypeparamblock.md) + +## TypeParameter.tsdocTypeParamBlock property + +Returns the `@typeParam` documentation for this parameter, if present. + +Signature: + +```typescript +readonly tsdocTypeParamBlock: tsdoc.DocParamBlock | undefined; +``` diff --git a/pages/api/api-extractor.compilerstate.create.md b/pages/api/api-extractor.compilerstate.create.md new file mode 100644 index 000000000..53a39a7d3 --- /dev/null +++ b/pages/api/api-extractor.compilerstate.create.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [CompilerState](./api-extractor.compilerstate.md) > [create](./api-extractor.compilerstate.create.md) + +## CompilerState.create() method + +Create a compiler state for use with the specified `IExtractorInvokeOptions`. + +Signature: + +```typescript +static create(extractorConfig: ExtractorConfig, options?: ICompilerStateCreateOptions): CompilerState; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| extractorConfig | ExtractorConfig | | +| options | ICompilerStateCreateOptions | | + +Returns: + +`CompilerState` + diff --git a/pages/api/api-extractor.compilerstate.md b/pages/api/api-extractor.compilerstate.md new file mode 100644 index 000000000..afe15e85a --- /dev/null +++ b/pages/api/api-extractor.compilerstate.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [CompilerState](./api-extractor.compilerstate.md) + +## CompilerState class + +This class represents the TypeScript compiler state. This allows an optimization where multiple invocations of API Extractor can reuse the same TypeScript compiler analysis. + +Signature: + +```typescript +export declare class CompilerState +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [program](./api-extractor.compilerstate.program.md) | | ts.Program | The TypeScript compiler's Program object, which represents a complete scope of analysis. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [create(extractorConfig, options)](./api-extractor.compilerstate.create.md) | static | Create a compiler state for use with the specified IExtractorInvokeOptions. | + diff --git a/pages/api/api-extractor.compilerstate.program.md b/pages/api/api-extractor.compilerstate.program.md new file mode 100644 index 000000000..a560240cc --- /dev/null +++ b/pages/api/api-extractor.compilerstate.program.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [CompilerState](./api-extractor.compilerstate.md) > [program](./api-extractor.compilerstate.program.md) + +## CompilerState.program property + +The TypeScript compiler's `Program` object, which represents a complete scope of analysis. + +Signature: + +```typescript +readonly program: ts.Program; +``` diff --git a/pages/api/api-extractor.consolemessageid.md b/pages/api/api-extractor.consolemessageid.md new file mode 100644 index 000000000..8f05bec25 --- /dev/null +++ b/pages/api/api-extractor.consolemessageid.md @@ -0,0 +1,37 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ConsoleMessageId](./api-extractor.consolemessageid.md) + +## ConsoleMessageId enum + +Unique identifiers for console messages reported by API Extractor. + +Signature: + +```typescript +export declare const enum ConsoleMessageId +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| ApiReportCopied | "console-api-report-copied" | "You have changed the public API signature for this project. Updating \_\_\_" | +| ApiReportCreated | "console-api-report-created" | "The API report file was missing, so a new file was created. Please add this file to Git: \_\_\_" | +| ApiReportFolderMissing | "console-api-report-folder-missing" | "Unable to create the API report file. Please make sure the target folder exists: \_\_\_" | +| ApiReportNotCopied | "console-api-report-not-copied" | "You have changed the public API signature for this project. Please copy the file \_\_\_ to \_\_\_, or perform a local build (which does this automatically). See the Git repo documentation for more info."OR"The API report file is missing. Please copy the file \_\_\_ to \_\_\_, or perform a local build (which does this automatically). See the Git repo documentation for more info." | +| ApiReportUnchanged | "console-api-report-unchanged" | "The API report is up to date: \_\_\_" | +| Diagnostics | "console-diagnostics" | Used for the information printed when the "--diagnostics" flag is enabled. | +| FoundTSDocMetadata | "console-found-tsdoc-metadata" | "Found metadata in \_\_\_" | +| WritingDocModelFile | "console-writing-doc-model-file" | "Writing: \_\_\_" | +| WritingDtsRollup | "console-writing-dts-rollup" | "Writing package typings: \_\_\_" | + +## Remarks + +These strings are possible values for the [ExtractorMessage.messageId](./api-extractor.extractormessage.messageid.md) property when the `ExtractorMessage.category` is [ExtractorMessageCategory.Console](./api-extractor.extractormessagecategory.console.md). + diff --git a/pages/api/api-extractor.extractor.invoke.md b/pages/api/api-extractor.extractor.invoke.md new file mode 100644 index 000000000..a368b19be --- /dev/null +++ b/pages/api/api-extractor.extractor.invoke.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [Extractor](./api-extractor.extractor.md) > [invoke](./api-extractor.extractor.invoke.md) + +## Extractor.invoke() method + +Invoke API Extractor using an already prepared `ExtractorConfig` object. + +Signature: + +```typescript +static invoke(extractorConfig: ExtractorConfig, options?: IExtractorInvokeOptions): ExtractorResult; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| extractorConfig | ExtractorConfig | | +| options | IExtractorInvokeOptions | | + +Returns: + +`ExtractorResult` + diff --git a/pages/api/api-extractor.extractor.loadconfigandinvoke.md b/pages/api/api-extractor.extractor.loadconfigandinvoke.md new file mode 100644 index 000000000..d713fcef9 --- /dev/null +++ b/pages/api/api-extractor.extractor.loadconfigandinvoke.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [Extractor](./api-extractor.extractor.md) > [loadConfigAndInvoke](./api-extractor.extractor.loadconfigandinvoke.md) + +## Extractor.loadConfigAndInvoke() method + +Load the api-extractor.json config file from the specified path, and then invoke API Extractor. + +Signature: + +```typescript +static loadConfigAndInvoke(configFilePath: string, options?: IExtractorInvokeOptions): ExtractorResult; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| configFilePath | string | | +| options | IExtractorInvokeOptions | | + +Returns: + +`ExtractorResult` + diff --git a/pages/api/api-extractor.extractor.md b/pages/api/api-extractor.extractor.md new file mode 100644 index 000000000..23275f6ca --- /dev/null +++ b/pages/api/api-extractor.extractor.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [Extractor](./api-extractor.extractor.md) + +## Extractor class + +The starting point for invoking the API Extractor tool. + +Signature: + +```typescript +export declare class Extractor +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [packageName](./api-extractor.extractor.packagename.md) | static | string | Returns the package name of the API Extractor NPM package. | +| [version](./api-extractor.extractor.version.md) | static | string | Returns the version number of the API Extractor NPM package. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [invoke(extractorConfig, options)](./api-extractor.extractor.invoke.md) | static | Invoke API Extractor using an already prepared ExtractorConfig object. | +| [loadConfigAndInvoke(configFilePath, options)](./api-extractor.extractor.loadconfigandinvoke.md) | static | Load the api-extractor.json config file from the specified path, and then invoke API Extractor. | + diff --git a/pages/api/api-extractor.extractor.packagename.md b/pages/api/api-extractor.extractor.packagename.md new file mode 100644 index 000000000..40fa82f3c --- /dev/null +++ b/pages/api/api-extractor.extractor.packagename.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [Extractor](./api-extractor.extractor.md) > [packageName](./api-extractor.extractor.packagename.md) + +## Extractor.packageName property + +Returns the package name of the API Extractor NPM package. + +Signature: + +```typescript +static readonly packageName: string; +``` diff --git a/pages/api/api-extractor.extractor.version.md b/pages/api/api-extractor.extractor.version.md new file mode 100644 index 000000000..398dd4e11 --- /dev/null +++ b/pages/api/api-extractor.extractor.version.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [Extractor](./api-extractor.extractor.md) > [version](./api-extractor.extractor.version.md) + +## Extractor.version property + +Returns the version number of the API Extractor NPM package. + +Signature: + +```typescript +static readonly version: string; +``` diff --git a/pages/api/api-extractor.extractorconfig.apijsonfilepath.md b/pages/api/api-extractor.extractorconfig.apijsonfilepath.md new file mode 100644 index 000000000..27f914185 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.apijsonfilepath.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [apiJsonFilePath](./api-extractor.extractorconfig.apijsonfilepath.md) + +## ExtractorConfig.apiJsonFilePath property + +The output path for the doc model file. The file extension should be ".api.json". + +Signature: + +```typescript +readonly apiJsonFilePath: string; +``` + +## Remarks + +The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as ``. + diff --git a/pages/api/api-extractor.extractorconfig.apireportenabled.md b/pages/api/api-extractor.extractorconfig.apireportenabled.md new file mode 100644 index 000000000..2e6c09020 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.apireportenabled.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [apiReportEnabled](./api-extractor.extractorconfig.apireportenabled.md) + +## ExtractorConfig.apiReportEnabled property + +Whether to generate an API report. + +Signature: + +```typescript +readonly apiReportEnabled: boolean; +``` diff --git a/pages/api/api-extractor.extractorconfig.betatrimmedfilepath.md b/pages/api/api-extractor.extractorconfig.betatrimmedfilepath.md new file mode 100644 index 000000000..aefd5f000 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.betatrimmedfilepath.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [betaTrimmedFilePath](./api-extractor.extractorconfig.betatrimmedfilepath.md) + +## ExtractorConfig.betaTrimmedFilePath property + +Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release. + +Signature: + +```typescript +readonly betaTrimmedFilePath: string; +``` + +## Remarks + +This file will include only declarations that are marked as `@public` or `@beta`. + +The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as ``. + diff --git a/pages/api/api-extractor.extractorconfig.docmodelenabled.md b/pages/api/api-extractor.extractorconfig.docmodelenabled.md new file mode 100644 index 000000000..069eee1d6 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.docmodelenabled.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [docModelEnabled](./api-extractor.extractorconfig.docmodelenabled.md) + +## ExtractorConfig.docModelEnabled property + +Whether to generate a doc model file. + +Signature: + +```typescript +readonly docModelEnabled: boolean; +``` diff --git a/pages/api/api-extractor.extractorconfig.filename.md b/pages/api/api-extractor.extractorconfig.filename.md new file mode 100644 index 000000000..89c353da3 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.filename.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [FILENAME](./api-extractor.extractorconfig.filename.md) + +## ExtractorConfig.FILENAME property + +The config file name "api-extractor.json". + +Signature: + +```typescript +static readonly FILENAME: string; +``` diff --git a/pages/api/api-extractor.extractorconfig.getdiagnosticdump.md b/pages/api/api-extractor.extractorconfig.getdiagnosticdump.md new file mode 100644 index 000000000..3a66e901a --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.getdiagnosticdump.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [getDiagnosticDump](./api-extractor.extractorconfig.getdiagnosticdump.md) + +## ExtractorConfig.getDiagnosticDump() method + +Returns a JSON-like string representing the `ExtractorConfig` state, which can be printed to a console for diagnostic purposes. + +Signature: + +```typescript +getDiagnosticDump(): string; +``` +Returns: + +`string` + +## Remarks + +This is used by the "--diagnostics" command-line option. The string is not intended to be deserialized; its format may be changed at any time. + diff --git a/pages/api/api-extractor.extractorconfig.hasdtsfileextension.md b/pages/api/api-extractor.extractorconfig.hasdtsfileextension.md new file mode 100644 index 000000000..b5c591999 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.hasdtsfileextension.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [hasDtsFileExtension](./api-extractor.extractorconfig.hasdtsfileextension.md) + +## ExtractorConfig.hasDtsFileExtension() method + +Returns true if the specified file path has the ".d.ts" file extension. + +Signature: + +```typescript +static hasDtsFileExtension(filePath: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filePath | string | | + +Returns: + +`boolean` + diff --git a/pages/api/api-extractor.extractorconfig.jsonschema.md b/pages/api/api-extractor.extractorconfig.jsonschema.md new file mode 100644 index 000000000..17f1d36cd --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.jsonschema.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [jsonSchema](./api-extractor.extractorconfig.jsonschema.md) + +## ExtractorConfig.jsonSchema property + +The JSON Schema for API Extractor config file (api-extractor.schema.json). + +Signature: + +```typescript +static readonly jsonSchema: JsonSchema; +``` diff --git a/pages/api/api-extractor.extractorconfig.loadfile.md b/pages/api/api-extractor.extractorconfig.loadfile.md new file mode 100644 index 000000000..95379c52d --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.loadfile.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [loadFile](./api-extractor.extractorconfig.loadfile.md) + +## ExtractorConfig.loadFile() method + +Performs only the first half of [ExtractorConfig.loadFileAndPrepare()](./api-extractor.extractorconfig.loadfileandprepare.md), providing an opportunity to modify the object before it is passed to [ExtractorConfig.prepare()](./api-extractor.extractorconfig.prepare.md). + +Signature: + +```typescript +static loadFile(jsonFilePath: string): IConfigFile; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonFilePath | string | | + +Returns: + +`IConfigFile` + +## Remarks + +Loads the api-extractor.json config file from the specified file path. If the "extends" field is present, the referenced file(s) will be merged. For any omitted fields, the API Extractor default values are merged. + diff --git a/pages/api/api-extractor.extractorconfig.loadfileandprepare.md b/pages/api/api-extractor.extractorconfig.loadfileandprepare.md new file mode 100644 index 000000000..0c3dcf787 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.loadfileandprepare.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [loadFileAndPrepare](./api-extractor.extractorconfig.loadfileandprepare.md) + +## ExtractorConfig.loadFileAndPrepare() method + +Loads the api-extractor.json config file from the specified file path, and prepares an `ExtractorConfig` object. + +Signature: + +```typescript +static loadFileAndPrepare(configJsonFilePath: string): ExtractorConfig; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| configJsonFilePath | string | | + +Returns: + +`ExtractorConfig` + +## Remarks + +Loads the api-extractor.json config file from the specified file path. If the "extends" field is present, the referenced file(s) will be merged. For any omitted fields, the API Extractor default values are merged. + +The result is prepared using `ExtractorConfig.prepare()`. + diff --git a/pages/api/api-extractor.extractorconfig.mainentrypointfilepath.md b/pages/api/api-extractor.extractorconfig.mainentrypointfilepath.md new file mode 100644 index 000000000..314305862 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.mainentrypointfilepath.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [mainEntryPointFilePath](./api-extractor.extractorconfig.mainentrypointfilepath.md) + +## ExtractorConfig.mainEntryPointFilePath property + +Specifies the .d.ts file to be used as the starting point for analysis. API Extractor analyzes the symbols exported by this module. + +Signature: + +```typescript +readonly mainEntryPointFilePath: string; +``` + +## Remarks + +The file extension must be ".d.ts" and not ".ts". The path is resolved relative to the "projectFolder" location. + diff --git a/pages/api/api-extractor.extractorconfig.md b/pages/api/api-extractor.extractorconfig.md new file mode 100644 index 000000000..3d30629e2 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.md @@ -0,0 +1,57 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) + +## ExtractorConfig class + +The `ExtractorConfig` class loads, validates, interprets, and represents the api-extractor.json config file. + +Signature: + +```typescript +export declare class ExtractorConfig +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [apiJsonFilePath](./api-extractor.extractorconfig.apijsonfilepath.md) | | string | The output path for the doc model file. The file extension should be ".api.json". | +| [apiReportEnabled](./api-extractor.extractorconfig.apireportenabled.md) | | boolean | Whether to generate an API report. | +| [betaTrimmedFilePath](./api-extractor.extractorconfig.betatrimmedfilepath.md) | | string | Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release. | +| [docModelEnabled](./api-extractor.extractorconfig.docmodelenabled.md) | | boolean | Whether to generate a doc model file. | +| [FILENAME](./api-extractor.extractorconfig.filename.md) | static | string | The config file name "api-extractor.json". | +| [jsonSchema](./api-extractor.extractorconfig.jsonschema.md) | static | JsonSchema | The JSON Schema for API Extractor config file (api-extractor.schema.json). | +| [mainEntryPointFilePath](./api-extractor.extractorconfig.mainentrypointfilepath.md) | | string | Specifies the .d.ts file to be used as the starting point for analysis. API Extractor analyzes the symbols exported by this module. | +| [messages](./api-extractor.extractorconfig.messages.md) | | IExtractorMessagesConfig | Configures how API Extractor reports error and warning messages produced during analysis. | +| [omitTrimmingComments](./api-extractor.extractorconfig.omittrimmingcomments.md) | | boolean | When a declaration is trimmed, by default it will be replaced by a code comment such as "Excluded from this release type: exampleMember". Set "omitTrimmingComments" to true to remove the declaration completely. | +| [overrideTsconfig](./api-extractor.extractorconfig.overridetsconfig.md) | | {} | undefined | Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk. | +| [packageFolder](./api-extractor.extractorconfig.packagefolder.md) | | string | undefined | The absolute path of the folder containing the package.json file for the working package, or undefined if API Extractor was invoked without a package.json file. | +| [packageJson](./api-extractor.extractorconfig.packagejson.md) | | INodePackageJson | undefined | The parsed package.json file for the working package, or undefined if API Extractor was invoked without a package.json file. | +| [projectFolder](./api-extractor.extractorconfig.projectfolder.md) | | string | Determines the <projectFolder> token that can be used with other config file settings. The project folder typically contains the tsconfig.json and package.json config files, but the path is user-defined. | +| [publicTrimmedFilePath](./api-extractor.extractorconfig.publictrimmedfilepath.md) | | string | Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release. | +| [reportFilePath](./api-extractor.extractorconfig.reportfilepath.md) | | string | The reportFolder path combined with the reportFileName. | +| [reportTempFilePath](./api-extractor.extractorconfig.reporttempfilepath.md) | | string | The reportTempFolder path combined with the reportFileName. | +| [rollupEnabled](./api-extractor.extractorconfig.rollupenabled.md) | | boolean | Whether to generate the .d.ts rollup file. | +| [skipLibCheck](./api-extractor.extractorconfig.skiplibcheck.md) | | boolean | This option causes the compiler to be invoked with the --skipLibCheck 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. | +| [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. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [getDiagnosticDump()](./api-extractor.extractorconfig.getdiagnosticdump.md) | | Returns a JSON-like string representing the ExtractorConfig state, which can be printed to a console for diagnostic purposes. | +| [hasDtsFileExtension(filePath)](./api-extractor.extractorconfig.hasdtsfileextension.md) | static | Returns true if the specified file path has the ".d.ts" file extension. | +| [loadFile(jsonFilePath)](./api-extractor.extractorconfig.loadfile.md) | static | Performs only the first half of [ExtractorConfig.loadFileAndPrepare()](./api-extractor.extractorconfig.loadfileandprepare.md), providing an opportunity to modify the object before it is passed to [ExtractorConfig.prepare()](./api-extractor.extractorconfig.prepare.md). | +| [loadFileAndPrepare(configJsonFilePath)](./api-extractor.extractorconfig.loadfileandprepare.md) | static | Loads the api-extractor.json config file from the specified file path, and prepares an ExtractorConfig object. | +| [prepare(options)](./api-extractor.extractorconfig.prepare.md) | static | Prepares an ExtractorConfig object using a configuration that is provided as a runtime object, rather than reading it from disk. This allows configurations to be constructed programmatically, loaded from an alternate source, and/or customized after loading. | + diff --git a/pages/api/api-extractor.extractorconfig.messages.md b/pages/api/api-extractor.extractorconfig.messages.md new file mode 100644 index 000000000..77045270d --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.messages.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [messages](./api-extractor.extractorconfig.messages.md) + +## ExtractorConfig.messages property + +Configures how API Extractor reports error and warning messages produced during analysis. + +Signature: + +```typescript +readonly messages: IExtractorMessagesConfig; +``` + +## Remarks + +This is part of the [IConfigFile](./api-extractor.iconfigfile.md) structure. + diff --git a/pages/api/api-extractor.extractorconfig.omittrimmingcomments.md b/pages/api/api-extractor.extractorconfig.omittrimmingcomments.md new file mode 100644 index 000000000..21b08c5d3 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.omittrimmingcomments.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [omitTrimmingComments](./api-extractor.extractorconfig.omittrimmingcomments.md) + +## ExtractorConfig.omitTrimmingComments property + +When a declaration is trimmed, by default it will be replaced by a code comment such as "Excluded from this release type: exampleMember". Set "omitTrimmingComments" to true to remove the declaration completely. + +Signature: + +```typescript +readonly omitTrimmingComments: boolean; +``` diff --git a/pages/api/api-extractor.extractorconfig.overridetsconfig.md b/pages/api/api-extractor.extractorconfig.overridetsconfig.md new file mode 100644 index 000000000..aea7ff033 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.overridetsconfig.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [overrideTsconfig](./api-extractor.extractorconfig.overridetsconfig.md) + +## ExtractorConfig.overrideTsconfig property + +Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk. + +Signature: + +```typescript +readonly overrideTsconfig: {} | undefined; +``` + +## Remarks + +The value must conform to the TypeScript tsconfig schema: + +http://json.schemastore.org/tsconfig + +If omitted, then the tsconfig.json file will instead be read from the projectFolder. + diff --git a/pages/api/api-extractor.extractorconfig.packagefolder.md b/pages/api/api-extractor.extractorconfig.packagefolder.md new file mode 100644 index 000000000..73fd43138 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.packagefolder.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [packageFolder](./api-extractor.extractorconfig.packagefolder.md) + +## ExtractorConfig.packageFolder property + +The absolute path of the folder containing the package.json file for the working package, or undefined if API Extractor was invoked without a package.json file. + +Signature: + +```typescript +readonly packageFolder: string | undefined; +``` diff --git a/pages/api/api-extractor.extractorconfig.packagejson.md b/pages/api/api-extractor.extractorconfig.packagejson.md new file mode 100644 index 000000000..c512cb20a --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.packagejson.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [packageJson](./api-extractor.extractorconfig.packagejson.md) + +## ExtractorConfig.packageJson property + +The parsed package.json file for the working package, or undefined if API Extractor was invoked without a package.json file. + +Signature: + +```typescript +readonly packageJson: INodePackageJson | undefined; +``` diff --git a/pages/api/api-extractor.extractorconfig.prepare.md b/pages/api/api-extractor.extractorconfig.prepare.md new file mode 100644 index 000000000..04d9d545c --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.prepare.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [prepare](./api-extractor.extractorconfig.prepare.md) + +## ExtractorConfig.prepare() method + +Prepares an `ExtractorConfig` object using a configuration that is provided as a runtime object, rather than reading it from disk. This allows configurations to be constructed programmatically, loaded from an alternate source, and/or customized after loading. + +Signature: + +```typescript +static prepare(options: IExtractorConfigPrepareOptions): ExtractorConfig; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IExtractorConfigPrepareOptions | | + +Returns: + +`ExtractorConfig` + diff --git a/pages/api/api-extractor.extractorconfig.projectfolder.md b/pages/api/api-extractor.extractorconfig.projectfolder.md new file mode 100644 index 000000000..31b1bb434 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.projectfolder.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [projectFolder](./api-extractor.extractorconfig.projectfolder.md) + +## ExtractorConfig.projectFolder property + +Determines the `` token that can be used with other config file settings. The project folder typically contains the tsconfig.json and package.json config files, but the path is user-defined. + +Signature: + +```typescript +readonly projectFolder: string; +``` + +## Remarks + +The path is resolved relative to the folder of the config file that contains the setting. + +The default value for `projectFolder` is the token ``, which means the folder is determined by traversing parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder that contains a tsconfig.json file. If a tsconfig.json file cannot be found in this way, then an error will be reported. + diff --git a/pages/api/api-extractor.extractorconfig.publictrimmedfilepath.md b/pages/api/api-extractor.extractorconfig.publictrimmedfilepath.md new file mode 100644 index 000000000..a282b2d30 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.publictrimmedfilepath.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [publicTrimmedFilePath](./api-extractor.extractorconfig.publictrimmedfilepath.md) + +## ExtractorConfig.publicTrimmedFilePath property + +Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release. + +Signature: + +```typescript +readonly publicTrimmedFilePath: string; +``` + +## Remarks + +This file will include only declarations that are marked as `@public`. + +If the path is an empty string, then this file will not be written. + +The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as ``. + diff --git a/pages/api/api-extractor.extractorconfig.reportfilepath.md b/pages/api/api-extractor.extractorconfig.reportfilepath.md new file mode 100644 index 000000000..5621b3091 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.reportfilepath.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [reportFilePath](./api-extractor.extractorconfig.reportfilepath.md) + +## ExtractorConfig.reportFilePath property + +The `reportFolder` path combined with the `reportFileName`. + +Signature: + +```typescript +readonly reportFilePath: string; +``` diff --git a/pages/api/api-extractor.extractorconfig.reporttempfilepath.md b/pages/api/api-extractor.extractorconfig.reporttempfilepath.md new file mode 100644 index 000000000..6c0785fa6 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.reporttempfilepath.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [reportTempFilePath](./api-extractor.extractorconfig.reporttempfilepath.md) + +## ExtractorConfig.reportTempFilePath property + +The `reportTempFolder` path combined with the `reportFileName`. + +Signature: + +```typescript +readonly reportTempFilePath: string; +``` diff --git a/pages/api/api-extractor.extractorconfig.rollupenabled.md b/pages/api/api-extractor.extractorconfig.rollupenabled.md new file mode 100644 index 000000000..9f2b313cf --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.rollupenabled.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [rollupEnabled](./api-extractor.extractorconfig.rollupenabled.md) + +## ExtractorConfig.rollupEnabled property + +Whether to generate the .d.ts rollup file. + +Signature: + +```typescript +readonly rollupEnabled: boolean; +``` diff --git a/pages/api/api-extractor.extractorconfig.skiplibcheck.md b/pages/api/api-extractor.extractorconfig.skiplibcheck.md new file mode 100644 index 000000000..a18e448c6 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.skiplibcheck.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [skipLibCheck](./api-extractor.extractorconfig.skiplibcheck.md) + +## ExtractorConfig.skipLibCheck property + +This option causes the compiler to be invoked with the `--skipLibCheck` option. + +Signature: + +```typescript +readonly skipLibCheck: boolean; +``` + +## Remarks + +This option is not recommended and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses for its analysis. Where possible, the underlying issue should be fixed rather than relying on skipLibCheck. + diff --git a/pages/api/api-extractor.extractorconfig.testmode.md b/pages/api/api-extractor.extractorconfig.testmode.md new file mode 100644 index 000000000..d293d4290 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.testmode.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [testMode](./api-extractor.extractorconfig.testmode.md) + +## ExtractorConfig.testMode property + +Set to true when invoking API Extractor's test harness. + +Signature: + +```typescript +readonly testMode: boolean; +``` + +## Remarks + +When `testMode` is true, the `toolVersion` field in the .api.json file is assigned an empty string to prevent spurious diffs in output files tracked for tests. + diff --git a/pages/api/api-extractor.extractorconfig.tsconfigfilepath.md b/pages/api/api-extractor.extractorconfig.tsconfigfilepath.md new file mode 100644 index 000000000..1d790527b --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.tsconfigfilepath.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [tsconfigFilePath](./api-extractor.extractorconfig.tsconfigfilepath.md) + +## ExtractorConfig.tsconfigFilePath property + +Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project. + +Signature: + +```typescript +readonly tsconfigFilePath: string; +``` + +## Remarks + +The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as ``. + +Note: This setting will be ignored if `overrideTsconfig` is used. + diff --git a/pages/api/api-extractor.extractorconfig.tsdocmetadataenabled.md b/pages/api/api-extractor.extractorconfig.tsdocmetadataenabled.md new file mode 100644 index 000000000..fbea8d8d0 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.tsdocmetadataenabled.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [tsdocMetadataEnabled](./api-extractor.extractorconfig.tsdocmetadataenabled.md) + +## ExtractorConfig.tsdocMetadataEnabled property + +Whether to generate the tsdoc-metadata.json file. + +Signature: + +```typescript +readonly tsdocMetadataEnabled: boolean; +``` diff --git a/pages/api/api-extractor.extractorconfig.tsdocmetadatafilepath.md b/pages/api/api-extractor.extractorconfig.tsdocmetadatafilepath.md new file mode 100644 index 000000000..164aed382 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.tsdocmetadatafilepath.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [tsdocMetadataFilePath](./api-extractor.extractorconfig.tsdocmetadatafilepath.md) + +## ExtractorConfig.tsdocMetadataFilePath property + +Specifies where the TSDoc metadata file should be written. + +Signature: + +```typescript +readonly tsdocMetadataFilePath: string; +``` + +## Remarks + +The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as ``. + +The default value is ``, which causes the path to be automatically inferred from the `tsdocMetadata`, `typings` or `main` fields of the project's package.json. If none of these fields are set, the lookup falls back to `tsdoc-metadata.json` in the package folder. + diff --git a/pages/api/api-extractor.extractorconfig.untrimmedfilepath.md b/pages/api/api-extractor.extractorconfig.untrimmedfilepath.md new file mode 100644 index 000000000..02fc198e8 --- /dev/null +++ b/pages/api/api-extractor.extractorconfig.untrimmedfilepath.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorConfig](./api-extractor.extractorconfig.md) > [untrimmedFilePath](./api-extractor.extractorconfig.untrimmedfilepath.md) + +## ExtractorConfig.untrimmedFilePath property + +Specifies the output path for a .d.ts rollup file to be generated without any trimming. + +Signature: + +```typescript +readonly untrimmedFilePath: string; +``` + +## Remarks + +This file will include all declarations that are exported by the main entry point. + +If the path is an empty string, then this file will not be written. + +The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as ``. + diff --git a/pages/api/api-extractor.extractorloglevel.md b/pages/api/api-extractor.extractorloglevel.md new file mode 100644 index 000000000..23076d5f8 --- /dev/null +++ b/pages/api/api-extractor.extractorloglevel.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorLogLevel](./api-extractor.extractorloglevel.md) + +## ExtractorLogLevel enum + +Used with [IConfigMessageReportingRule.logLevel](./api-extractor.iconfigmessagereportingrule.loglevel.md) and [IExtractorInvokeOptions.messageCallback](./api-extractor.iextractorinvokeoptions.messagecallback.md). + +Signature: + +```typescript +export declare const enum ExtractorLogLevel +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Error | "error" | The message will be displayed as an error. | +| Info | "info" | The message will be displayed as an informational message. | +| None | "none" | The message will be discarded entirely. | +| Verbose | "verbose" | The message will be displayed only when "verbose" output is requested, e.g. using the --verbose command line option. | +| Warning | "warning" | The message will be displayed as an warning. | + +## Remarks + +This is part of the [IConfigFile](./api-extractor.iconfigfile.md) structure. + diff --git a/pages/api/api-extractor.extractormessage.category.md b/pages/api/api-extractor.extractormessage.category.md new file mode 100644 index 000000000..7657f7d88 --- /dev/null +++ b/pages/api/api-extractor.extractormessage.category.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorMessage](./api-extractor.extractormessage.md) > [category](./api-extractor.extractormessage.category.md) + +## ExtractorMessage.category property + +The category of issue. + +Signature: + +```typescript +readonly category: ExtractorMessageCategory; +``` diff --git a/pages/api/api-extractor.extractormessage.formatmessagewithlocation.md b/pages/api/api-extractor.extractormessage.formatmessagewithlocation.md new file mode 100644 index 000000000..8670b62e1 --- /dev/null +++ b/pages/api/api-extractor.extractormessage.formatmessagewithlocation.md @@ -0,0 +1,38 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorMessage](./api-extractor.extractormessage.md) > [formatMessageWithLocation](./api-extractor.extractormessage.formatmessagewithlocation.md) + +## ExtractorMessage.formatMessageWithLocation() method + +Returns the message formatted with its identifier and file position. + +Signature: + +```typescript +formatMessageWithLocation(workingPackageFolderPath: string | undefined): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| workingPackageFolderPath | string | undefined | | + +Returns: + +`string` + +## Remarks + +Example: + +``` +src/folder/File.ts:123:4 - (ae-extra-release-tag) The doc comment should not contain more than one release tag. + +``` + diff --git a/pages/api/api-extractor.extractormessage.formatmessagewithoutlocation.md b/pages/api/api-extractor.extractormessage.formatmessagewithoutlocation.md new file mode 100644 index 000000000..63aee1744 --- /dev/null +++ b/pages/api/api-extractor.extractormessage.formatmessagewithoutlocation.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorMessage](./api-extractor.extractormessage.md) > [formatMessageWithoutLocation](./api-extractor.extractormessage.formatmessagewithoutlocation.md) + +## ExtractorMessage.formatMessageWithoutLocation() method + +Signature: + +```typescript +formatMessageWithoutLocation(): string; +``` +Returns: + +`string` + diff --git a/pages/api/api-extractor.extractormessage.handled.md b/pages/api/api-extractor.extractormessage.handled.md new file mode 100644 index 000000000..5e5928688 --- /dev/null +++ b/pages/api/api-extractor.extractormessage.handled.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorMessage](./api-extractor.extractormessage.md) > [handled](./api-extractor.extractormessage.handled.md) + +## ExtractorMessage.handled property + +If the [IExtractorInvokeOptions.messageCallback](./api-extractor.iextractorinvokeoptions.messagecallback.md) sets this property to true, it will prevent the message from being displayed by API Extractor. + +Signature: + +```typescript +handled: boolean; +``` + +## Remarks + +If the `messageCallback` routes the message to a custom handler (e.g. a toolchain logger), it should assign `handled = true` to prevent API Extractor from displaying it. Assigning `handled = true` for all messages would effectively disable all console output from the `Extractor` API. + +If `handled` is set to true, the message will still be included in the count of errors/warnings; to discard a message entirely, instead assign `logLevel = none`. + diff --git a/pages/api/api-extractor.extractormessage.loglevel.md b/pages/api/api-extractor.extractormessage.loglevel.md new file mode 100644 index 000000000..1cd07ac1e --- /dev/null +++ b/pages/api/api-extractor.extractormessage.loglevel.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorMessage](./api-extractor.extractormessage.md) > [logLevel](./api-extractor.extractormessage.loglevel.md) + +## ExtractorMessage.logLevel property + +Specifies how the message should be reported. + +Signature: + +```typescript +logLevel: ExtractorLogLevel; +``` + +## Remarks + +If the [IExtractorInvokeOptions.messageCallback](./api-extractor.iextractorinvokeoptions.messagecallback.md) handles the message (i.e. sets `handled = true`), it can use the `logLevel` to determine how to display the message. + +Alternatively, if API Extractor is handling the message, the `messageCallback` could assign `logLevel` to change how it will be processed. However, in general the recommended practice is to configure message routing using the `messages` section in api-extractor.json. + +To discard a message entirely, assign `logLevel = none`. + diff --git a/pages/api/api-extractor.extractormessage.md b/pages/api/api-extractor.extractormessage.md new file mode 100644 index 000000000..8893f9bd7 --- /dev/null +++ b/pages/api/api-extractor.extractormessage.md @@ -0,0 +1,44 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorMessage](./api-extractor.extractormessage.md) + +## ExtractorMessage class + +This object is used to report an error or warning that occurred during API Extractor's analysis. + +Signature: + +```typescript +export declare class ExtractorMessage +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [category](./api-extractor.extractormessage.category.md) | | ExtractorMessageCategory | The category of issue. | +| [handled](./api-extractor.extractormessage.handled.md) | | boolean | If the [IExtractorInvokeOptions.messageCallback](./api-extractor.iextractorinvokeoptions.messagecallback.md) sets this property to true, it will prevent the message from being displayed by API Extractor. | +| [logLevel](./api-extractor.extractormessage.loglevel.md) | | ExtractorLogLevel | Specifies how the message should be reported. | +| [messageId](./api-extractor.extractormessage.messageid.md) | | tsdoc.TSDocMessageId | ExtractorMessageId | ConsoleMessageId | string | A text string that uniquely identifies the issue type. This identifier can be used to suppress or configure the reporting of issues, and also to search for help about an issue. | +| [properties](./api-extractor.extractormessage.properties.md) | | IExtractorMessageProperties | Additional contextual information about the message that may be useful when reporting errors. All properties are optional. | +| [sourceFileColumn](./api-extractor.extractormessage.sourcefilecolumn.md) | | number | undefined | The column number where the issue occurred in the input source file. This is not used if sourceFilePath is undefined. The first column number is 1. | +| [sourceFileLine](./api-extractor.extractormessage.sourcefileline.md) | | number | undefined | The line number where the issue occurred in the input source file. This is not used if sourceFilePath is undefined. The first line number is 1. | +| [sourceFilePath](./api-extractor.extractormessage.sourcefilepath.md) | | string | undefined | The absolute path to the affected input source file, if there is one. | +| [text](./api-extractor.extractormessage.text.md) | | string | The text description of this issue. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [formatMessageWithLocation(workingPackageFolderPath)](./api-extractor.extractormessage.formatmessagewithlocation.md) | | Returns the message formatted with its identifier and file position. | +| [formatMessageWithoutLocation()](./api-extractor.extractormessage.formatmessagewithoutlocation.md) | | | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ExtractorMessage` class. + diff --git a/pages/api/api-extractor.extractormessage.messageid.md b/pages/api/api-extractor.extractormessage.messageid.md new file mode 100644 index 000000000..e11e62a07 --- /dev/null +++ b/pages/api/api-extractor.extractormessage.messageid.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorMessage](./api-extractor.extractormessage.md) > [messageId](./api-extractor.extractormessage.messageid.md) + +## ExtractorMessage.messageId property + +A text string that uniquely identifies the issue type. This identifier can be used to suppress or configure the reporting of issues, and also to search for help about an issue. + +Signature: + +```typescript +readonly messageId: tsdoc.TSDocMessageId | ExtractorMessageId | ConsoleMessageId | string; +``` diff --git a/pages/api/api-extractor.extractormessage.properties.md b/pages/api/api-extractor.extractormessage.properties.md new file mode 100644 index 000000000..68e59ef35 --- /dev/null +++ b/pages/api/api-extractor.extractormessage.properties.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorMessage](./api-extractor.extractormessage.md) > [properties](./api-extractor.extractormessage.properties.md) + +## ExtractorMessage.properties property + +Additional contextual information about the message that may be useful when reporting errors. All properties are optional. + +Signature: + +```typescript +readonly properties: IExtractorMessageProperties; +``` diff --git a/pages/api/api-extractor.extractormessage.sourcefilecolumn.md b/pages/api/api-extractor.extractormessage.sourcefilecolumn.md new file mode 100644 index 000000000..5b2168036 --- /dev/null +++ b/pages/api/api-extractor.extractormessage.sourcefilecolumn.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorMessage](./api-extractor.extractormessage.md) > [sourceFileColumn](./api-extractor.extractormessage.sourcefilecolumn.md) + +## ExtractorMessage.sourceFileColumn property + +The column number where the issue occurred in the input source file. This is not used if `sourceFilePath` is undefined. The first column number is 1. + +Signature: + +```typescript +readonly sourceFileColumn: number | undefined; +``` diff --git a/pages/api/api-extractor.extractormessage.sourcefileline.md b/pages/api/api-extractor.extractormessage.sourcefileline.md new file mode 100644 index 000000000..8c6ca73f8 --- /dev/null +++ b/pages/api/api-extractor.extractormessage.sourcefileline.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorMessage](./api-extractor.extractormessage.md) > [sourceFileLine](./api-extractor.extractormessage.sourcefileline.md) + +## ExtractorMessage.sourceFileLine property + +The line number where the issue occurred in the input source file. This is not used if `sourceFilePath` is undefined. The first line number is 1. + +Signature: + +```typescript +readonly sourceFileLine: number | undefined; +``` diff --git a/pages/api/api-extractor.extractormessage.sourcefilepath.md b/pages/api/api-extractor.extractormessage.sourcefilepath.md new file mode 100644 index 000000000..fe234f4d3 --- /dev/null +++ b/pages/api/api-extractor.extractormessage.sourcefilepath.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorMessage](./api-extractor.extractormessage.md) > [sourceFilePath](./api-extractor.extractormessage.sourcefilepath.md) + +## ExtractorMessage.sourceFilePath property + +The absolute path to the affected input source file, if there is one. + +Signature: + +```typescript +readonly sourceFilePath: string | undefined; +``` diff --git a/pages/api/api-extractor.extractormessage.text.md b/pages/api/api-extractor.extractormessage.text.md new file mode 100644 index 000000000..e6ec26308 --- /dev/null +++ b/pages/api/api-extractor.extractormessage.text.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorMessage](./api-extractor.extractormessage.md) > [text](./api-extractor.extractormessage.text.md) + +## ExtractorMessage.text property + +The text description of this issue. + +Signature: + +```typescript +readonly text: string; +``` diff --git a/pages/api/api-extractor.extractormessagecategory.md b/pages/api/api-extractor.extractormessagecategory.md new file mode 100644 index 000000000..cae699a83 --- /dev/null +++ b/pages/api/api-extractor.extractormessagecategory.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorMessageCategory](./api-extractor.extractormessagecategory.md) + +## ExtractorMessageCategory enum + +Specifies a category of messages for use with [ExtractorMessage](./api-extractor.extractormessage.md). + +Signature: + +```typescript +export declare const enum ExtractorMessageCategory +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Compiler | "Compiler" | Messages originating from the TypeScript compiler. | +| Console | "console" | Console messages communicate the progress of the overall operation. They may include newlines to ensure nice formatting. They are output in real time, and cannot be routed to the API Report file. | +| Extractor | "Extractor" | Messages related to API Extractor's analysis. | +| TSDoc | "TSDoc" | Messages related to parsing of TSDoc comments. | + diff --git a/pages/api/api-extractor.extractormessageid.md b/pages/api/api-extractor.extractormessageid.md new file mode 100644 index 000000000..01495fc20 --- /dev/null +++ b/pages/api/api-extractor.extractormessageid.md @@ -0,0 +1,41 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorMessageId](./api-extractor.extractormessageid.md) + +## ExtractorMessageId enum + +Unique identifiers for messages reported by API Extractor during its analysis. + +Signature: + +```typescript +export declare const enum ExtractorMessageId +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| CyclicInheritDoc | "ae-cyclic-inherit-doc" | "The @inheritDoc tag for \_\_\_ refers to its own declaration". | +| DifferentReleaseTags | "ae-different-release-tags" | "This symbol has another declaration with a different release tag." | +| ExtraReleaseTag | "ae-extra-release-tag" | "The doc comment should not contain more than one release tag." | +| ForgottenExport | "ae-forgotten-export" | "The symbol \_\_\_ needs to be exported by the entry point \_\_\_." | +| IncompatibleReleaseTags | "ae-incompatible-release-tags" | "The symbol \_\_\_ is marked as \_\_\_, but its signature references \_\_\_ which is marked as \_\_\_." | +| InternalMissingUnderscore | "ae-internal-missing-underscore" | "The name \_\_\_ should be prefixed with an underscore because the declaration is marked as @internal." | +| MisplacedPackageTag | "ae-misplaced-package-tag" | "The @packageDocumentation comment must appear at the top of entry point \*.d.ts file." | +| MissingReleaseTag | "ae-missing-release-tag" | "\_\_\_ is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)." | +| PreapprovedBadReleaseTag | "ae-preapproved-bad-release-tag" | "The @preapproved tag cannot be applied to \_\_\_ without an @internal release tag." | +| PreapprovedUnsupportedType | "ae-preapproved-unsupported-type" | "The @preapproved tag cannot be applied to \_\_\_ because it is not a supported declaration type." | +| UnresolvedInheritDocBase | "ae-unresolved-inheritdoc-base" | "The @inheritDoc tag needs a TSDoc declaration reference; signature matching is not supported yet". | +| UnresolvedInheritDocReference | "ae-unresolved-inheritdoc-reference" | "The @inheritDoc reference could not be resolved". | +| UnresolvedLink | "ae-unresolved-link" | "The @link reference could not be resolved". | + +## Remarks + +These strings are possible values for the [ExtractorMessage.messageId](./api-extractor.extractormessage.messageid.md) property when the `ExtractorMessage.category` is [ExtractorMessageCategory.Extractor](./api-extractor.extractormessagecategory.extractor.md). + diff --git a/pages/api/api-extractor.extractorresult.apireportchanged.md b/pages/api/api-extractor.extractorresult.apireportchanged.md new file mode 100644 index 000000000..acb87e33a --- /dev/null +++ b/pages/api/api-extractor.extractorresult.apireportchanged.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorResult](./api-extractor.extractorresult.md) > [apiReportChanged](./api-extractor.extractorresult.apireportchanged.md) + +## ExtractorResult.apiReportChanged property + +Returns true if the API report was found to have changed. + +Signature: + +```typescript +readonly apiReportChanged: boolean; +``` diff --git a/pages/api/api-extractor.extractorresult.compilerstate.md b/pages/api/api-extractor.extractorresult.compilerstate.md new file mode 100644 index 000000000..929d473fd --- /dev/null +++ b/pages/api/api-extractor.extractorresult.compilerstate.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorResult](./api-extractor.extractorresult.md) > [compilerState](./api-extractor.extractorresult.compilerstate.md) + +## ExtractorResult.compilerState property + +The TypeScript compiler state that was used. + +Signature: + +```typescript +readonly compilerState: CompilerState; +``` diff --git a/pages/api/api-extractor.extractorresult.errorcount.md b/pages/api/api-extractor.extractorresult.errorcount.md new file mode 100644 index 000000000..4d0d51ae7 --- /dev/null +++ b/pages/api/api-extractor.extractorresult.errorcount.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorResult](./api-extractor.extractorresult.md) > [errorCount](./api-extractor.extractorresult.errorcount.md) + +## ExtractorResult.errorCount property + +Reports the number of errors encountered during analysis. + +Signature: + +```typescript +readonly errorCount: number; +``` + +## Remarks + +This does not count exceptions, where unexpected issues prematurely abort the operation. + diff --git a/pages/api/api-extractor.extractorresult.extractorconfig.md b/pages/api/api-extractor.extractorresult.extractorconfig.md new file mode 100644 index 000000000..b12f609fd --- /dev/null +++ b/pages/api/api-extractor.extractorresult.extractorconfig.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorResult](./api-extractor.extractorresult.md) > [extractorConfig](./api-extractor.extractorresult.extractorconfig.md) + +## ExtractorResult.extractorConfig property + +The API Extractor configuration that was used. + +Signature: + +```typescript +readonly extractorConfig: ExtractorConfig; +``` diff --git a/pages/api/api-extractor.extractorresult.md b/pages/api/api-extractor.extractorresult.md new file mode 100644 index 000000000..305fdb619 --- /dev/null +++ b/pages/api/api-extractor.extractorresult.md @@ -0,0 +1,34 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorResult](./api-extractor.extractorresult.md) + +## ExtractorResult class + +This object represents the outcome of an invocation of API Extractor. + +Signature: + +```typescript +export declare class ExtractorResult +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [apiReportChanged](./api-extractor.extractorresult.apireportchanged.md) | | boolean | Returns true if the API report was found to have changed. | +| [compilerState](./api-extractor.extractorresult.compilerstate.md) | | CompilerState | The TypeScript compiler state that was used. | +| [errorCount](./api-extractor.extractorresult.errorcount.md) | | number | Reports the number of errors encountered during analysis. | +| [extractorConfig](./api-extractor.extractorresult.extractorconfig.md) | | ExtractorConfig | The API Extractor configuration that was used. | +| [succeeded](./api-extractor.extractorresult.succeeded.md) | | boolean | Whether the invocation of API Extractor was successful. For example, if succeeded is false, then the build task would normally return a nonzero process exit code, indicating that the operation failed. | +| [warningCount](./api-extractor.extractorresult.warningcount.md) | | number | Reports the number of warnings encountered during analysis. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ExtractorResult` class. + diff --git a/pages/api/api-extractor.extractorresult.succeeded.md b/pages/api/api-extractor.extractorresult.succeeded.md new file mode 100644 index 000000000..8409371c6 --- /dev/null +++ b/pages/api/api-extractor.extractorresult.succeeded.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorResult](./api-extractor.extractorresult.md) > [succeeded](./api-extractor.extractorresult.succeeded.md) + +## ExtractorResult.succeeded property + +Whether the invocation of API Extractor was successful. For example, if `succeeded` is false, then the build task would normally return a nonzero process exit code, indicating that the operation failed. + +Signature: + +```typescript +readonly succeeded: boolean; +``` + +## Remarks + +Normally the operation "succeeds" if `errorCount` and `warningCount` are both zero. However if [IExtractorInvokeOptions.localBuild](./api-extractor.iextractorinvokeoptions.localbuild.md) is `true`, then the operation "succeeds" if `errorCount` is zero (i.e. warnings are ignored). + diff --git a/pages/api/api-extractor.extractorresult.warningcount.md b/pages/api/api-extractor.extractorresult.warningcount.md new file mode 100644 index 000000000..ca49b6cf3 --- /dev/null +++ b/pages/api/api-extractor.extractorresult.warningcount.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ExtractorResult](./api-extractor.extractorresult.md) > [warningCount](./api-extractor.extractorresult.warningcount.md) + +## ExtractorResult.warningCount property + +Reports the number of warnings encountered during analysis. + +Signature: + +```typescript +readonly warningCount: number; +``` + +## Remarks + +This does not count warnings that are emitted in the API report file. + diff --git a/pages/api/api-extractor.icompilerstatecreateoptions.additionalentrypoints.md b/pages/api/api-extractor.icompilerstatecreateoptions.additionalentrypoints.md new file mode 100644 index 000000000..ef766f5c7 --- /dev/null +++ b/pages/api/api-extractor.icompilerstatecreateoptions.additionalentrypoints.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ICompilerStateCreateOptions](./api-extractor.icompilerstatecreateoptions.md) > [additionalEntryPoints](./api-extractor.icompilerstatecreateoptions.additionalentrypoints.md) + +## ICompilerStateCreateOptions.additionalEntryPoints property + +Additional .d.ts files to include in the analysis. + +Signature: + +```typescript +additionalEntryPoints?: string[]; +``` diff --git a/pages/api/api-extractor.icompilerstatecreateoptions.md b/pages/api/api-extractor.icompilerstatecreateoptions.md new file mode 100644 index 000000000..0d0d024ff --- /dev/null +++ b/pages/api/api-extractor.icompilerstatecreateoptions.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ICompilerStateCreateOptions](./api-extractor.icompilerstatecreateoptions.md) + +## ICompilerStateCreateOptions interface + +Options for [CompilerState.create()](./api-extractor.compilerstate.create.md) + +Signature: + +```typescript +export interface ICompilerStateCreateOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [additionalEntryPoints](./api-extractor.icompilerstatecreateoptions.additionalentrypoints.md) | string[] | Additional .d.ts files to include in the analysis. | +| [typescriptCompilerFolder](./api-extractor.icompilerstatecreateoptions.typescriptcompilerfolder.md) | string | Specifies an alternate folder path to be used when loading the TypeScript system typings. | + diff --git a/pages/api/api-extractor.icompilerstatecreateoptions.typescriptcompilerfolder.md b/pages/api/api-extractor.icompilerstatecreateoptions.typescriptcompilerfolder.md new file mode 100644 index 000000000..728bcb022 --- /dev/null +++ b/pages/api/api-extractor.icompilerstatecreateoptions.typescriptcompilerfolder.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [ICompilerStateCreateOptions](./api-extractor.icompilerstatecreateoptions.md) > [typescriptCompilerFolder](./api-extractor.icompilerstatecreateoptions.typescriptcompilerfolder.md) + +## ICompilerStateCreateOptions.typescriptCompilerFolder property + +Specifies an alternate folder path to be used when loading the TypeScript system typings. + +Signature: + +```typescript +typescriptCompilerFolder?: string; +``` + +## Remarks + +API Extractor uses its own TypeScript compiler engine to analyze your project. If your project is built with a significantly different TypeScript version, sometimes API Extractor may report compilation errors due to differences in the system typings (e.g. lib.dom.d.ts). You can use the "--typescriptCompilerFolder" option to specify the folder path where you installed the TypeScript package, and API Extractor's compiler will use those system typings instead. + diff --git a/pages/api/api-extractor.iconfigapireport.enabled.md b/pages/api/api-extractor.iconfigapireport.enabled.md new file mode 100644 index 000000000..8dbd74507 --- /dev/null +++ b/pages/api/api-extractor.iconfigapireport.enabled.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigApiReport](./api-extractor.iconfigapireport.md) > [enabled](./api-extractor.iconfigapireport.enabled.md) + +## IConfigApiReport.enabled property + +Whether to generate an API report. + +Signature: + +```typescript +enabled: boolean; +``` diff --git a/pages/api/api-extractor.iconfigapireport.md b/pages/api/api-extractor.iconfigapireport.md new file mode 100644 index 000000000..231742320 --- /dev/null +++ b/pages/api/api-extractor.iconfigapireport.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigApiReport](./api-extractor.iconfigapireport.md) + +## IConfigApiReport interface + +Configures how the API report files (\*.api.md) will be generated. + +Signature: + +```typescript +export interface IConfigApiReport +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [enabled](./api-extractor.iconfigapireport.enabled.md) | boolean | Whether to generate an API report. | +| [reportFileName](./api-extractor.iconfigapireport.reportfilename.md) | string | The filename for the API report files. It will be combined with reportFolder or reportTempFolder to produce a full output filename. | +| [reportFolder](./api-extractor.iconfigapireport.reportfolder.md) | string | Specifies the folder where the API report file is written. The file name portion is determined by the reportFileName setting. | +| [reportTempFolder](./api-extractor.iconfigapireport.reporttempfolder.md) | string | Specifies the folder where the temporary report file is written. The file name portion is determined by the reportFileName setting. | + +## Remarks + +This is part of the [IConfigFile](./api-extractor.iconfigfile.md) structure. + diff --git a/pages/api/api-extractor.iconfigapireport.reportfilename.md b/pages/api/api-extractor.iconfigapireport.reportfilename.md new file mode 100644 index 000000000..ee74a3737 --- /dev/null +++ b/pages/api/api-extractor.iconfigapireport.reportfilename.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigApiReport](./api-extractor.iconfigapireport.md) > [reportFileName](./api-extractor.iconfigapireport.reportfilename.md) + +## IConfigApiReport.reportFileName property + +The filename for the API report files. It will be combined with `reportFolder` or `reportTempFolder` to produce a full output filename. + +Signature: + +```typescript +reportFileName?: string; +``` + +## Remarks + +The file extension should be ".api.md", and the string should not contain a path separator such as `\` or `/`. + diff --git a/pages/api/api-extractor.iconfigapireport.reportfolder.md b/pages/api/api-extractor.iconfigapireport.reportfolder.md new file mode 100644 index 000000000..1f828365b --- /dev/null +++ b/pages/api/api-extractor.iconfigapireport.reportfolder.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigApiReport](./api-extractor.iconfigapireport.md) > [reportFolder](./api-extractor.iconfigapireport.reportfolder.md) + +## IConfigApiReport.reportFolder property + +Specifies the folder where the API report file is written. The file name portion is determined by the `reportFileName` setting. + +Signature: + +```typescript +reportFolder?: string; +``` + +## Remarks + +The API report file is normally tracked by Git. Changes to it can be used to trigger a branch policy, e.g. for an API review. + +The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as ``. + diff --git a/pages/api/api-extractor.iconfigapireport.reporttempfolder.md b/pages/api/api-extractor.iconfigapireport.reporttempfolder.md new file mode 100644 index 000000000..b30064729 --- /dev/null +++ b/pages/api/api-extractor.iconfigapireport.reporttempfolder.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigApiReport](./api-extractor.iconfigapireport.md) > [reportTempFolder](./api-extractor.iconfigapireport.reporttempfolder.md) + +## IConfigApiReport.reportTempFolder property + +Specifies the folder where the temporary report file is written. The file name portion is determined by the `reportFileName` setting. + +Signature: + +```typescript +reportTempFolder?: string; +``` + +## Remarks + +After the temporary file is written to disk, it is compared with the file in the `reportFolder`. If they are different, a production build will fail. + +The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as ``. + diff --git a/pages/api/api-extractor.iconfigcompiler.md b/pages/api/api-extractor.iconfigcompiler.md new file mode 100644 index 000000000..8ed5e86c8 --- /dev/null +++ b/pages/api/api-extractor.iconfigcompiler.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigCompiler](./api-extractor.iconfigcompiler.md) + +## IConfigCompiler interface + +Determines how the TypeScript compiler engine will be invoked by API Extractor. + +Signature: + +```typescript +export interface IConfigCompiler +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [overrideTsconfig](./api-extractor.iconfigcompiler.overridetsconfig.md) | {} | Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk. | +| [skipLibCheck](./api-extractor.iconfigcompiler.skiplibcheck.md) | boolean | This option causes the compiler to be invoked with the --skipLibCheck option. | +| [tsconfigFilePath](./api-extractor.iconfigcompiler.tsconfigfilepath.md) | string | Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project. | + +## Remarks + +This is part of the [IConfigFile](./api-extractor.iconfigfile.md) structure. + diff --git a/pages/api/api-extractor.iconfigcompiler.overridetsconfig.md b/pages/api/api-extractor.iconfigcompiler.overridetsconfig.md new file mode 100644 index 000000000..540a3e93c --- /dev/null +++ b/pages/api/api-extractor.iconfigcompiler.overridetsconfig.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigCompiler](./api-extractor.iconfigcompiler.md) > [overrideTsconfig](./api-extractor.iconfigcompiler.overridetsconfig.md) + +## IConfigCompiler.overrideTsconfig property + +Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk. + +Signature: + +```typescript +overrideTsconfig?: {}; +``` + +## Remarks + +The value must conform to the TypeScript tsconfig schema: + +http://json.schemastore.org/tsconfig + +If omitted, then the tsconfig.json file will instead be read from the projectFolder. + diff --git a/pages/api/api-extractor.iconfigcompiler.skiplibcheck.md b/pages/api/api-extractor.iconfigcompiler.skiplibcheck.md new file mode 100644 index 000000000..33919e7c5 --- /dev/null +++ b/pages/api/api-extractor.iconfigcompiler.skiplibcheck.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigCompiler](./api-extractor.iconfigcompiler.md) > [skipLibCheck](./api-extractor.iconfigcompiler.skiplibcheck.md) + +## IConfigCompiler.skipLibCheck property + +This option causes the compiler to be invoked with the `--skipLibCheck` option. + +Signature: + +```typescript +skipLibCheck?: boolean; +``` + +## Remarks + +This option is not recommended and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses for its analysis. Where possible, the underlying issue should be fixed rather than relying on skipLibCheck. + diff --git a/pages/api/api-extractor.iconfigcompiler.tsconfigfilepath.md b/pages/api/api-extractor.iconfigcompiler.tsconfigfilepath.md new file mode 100644 index 000000000..14d0be7b1 --- /dev/null +++ b/pages/api/api-extractor.iconfigcompiler.tsconfigfilepath.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigCompiler](./api-extractor.iconfigcompiler.md) > [tsconfigFilePath](./api-extractor.iconfigcompiler.tsconfigfilepath.md) + +## IConfigCompiler.tsconfigFilePath property + +Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project. + +Signature: + +```typescript +tsconfigFilePath?: string; +``` + +## Remarks + +The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as ``. + +Note: This setting will be ignored if `overrideTsconfig` is used. + diff --git a/pages/api/api-extractor.iconfigdocmodel.apijsonfilepath.md b/pages/api/api-extractor.iconfigdocmodel.apijsonfilepath.md new file mode 100644 index 000000000..fad162fb7 --- /dev/null +++ b/pages/api/api-extractor.iconfigdocmodel.apijsonfilepath.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigDocModel](./api-extractor.iconfigdocmodel.md) > [apiJsonFilePath](./api-extractor.iconfigdocmodel.apijsonfilepath.md) + +## IConfigDocModel.apiJsonFilePath property + +The output path for the doc model file. The file extension should be ".api.json". + +Signature: + +```typescript +apiJsonFilePath?: string; +``` + +## Remarks + +The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as ``. + diff --git a/pages/api/api-extractor.iconfigdocmodel.enabled.md b/pages/api/api-extractor.iconfigdocmodel.enabled.md new file mode 100644 index 000000000..17771faae --- /dev/null +++ b/pages/api/api-extractor.iconfigdocmodel.enabled.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigDocModel](./api-extractor.iconfigdocmodel.md) > [enabled](./api-extractor.iconfigdocmodel.enabled.md) + +## IConfigDocModel.enabled property + +Whether to generate a doc model file. + +Signature: + +```typescript +enabled: boolean; +``` diff --git a/pages/api/api-extractor.iconfigdocmodel.md b/pages/api/api-extractor.iconfigdocmodel.md new file mode 100644 index 000000000..3a2f8c998 --- /dev/null +++ b/pages/api/api-extractor.iconfigdocmodel.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigDocModel](./api-extractor.iconfigdocmodel.md) + +## IConfigDocModel interface + +Configures how the doc model file (\*.api.json) will be generated. + +Signature: + +```typescript +export interface IConfigDocModel +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [apiJsonFilePath](./api-extractor.iconfigdocmodel.apijsonfilepath.md) | string | The output path for the doc model file. The file extension should be ".api.json". | +| [enabled](./api-extractor.iconfigdocmodel.enabled.md) | boolean | Whether to generate a doc model file. | + +## Remarks + +This is part of the [IConfigFile](./api-extractor.iconfigfile.md) structure. + diff --git a/pages/api/api-extractor.iconfigdtsrollup.betatrimmedfilepath.md b/pages/api/api-extractor.iconfigdtsrollup.betatrimmedfilepath.md new file mode 100644 index 000000000..e49f9bfc0 --- /dev/null +++ b/pages/api/api-extractor.iconfigdtsrollup.betatrimmedfilepath.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigDtsRollup](./api-extractor.iconfigdtsrollup.md) > [betaTrimmedFilePath](./api-extractor.iconfigdtsrollup.betatrimmedfilepath.md) + +## IConfigDtsRollup.betaTrimmedFilePath property + +Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release. + +Signature: + +```typescript +betaTrimmedFilePath?: string; +``` + +## Remarks + +This file will include only declarations that are marked as `@public` or `@beta`. + +The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as ``. + diff --git a/pages/api/api-extractor.iconfigdtsrollup.enabled.md b/pages/api/api-extractor.iconfigdtsrollup.enabled.md new file mode 100644 index 000000000..145720321 --- /dev/null +++ b/pages/api/api-extractor.iconfigdtsrollup.enabled.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigDtsRollup](./api-extractor.iconfigdtsrollup.md) > [enabled](./api-extractor.iconfigdtsrollup.enabled.md) + +## IConfigDtsRollup.enabled property + +Whether to generate the .d.ts rollup file. + +Signature: + +```typescript +enabled: boolean; +``` diff --git a/pages/api/api-extractor.iconfigdtsrollup.md b/pages/api/api-extractor.iconfigdtsrollup.md new file mode 100644 index 000000000..4d2974263 --- /dev/null +++ b/pages/api/api-extractor.iconfigdtsrollup.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigDtsRollup](./api-extractor.iconfigdtsrollup.md) + +## IConfigDtsRollup interface + +Configures how the .d.ts rollup file will be generated. + +Signature: + +```typescript +export interface IConfigDtsRollup +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [betaTrimmedFilePath](./api-extractor.iconfigdtsrollup.betatrimmedfilepath.md) | string | Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release. | +| [enabled](./api-extractor.iconfigdtsrollup.enabled.md) | boolean | Whether to generate the .d.ts rollup file. | +| [omitTrimmingComments](./api-extractor.iconfigdtsrollup.omittrimmingcomments.md) | boolean | When a declaration is trimmed, by default it will be replaced by a code comment such as "Excluded from this release type: exampleMember". Set "omitTrimmingComments" to true to remove the declaration completely. | +| [publicTrimmedFilePath](./api-extractor.iconfigdtsrollup.publictrimmedfilepath.md) | string | Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release. | +| [untrimmedFilePath](./api-extractor.iconfigdtsrollup.untrimmedfilepath.md) | string | Specifies the output path for a .d.ts rollup file to be generated without any trimming. | + +## Remarks + +This is part of the [IConfigFile](./api-extractor.iconfigfile.md) structure. + diff --git a/pages/api/api-extractor.iconfigdtsrollup.omittrimmingcomments.md b/pages/api/api-extractor.iconfigdtsrollup.omittrimmingcomments.md new file mode 100644 index 000000000..4d1acb3bc --- /dev/null +++ b/pages/api/api-extractor.iconfigdtsrollup.omittrimmingcomments.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigDtsRollup](./api-extractor.iconfigdtsrollup.md) > [omitTrimmingComments](./api-extractor.iconfigdtsrollup.omittrimmingcomments.md) + +## IConfigDtsRollup.omitTrimmingComments property + +When a declaration is trimmed, by default it will be replaced by a code comment such as "Excluded from this release type: exampleMember". Set "omitTrimmingComments" to true to remove the declaration completely. + +Signature: + +```typescript +omitTrimmingComments?: boolean; +``` diff --git a/pages/api/api-extractor.iconfigdtsrollup.publictrimmedfilepath.md b/pages/api/api-extractor.iconfigdtsrollup.publictrimmedfilepath.md new file mode 100644 index 000000000..6e0e93b1f --- /dev/null +++ b/pages/api/api-extractor.iconfigdtsrollup.publictrimmedfilepath.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigDtsRollup](./api-extractor.iconfigdtsrollup.md) > [publicTrimmedFilePath](./api-extractor.iconfigdtsrollup.publictrimmedfilepath.md) + +## IConfigDtsRollup.publicTrimmedFilePath property + +Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release. + +Signature: + +```typescript +publicTrimmedFilePath?: string; +``` + +## Remarks + +This file will include only declarations that are marked as `@public`. + +If the path is an empty string, then this file will not be written. + +The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as ``. + diff --git a/pages/api/api-extractor.iconfigdtsrollup.untrimmedfilepath.md b/pages/api/api-extractor.iconfigdtsrollup.untrimmedfilepath.md new file mode 100644 index 000000000..60ab0a7c1 --- /dev/null +++ b/pages/api/api-extractor.iconfigdtsrollup.untrimmedfilepath.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigDtsRollup](./api-extractor.iconfigdtsrollup.md) > [untrimmedFilePath](./api-extractor.iconfigdtsrollup.untrimmedfilepath.md) + +## IConfigDtsRollup.untrimmedFilePath property + +Specifies the output path for a .d.ts rollup file to be generated without any trimming. + +Signature: + +```typescript +untrimmedFilePath?: string; +``` + +## Remarks + +This file will include all declarations that are exported by the main entry point. + +If the path is an empty string, then this file will not be written. + +The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as ``. + diff --git a/pages/api/api-extractor.iconfigfile.apireport.md b/pages/api/api-extractor.iconfigfile.apireport.md new file mode 100644 index 000000000..01ed7760f --- /dev/null +++ b/pages/api/api-extractor.iconfigfile.apireport.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigFile](./api-extractor.iconfigfile.md) > [apiReport](./api-extractor.iconfigfile.apireport.md) + +## IConfigFile.apiReport property + +Configures how the API report files (\*.api.md) will be generated. + +Signature: + +```typescript +apiReport?: IConfigApiReport; +``` + +## Remarks + +This is part of the [IConfigFile](./api-extractor.iconfigfile.md) structure. + diff --git a/pages/api/api-extractor.iconfigfile.compiler.md b/pages/api/api-extractor.iconfigfile.compiler.md new file mode 100644 index 000000000..42b4172fd --- /dev/null +++ b/pages/api/api-extractor.iconfigfile.compiler.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigFile](./api-extractor.iconfigfile.md) > [compiler](./api-extractor.iconfigfile.compiler.md) + +## IConfigFile.compiler property + +Determines how the TypeScript compiler engine will be invoked by API Extractor. + +Signature: + +```typescript +compiler?: IConfigCompiler; +``` + +## Remarks + +This is part of the [IConfigFile](./api-extractor.iconfigfile.md) structure. + diff --git a/pages/api/api-extractor.iconfigfile.docmodel.md b/pages/api/api-extractor.iconfigfile.docmodel.md new file mode 100644 index 000000000..6ed584a8d --- /dev/null +++ b/pages/api/api-extractor.iconfigfile.docmodel.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigFile](./api-extractor.iconfigfile.md) > [docModel](./api-extractor.iconfigfile.docmodel.md) + +## IConfigFile.docModel property + +Configures how the doc model file (\*.api.json) will be generated. + +Signature: + +```typescript +docModel?: IConfigDocModel; +``` + +## Remarks + +This is part of the [IConfigFile](./api-extractor.iconfigfile.md) structure. + diff --git a/pages/api/api-extractor.iconfigfile.dtsrollup.md b/pages/api/api-extractor.iconfigfile.dtsrollup.md new file mode 100644 index 000000000..3d7723926 --- /dev/null +++ b/pages/api/api-extractor.iconfigfile.dtsrollup.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigFile](./api-extractor.iconfigfile.md) > [dtsRollup](./api-extractor.iconfigfile.dtsrollup.md) + +## IConfigFile.dtsRollup 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. +> + +Configures how the .d.ts rollup file will be generated. + +Signature: + +```typescript +dtsRollup?: IConfigDtsRollup; +``` + +## Remarks + +This is part of the [IConfigFile](./api-extractor.iconfigfile.md) structure. + diff --git a/pages/api/api-extractor.iconfigfile.extends.md b/pages/api/api-extractor.iconfigfile.extends.md new file mode 100644 index 000000000..375450e86 --- /dev/null +++ b/pages/api/api-extractor.iconfigfile.extends.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigFile](./api-extractor.iconfigfile.md) > [extends](./api-extractor.iconfigfile.extends.md) + +## IConfigFile.extends property + +Optionally specifies another JSON config file that this file extends from. This provides a way for standard settings to be shared across multiple projects. + +Signature: + +```typescript +extends?: string; +``` + +## Remarks + +If the path starts with `./` or `../`, the path is resolved relative to the folder of the file that contains the `extends` field. Otherwise, the first path segment is interpreted as an NPM package name, and will be resolved using NodeJS `require()`. + diff --git a/pages/api/api-extractor.iconfigfile.mainentrypointfilepath.md b/pages/api/api-extractor.iconfigfile.mainentrypointfilepath.md new file mode 100644 index 000000000..25881e6db --- /dev/null +++ b/pages/api/api-extractor.iconfigfile.mainentrypointfilepath.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigFile](./api-extractor.iconfigfile.md) > [mainEntryPointFilePath](./api-extractor.iconfigfile.mainentrypointfilepath.md) + +## IConfigFile.mainEntryPointFilePath property + +Specifies the .d.ts file to be used as the starting point for analysis. API Extractor analyzes the symbols exported by this module. + +Signature: + +```typescript +mainEntryPointFilePath: string; +``` + +## Remarks + +The file extension must be ".d.ts" and not ".ts". The path is resolved relative to the "projectFolder" location. + diff --git a/pages/api/api-extractor.iconfigfile.md b/pages/api/api-extractor.iconfigfile.md new file mode 100644 index 000000000..5f1d8bc34 --- /dev/null +++ b/pages/api/api-extractor.iconfigfile.md @@ -0,0 +1,34 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigFile](./api-extractor.iconfigfile.md) + +## IConfigFile interface + +Configuration options for the API Extractor tool. These options can be constructed programmatically or loaded from the api-extractor.json config file using the [ExtractorConfig](./api-extractor.extractorconfig.md) class. + +Signature: + +```typescript +export interface IConfigFile +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [apiReport](./api-extractor.iconfigfile.apireport.md) | IConfigApiReport | Configures how the API report files (\*.api.md) will be generated. | +| [compiler](./api-extractor.iconfigfile.compiler.md) | IConfigCompiler | Determines how the TypeScript compiler engine will be invoked by API Extractor. | +| [docModel](./api-extractor.iconfigfile.docmodel.md) | IConfigDocModel | Configures how the doc model file (\*.api.json) will be generated. | +| [dtsRollup](./api-extractor.iconfigfile.dtsrollup.md) | IConfigDtsRollup | (BETA) Configures how the .d.ts rollup file will be generated. | +| [extends](./api-extractor.iconfigfile.extends.md) | string | Optionally specifies another JSON config file that this file extends from. This provides a way for standard settings to be shared across multiple projects. | +| [mainEntryPointFilePath](./api-extractor.iconfigfile.mainentrypointfilepath.md) | string | Specifies the .d.ts file to be used as the starting point for analysis. API Extractor analyzes the symbols exported by this module. | +| [messages](./api-extractor.iconfigfile.messages.md) | IExtractorMessagesConfig | Configures how API Extractor reports error and warning messages produced during analysis. | +| [projectFolder](./api-extractor.iconfigfile.projectfolder.md) | string | Determines the <projectFolder> token that can be used with other config file settings. The project folder typically contains the tsconfig.json and package.json config files, but the path is user-defined. | +| [testMode](./api-extractor.iconfigfile.testmode.md) | boolean | Set to true when invoking API Extractor's test harness. | +| [tsdocMetadata](./api-extractor.iconfigfile.tsdocmetadata.md) | IConfigTsdocMetadata | (BETA) Configures how the tsdoc-metadata.json file will be generated. | + diff --git a/pages/api/api-extractor.iconfigfile.messages.md b/pages/api/api-extractor.iconfigfile.messages.md new file mode 100644 index 000000000..7c7a0f84c --- /dev/null +++ b/pages/api/api-extractor.iconfigfile.messages.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigFile](./api-extractor.iconfigfile.md) > [messages](./api-extractor.iconfigfile.messages.md) + +## IConfigFile.messages property + +Configures how API Extractor reports error and warning messages produced during analysis. + +Signature: + +```typescript +messages?: IExtractorMessagesConfig; +``` + +## Remarks + +This is part of the [IConfigFile](./api-extractor.iconfigfile.md) structure. + diff --git a/pages/api/api-extractor.iconfigfile.projectfolder.md b/pages/api/api-extractor.iconfigfile.projectfolder.md new file mode 100644 index 000000000..2b8fee14f --- /dev/null +++ b/pages/api/api-extractor.iconfigfile.projectfolder.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigFile](./api-extractor.iconfigfile.md) > [projectFolder](./api-extractor.iconfigfile.projectfolder.md) + +## IConfigFile.projectFolder property + +Determines the `` token that can be used with other config file settings. The project folder typically contains the tsconfig.json and package.json config files, but the path is user-defined. + +Signature: + +```typescript +projectFolder?: string; +``` + +## Remarks + +The path is resolved relative to the folder of the config file that contains the setting. + +The default value for `projectFolder` is the token ``, which means the folder is determined by traversing parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder that contains a tsconfig.json file. If a tsconfig.json file cannot be found in this way, then an error will be reported. + diff --git a/pages/api/api-extractor.iconfigfile.testmode.md b/pages/api/api-extractor.iconfigfile.testmode.md new file mode 100644 index 000000000..3b6b41bd8 --- /dev/null +++ b/pages/api/api-extractor.iconfigfile.testmode.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigFile](./api-extractor.iconfigfile.md) > [testMode](./api-extractor.iconfigfile.testmode.md) + +## IConfigFile.testMode property + +Set to true when invoking API Extractor's test harness. + +Signature: + +```typescript +testMode?: boolean; +``` + +## Remarks + +When `testMode` is true, the `toolVersion` field in the .api.json file is assigned an empty string to prevent spurious diffs in output files tracked for tests. + diff --git a/pages/api/api-extractor.iconfigfile.tsdocmetadata.md b/pages/api/api-extractor.iconfigfile.tsdocmetadata.md new file mode 100644 index 000000000..54ab50f69 --- /dev/null +++ b/pages/api/api-extractor.iconfigfile.tsdocmetadata.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigFile](./api-extractor.iconfigfile.md) > [tsdocMetadata](./api-extractor.iconfigfile.tsdocmetadata.md) + +## IConfigFile.tsdocMetadata 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. +> + +Configures how the tsdoc-metadata.json file will be generated. + +Signature: + +```typescript +tsdocMetadata?: IConfigTsdocMetadata; +``` + +## Remarks + +This is part of the [IConfigFile](./api-extractor.iconfigfile.md) structure. + diff --git a/pages/api/api-extractor.iconfigmessagereportingrule.addtoapireportfile.md b/pages/api/api-extractor.iconfigmessagereportingrule.addtoapireportfile.md new file mode 100644 index 000000000..365de3877 --- /dev/null +++ b/pages/api/api-extractor.iconfigmessagereportingrule.addtoapireportfile.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigMessageReportingRule](./api-extractor.iconfigmessagereportingrule.md) > [addToApiReportFile](./api-extractor.iconfigmessagereportingrule.addtoapireportfile.md) + +## IConfigMessageReportingRule.addToApiReportFile property + +When `addToApiReportFile` is true: If API Extractor is configured to write an API report file (.api.md), then the message will be written inside that file; otherwise, the message is instead logged according to the `logLevel` option. + +Signature: + +```typescript +addToApiReportFile?: boolean; +``` diff --git a/pages/api/api-extractor.iconfigmessagereportingrule.loglevel.md b/pages/api/api-extractor.iconfigmessagereportingrule.loglevel.md new file mode 100644 index 000000000..da3c56767 --- /dev/null +++ b/pages/api/api-extractor.iconfigmessagereportingrule.loglevel.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigMessageReportingRule](./api-extractor.iconfigmessagereportingrule.md) > [logLevel](./api-extractor.iconfigmessagereportingrule.loglevel.md) + +## IConfigMessageReportingRule.logLevel property + +Specifies whether the message should be written to the the tool's output log. + +Signature: + +```typescript +logLevel: ExtractorLogLevel; +``` + +## Remarks + +Note that the `addToApiReportFile` property may supersede this option. + diff --git a/pages/api/api-extractor.iconfigmessagereportingrule.md b/pages/api/api-extractor.iconfigmessagereportingrule.md new file mode 100644 index 000000000..e698a3e0c --- /dev/null +++ b/pages/api/api-extractor.iconfigmessagereportingrule.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigMessageReportingRule](./api-extractor.iconfigmessagereportingrule.md) + +## IConfigMessageReportingRule interface + +Configures reporting for a given message identifier. + +Signature: + +```typescript +export interface IConfigMessageReportingRule +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [addToApiReportFile](./api-extractor.iconfigmessagereportingrule.addtoapireportfile.md) | boolean | When addToApiReportFile is true: If API Extractor is configured to write an API report file (.api.md), then the message will be written inside that file; otherwise, the message is instead logged according to the logLevel option. | +| [logLevel](./api-extractor.iconfigmessagereportingrule.loglevel.md) | ExtractorLogLevel | Specifies whether the message should be written to the the tool's output log. | + +## Remarks + +This is part of the [IConfigFile](./api-extractor.iconfigfile.md) structure. + diff --git a/pages/api/api-extractor.iconfigmessagereportingtable.md b/pages/api/api-extractor.iconfigmessagereportingtable.md new file mode 100644 index 000000000..404a7e359 --- /dev/null +++ b/pages/api/api-extractor.iconfigmessagereportingtable.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigMessageReportingTable](./api-extractor.iconfigmessagereportingtable.md) + +## IConfigMessageReportingTable interface + +Specifies a table of reporting rules for different message identifiers, and also the default rule used for identifiers that do not appear in the table. + +Signature: + +```typescript +export interface IConfigMessageReportingTable +``` + +## Remarks + +This is part of the [IConfigFile](./api-extractor.iconfigfile.md) structure. + diff --git a/pages/api/api-extractor.iconfigtsdocmetadata.enabled.md b/pages/api/api-extractor.iconfigtsdocmetadata.enabled.md new file mode 100644 index 000000000..73d3d1896 --- /dev/null +++ b/pages/api/api-extractor.iconfigtsdocmetadata.enabled.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigTsdocMetadata](./api-extractor.iconfigtsdocmetadata.md) > [enabled](./api-extractor.iconfigtsdocmetadata.enabled.md) + +## IConfigTsdocMetadata.enabled property + +Whether to generate the tsdoc-metadata.json file. + +Signature: + +```typescript +enabled: boolean; +``` diff --git a/pages/api/api-extractor.iconfigtsdocmetadata.md b/pages/api/api-extractor.iconfigtsdocmetadata.md new file mode 100644 index 000000000..a1437d0c3 --- /dev/null +++ b/pages/api/api-extractor.iconfigtsdocmetadata.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigTsdocMetadata](./api-extractor.iconfigtsdocmetadata.md) + +## IConfigTsdocMetadata interface + +Configures how the tsdoc-metadata.json file will be generated. + +Signature: + +```typescript +export interface IConfigTsdocMetadata +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [enabled](./api-extractor.iconfigtsdocmetadata.enabled.md) | boolean | Whether to generate the tsdoc-metadata.json file. | +| [tsdocMetadataFilePath](./api-extractor.iconfigtsdocmetadata.tsdocmetadatafilepath.md) | string | Specifies where the TSDoc metadata file should be written. | + +## Remarks + +This is part of the [IConfigFile](./api-extractor.iconfigfile.md) structure. + diff --git a/pages/api/api-extractor.iconfigtsdocmetadata.tsdocmetadatafilepath.md b/pages/api/api-extractor.iconfigtsdocmetadata.tsdocmetadatafilepath.md new file mode 100644 index 000000000..9f457daac --- /dev/null +++ b/pages/api/api-extractor.iconfigtsdocmetadata.tsdocmetadatafilepath.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IConfigTsdocMetadata](./api-extractor.iconfigtsdocmetadata.md) > [tsdocMetadataFilePath](./api-extractor.iconfigtsdocmetadata.tsdocmetadatafilepath.md) + +## IConfigTsdocMetadata.tsdocMetadataFilePath property + +Specifies where the TSDoc metadata file should be written. + +Signature: + +```typescript +tsdocMetadataFilePath?: string; +``` + +## Remarks + +The path is resolved relative to the folder of the config file that contains the setting; to change this, prepend a folder token such as ``. + +The default value is ``, which causes the path to be automatically inferred from the `tsdocMetadata`, `typings` or `main` fields of the project's package.json. If none of these fields are set, the lookup falls back to `tsdoc-metadata.json` in the package folder. + diff --git a/pages/api/api-extractor.iextractorconfigprepareoptions.configobject.md b/pages/api/api-extractor.iextractorconfigprepareoptions.configobject.md new file mode 100644 index 000000000..91fcb0790 --- /dev/null +++ b/pages/api/api-extractor.iextractorconfigprepareoptions.configobject.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorConfigPrepareOptions](./api-extractor.iextractorconfigprepareoptions.md) > [configObject](./api-extractor.iextractorconfigprepareoptions.configobject.md) + +## IExtractorConfigPrepareOptions.configObject property + +A configuration object as returned by [ExtractorConfig.loadFile()](./api-extractor.extractorconfig.loadfile.md). + +Signature: + +```typescript +configObject: IConfigFile; +``` diff --git a/pages/api/api-extractor.iextractorconfigprepareoptions.configobjectfullpath.md b/pages/api/api-extractor.iextractorconfigprepareoptions.configobjectfullpath.md new file mode 100644 index 000000000..428bb88cd --- /dev/null +++ b/pages/api/api-extractor.iextractorconfigprepareoptions.configobjectfullpath.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorConfigPrepareOptions](./api-extractor.iextractorconfigprepareoptions.md) > [configObjectFullPath](./api-extractor.iextractorconfigprepareoptions.configobjectfullpath.md) + +## IExtractorConfigPrepareOptions.configObjectFullPath property + +The absolute path of the file that the `configObject` object was loaded from. This is used for error messages and when probing for `tsconfig.json`. + +Signature: + +```typescript +configObjectFullPath: string | undefined; +``` + +## Remarks + +If this is omitted, then the `projectFolder` must not be specified using the `` token. + diff --git a/pages/api/api-extractor.iextractorconfigprepareoptions.md b/pages/api/api-extractor.iextractorconfigprepareoptions.md new file mode 100644 index 000000000..abd8f514c --- /dev/null +++ b/pages/api/api-extractor.iextractorconfigprepareoptions.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorConfigPrepareOptions](./api-extractor.iextractorconfigprepareoptions.md) + +## IExtractorConfigPrepareOptions interface + +Options for [ExtractorConfig.prepare()](./api-extractor.extractorconfig.prepare.md). + +Signature: + +```typescript +export interface IExtractorConfigPrepareOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [configObject](./api-extractor.iextractorconfigprepareoptions.configobject.md) | IConfigFile | A configuration object as returned by [ExtractorConfig.loadFile()](./api-extractor.extractorconfig.loadfile.md). | +| [configObjectFullPath](./api-extractor.iextractorconfigprepareoptions.configobjectfullpath.md) | string | undefined | The absolute path of the file that the configObject object was loaded from. This is used for error messages and when probing for tsconfig.json. | +| [packageJson](./api-extractor.iextractorconfigprepareoptions.packagejson.md) | INodePackageJson | undefined | 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 packageJson object was loaded from, or undefined if API Extractor was invoked without a package.json file. | + diff --git a/pages/api/api-extractor.iextractorconfigprepareoptions.packagejson.md b/pages/api/api-extractor.iextractorconfigprepareoptions.packagejson.md new file mode 100644 index 000000000..6cc1d1ffe --- /dev/null +++ b/pages/api/api-extractor.iextractorconfigprepareoptions.packagejson.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorConfigPrepareOptions](./api-extractor.iextractorconfigprepareoptions.md) > [packageJson](./api-extractor.iextractorconfigprepareoptions.packagejson.md) + +## IExtractorConfigPrepareOptions.packageJson property + +The parsed package.json file for the working package, or undefined if API Extractor was invoked without a package.json file. + +Signature: + +```typescript +packageJson?: INodePackageJson | undefined; +``` + +## Remarks + +If omitted, then the `` and `` tokens will have default values. + diff --git a/pages/api/api-extractor.iextractorconfigprepareoptions.packagejsonfullpath.md b/pages/api/api-extractor.iextractorconfigprepareoptions.packagejsonfullpath.md new file mode 100644 index 000000000..58b1db92d --- /dev/null +++ b/pages/api/api-extractor.iextractorconfigprepareoptions.packagejsonfullpath.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorConfigPrepareOptions](./api-extractor.iextractorconfigprepareoptions.md) > [packageJsonFullPath](./api-extractor.iextractorconfigprepareoptions.packagejsonfullpath.md) + +## IExtractorConfigPrepareOptions.packageJsonFullPath property + +The absolute path of the file that the `packageJson` object was loaded from, or undefined if API Extractor was invoked without a package.json file. + +Signature: + +```typescript +packageJsonFullPath: string | undefined; +``` + +## Remarks + +This is used for error messages and when resolving paths found in package.json. + +If `packageJsonFullPath` is specified but `packageJson` is omitted, the file will be loaded automatically. + diff --git a/pages/api/api-extractor.iextractorinvokeoptions.compilerstate.md b/pages/api/api-extractor.iextractorinvokeoptions.compilerstate.md new file mode 100644 index 000000000..c3d70b331 --- /dev/null +++ b/pages/api/api-extractor.iextractorinvokeoptions.compilerstate.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorInvokeOptions](./api-extractor.iextractorinvokeoptions.md) > [compilerState](./api-extractor.iextractorinvokeoptions.compilerstate.md) + +## IExtractorInvokeOptions.compilerState property + +An optional TypeScript compiler state. This allows an optimization where multiple invocations of API Extractor can reuse the same TypeScript compiler analysis. + +Signature: + +```typescript +compilerState?: CompilerState; +``` diff --git a/pages/api/api-extractor.iextractorinvokeoptions.localbuild.md b/pages/api/api-extractor.iextractorinvokeoptions.localbuild.md new file mode 100644 index 000000000..169e6cbb0 --- /dev/null +++ b/pages/api/api-extractor.iextractorinvokeoptions.localbuild.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorInvokeOptions](./api-extractor.iextractorinvokeoptions.md) > [localBuild](./api-extractor.iextractorinvokeoptions.localbuild.md) + +## IExtractorInvokeOptions.localBuild property + +Indicates that API Extractor is running as part of a local build, e.g. on developer's machine. + +Signature: + +```typescript +localBuild?: boolean; +``` + +## Remarks + +This disables certain validation that would normally be performed for a ship/production build. For example, the \*.api.md report file is automatically updated in a local build. + +The default value is false. + diff --git a/pages/api/api-extractor.iextractorinvokeoptions.md b/pages/api/api-extractor.iextractorinvokeoptions.md new file mode 100644 index 000000000..f3f84aca1 --- /dev/null +++ b/pages/api/api-extractor.iextractorinvokeoptions.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorInvokeOptions](./api-extractor.iextractorinvokeoptions.md) + +## IExtractorInvokeOptions interface + +Runtime options for Extractor. + +Signature: + +```typescript +export interface IExtractorInvokeOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [compilerState](./api-extractor.iextractorinvokeoptions.compilerstate.md) | CompilerState | An optional TypeScript compiler state. This allows an optimization where multiple invocations of API Extractor can reuse the same TypeScript compiler analysis. | +| [localBuild](./api-extractor.iextractorinvokeoptions.localbuild.md) | boolean | Indicates that API Extractor is running as part of a local build, e.g. on developer's machine. | +| [messageCallback](./api-extractor.iextractorinvokeoptions.messagecallback.md) | (message: ExtractorMessage) => void | An optional callback function that will be called for each ExtractorMessage before it is displayed by API Extractor. The callback can customize the message, handle it, or discard it. | +| [showDiagnostics](./api-extractor.iextractorinvokeoptions.showdiagnostics.md) | boolean | If true, API Extractor will print diagnostic information used for troubleshooting problems. These messages will be included as [ExtractorLogLevel.Verbose](./api-extractor.extractorloglevel.verbose.md) output. | +| [showVerboseMessages](./api-extractor.iextractorinvokeoptions.showverbosemessages.md) | boolean | If true, API Extractor will include [ExtractorLogLevel.Verbose](./api-extractor.extractorloglevel.verbose.md) messages in its output. | +| [typescriptCompilerFolder](./api-extractor.iextractorinvokeoptions.typescriptcompilerfolder.md) | string | Specifies an alternate folder path to be used when loading the TypeScript system typings. | + diff --git a/pages/api/api-extractor.iextractorinvokeoptions.messagecallback.md b/pages/api/api-extractor.iextractorinvokeoptions.messagecallback.md new file mode 100644 index 000000000..d7a78b530 --- /dev/null +++ b/pages/api/api-extractor.iextractorinvokeoptions.messagecallback.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorInvokeOptions](./api-extractor.iextractorinvokeoptions.md) > [messageCallback](./api-extractor.iextractorinvokeoptions.messagecallback.md) + +## IExtractorInvokeOptions.messageCallback property + +An optional callback function that will be called for each `ExtractorMessage` before it is displayed by API Extractor. The callback can customize the message, handle it, or discard it. + +Signature: + +```typescript +messageCallback?: (message: ExtractorMessage) => void; +``` + +## Remarks + +If a `messageCallback` is not provided, then by default API Extractor will print the messages to the STDERR/STDOUT console. + diff --git a/pages/api/api-extractor.iextractorinvokeoptions.showdiagnostics.md b/pages/api/api-extractor.iextractorinvokeoptions.showdiagnostics.md new file mode 100644 index 000000000..3e2e6058d --- /dev/null +++ b/pages/api/api-extractor.iextractorinvokeoptions.showdiagnostics.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorInvokeOptions](./api-extractor.iextractorinvokeoptions.md) > [showDiagnostics](./api-extractor.iextractorinvokeoptions.showdiagnostics.md) + +## IExtractorInvokeOptions.showDiagnostics property + +If true, API Extractor will print diagnostic information used for troubleshooting problems. These messages will be included as [ExtractorLogLevel.Verbose](./api-extractor.extractorloglevel.verbose.md) output. + +Signature: + +```typescript +showDiagnostics?: boolean; +``` + +## Remarks + +Setting `showDiagnostics=true` forces `showVerboseMessages=true`. + diff --git a/pages/api/api-extractor.iextractorinvokeoptions.showverbosemessages.md b/pages/api/api-extractor.iextractorinvokeoptions.showverbosemessages.md new file mode 100644 index 000000000..5b1ced8f7 --- /dev/null +++ b/pages/api/api-extractor.iextractorinvokeoptions.showverbosemessages.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorInvokeOptions](./api-extractor.iextractorinvokeoptions.md) > [showVerboseMessages](./api-extractor.iextractorinvokeoptions.showverbosemessages.md) + +## IExtractorInvokeOptions.showVerboseMessages property + +If true, API Extractor will include [ExtractorLogLevel.Verbose](./api-extractor.extractorloglevel.verbose.md) messages in its output. + +Signature: + +```typescript +showVerboseMessages?: boolean; +``` diff --git a/pages/api/api-extractor.iextractorinvokeoptions.typescriptcompilerfolder.md b/pages/api/api-extractor.iextractorinvokeoptions.typescriptcompilerfolder.md new file mode 100644 index 000000000..fa14f00e7 --- /dev/null +++ b/pages/api/api-extractor.iextractorinvokeoptions.typescriptcompilerfolder.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorInvokeOptions](./api-extractor.iextractorinvokeoptions.md) > [typescriptCompilerFolder](./api-extractor.iextractorinvokeoptions.typescriptcompilerfolder.md) + +## IExtractorInvokeOptions.typescriptCompilerFolder property + +Specifies an alternate folder path to be used when loading the TypeScript system typings. + +Signature: + +```typescript +typescriptCompilerFolder?: string; +``` + +## Remarks + +API Extractor uses its own TypeScript compiler engine to analyze your project. If your project is built with a significantly different TypeScript version, sometimes API Extractor may report compilation errors due to differences in the system typings (e.g. lib.dom.d.ts). You can use the "--typescriptCompilerFolder" option to specify the folder path where you installed the TypeScript package, and API Extractor's compiler will use those system typings instead. + diff --git a/pages/api/api-extractor.iextractormessageproperties.exportname.md b/pages/api/api-extractor.iextractormessageproperties.exportname.md new file mode 100644 index 000000000..8213af743 --- /dev/null +++ b/pages/api/api-extractor.iextractormessageproperties.exportname.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorMessageProperties](./api-extractor.iextractormessageproperties.md) > [exportName](./api-extractor.iextractormessageproperties.exportname.md) + +## IExtractorMessageProperties.exportName property + +A declaration can have multiple names if it is exported more than once. If an `ExtractorMessage` applies to a specific export name, this property can indicate that. + +Signature: + +```typescript +readonly exportName?: string; +``` + +## Remarks + +Used by [ExtractorMessageId.InternalMissingUnderscore](./api-extractor.extractormessageid.internalmissingunderscore.md). + diff --git a/pages/api/api-extractor.iextractormessageproperties.md b/pages/api/api-extractor.iextractormessageproperties.md new file mode 100644 index 000000000..a813c01f9 --- /dev/null +++ b/pages/api/api-extractor.iextractormessageproperties.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorMessageProperties](./api-extractor.iextractormessageproperties.md) + +## IExtractorMessageProperties interface + +Used by [ExtractorMessage.properties](./api-extractor.extractormessage.properties.md). + +Signature: + +```typescript +export interface IExtractorMessageProperties +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [exportName](./api-extractor.iextractormessageproperties.exportname.md) | string | A declaration can have multiple names if it is exported more than once. If an ExtractorMessage applies to a specific export name, this property can indicate that. | + diff --git a/pages/api/api-extractor.iextractormessagesconfig.compilermessagereporting.md b/pages/api/api-extractor.iextractormessagesconfig.compilermessagereporting.md new file mode 100644 index 000000000..6c4d0e284 --- /dev/null +++ b/pages/api/api-extractor.iextractormessagesconfig.compilermessagereporting.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorMessagesConfig](./api-extractor.iextractormessagesconfig.md) > [compilerMessageReporting](./api-extractor.iextractormessagesconfig.compilermessagereporting.md) + +## IExtractorMessagesConfig.compilerMessageReporting property + +Configures handling of diagnostic messages generating the TypeScript compiler while analyzing the input .d.ts files. + +Signature: + +```typescript +compilerMessageReporting?: IConfigMessageReportingTable; +``` diff --git a/pages/api/api-extractor.iextractormessagesconfig.extractormessagereporting.md b/pages/api/api-extractor.iextractormessagesconfig.extractormessagereporting.md new file mode 100644 index 000000000..5b00cdf7d --- /dev/null +++ b/pages/api/api-extractor.iextractormessagesconfig.extractormessagereporting.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorMessagesConfig](./api-extractor.iextractormessagesconfig.md) > [extractorMessageReporting](./api-extractor.iextractormessagesconfig.extractormessagereporting.md) + +## IExtractorMessagesConfig.extractorMessageReporting property + +Configures handling of messages reported by API Extractor during its analysis. + +Signature: + +```typescript +extractorMessageReporting?: IConfigMessageReportingTable; +``` diff --git a/pages/api/api-extractor.iextractormessagesconfig.md b/pages/api/api-extractor.iextractormessagesconfig.md new file mode 100644 index 000000000..caa79d1c3 --- /dev/null +++ b/pages/api/api-extractor.iextractormessagesconfig.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorMessagesConfig](./api-extractor.iextractormessagesconfig.md) + +## IExtractorMessagesConfig interface + +Configures how API Extractor reports error and warning messages produced during analysis. + +Signature: + +```typescript +export interface IExtractorMessagesConfig +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [compilerMessageReporting](./api-extractor.iextractormessagesconfig.compilermessagereporting.md) | IConfigMessageReportingTable | Configures handling of diagnostic messages generating the TypeScript compiler while analyzing the input .d.ts files. | +| [extractorMessageReporting](./api-extractor.iextractormessagesconfig.extractormessagereporting.md) | IConfigMessageReportingTable | Configures handling of messages reported by API Extractor during its analysis. | +| [tsdocMessageReporting](./api-extractor.iextractormessagesconfig.tsdocmessagereporting.md) | IConfigMessageReportingTable | Configures handling of messages reported by the TSDoc parser when analyzing code comments. | + +## Remarks + +This is part of the [IConfigFile](./api-extractor.iconfigfile.md) structure. + diff --git a/pages/api/api-extractor.iextractormessagesconfig.tsdocmessagereporting.md b/pages/api/api-extractor.iextractormessagesconfig.tsdocmessagereporting.md new file mode 100644 index 000000000..d054e6da3 --- /dev/null +++ b/pages/api/api-extractor.iextractormessagesconfig.tsdocmessagereporting.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) > [IExtractorMessagesConfig](./api-extractor.iextractormessagesconfig.md) > [tsdocMessageReporting](./api-extractor.iextractormessagesconfig.tsdocmessagereporting.md) + +## IExtractorMessagesConfig.tsdocMessageReporting property + +Configures handling of messages reported by the TSDoc parser when analyzing code comments. + +Signature: + +```typescript +tsdocMessageReporting?: IConfigMessageReportingTable; +``` diff --git a/pages/api/api-extractor.md b/pages/api/api-extractor.md new file mode 100644 index 000000000..222525695 --- /dev/null +++ b/pages/api/api-extractor.md @@ -0,0 +1,50 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/api-extractor](./api-extractor.md) + +## api-extractor package + +API Extractor helps you build better TypeScript library packages. It helps with validation, documentation, and reviewing of the exported API for a TypeScript library. + +## Classes + +| Class | Description | +| --- | --- | +| [CompilerState](./api-extractor.compilerstate.md) | This class represents the TypeScript compiler state. This allows an optimization where multiple invocations of API Extractor can reuse the same TypeScript compiler analysis. | +| [Extractor](./api-extractor.extractor.md) | The starting point for invoking the API Extractor tool. | +| [ExtractorConfig](./api-extractor.extractorconfig.md) | The ExtractorConfig class loads, validates, interprets, and represents the api-extractor.json config file. | +| [ExtractorMessage](./api-extractor.extractormessage.md) | This object is used to report an error or warning that occurred during API Extractor's analysis. | +| [ExtractorResult](./api-extractor.extractorresult.md) | This object represents the outcome of an invocation of API Extractor. | + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [ConsoleMessageId](./api-extractor.consolemessageid.md) | Unique identifiers for console messages reported by API Extractor. | +| [ExtractorLogLevel](./api-extractor.extractorloglevel.md) | Used with [IConfigMessageReportingRule.logLevel](./api-extractor.iconfigmessagereportingrule.loglevel.md) and [IExtractorInvokeOptions.messageCallback](./api-extractor.iextractorinvokeoptions.messagecallback.md). | +| [ExtractorMessageCategory](./api-extractor.extractormessagecategory.md) | Specifies a category of messages for use with [ExtractorMessage](./api-extractor.extractormessage.md). | +| [ExtractorMessageId](./api-extractor.extractormessageid.md) | Unique identifiers for messages reported by API Extractor during its analysis. | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [ICompilerStateCreateOptions](./api-extractor.icompilerstatecreateoptions.md) | Options for [CompilerState.create()](./api-extractor.compilerstate.create.md) | +| [IConfigApiReport](./api-extractor.iconfigapireport.md) | Configures how the API report files (\*.api.md) will be generated. | +| [IConfigCompiler](./api-extractor.iconfigcompiler.md) | Determines how the TypeScript compiler engine will be invoked by API Extractor. | +| [IConfigDocModel](./api-extractor.iconfigdocmodel.md) | Configures how the doc model file (\*.api.json) will be generated. | +| [IConfigDtsRollup](./api-extractor.iconfigdtsrollup.md) | Configures how the .d.ts rollup file will be generated. | +| [IConfigFile](./api-extractor.iconfigfile.md) | Configuration options for the API Extractor tool. These options can be constructed programmatically or loaded from the api-extractor.json config file using the [ExtractorConfig](./api-extractor.extractorconfig.md) class. | +| [IConfigMessageReportingRule](./api-extractor.iconfigmessagereportingrule.md) | Configures reporting for a given message identifier. | +| [IConfigMessageReportingTable](./api-extractor.iconfigmessagereportingtable.md) | Specifies a table of reporting rules for different message identifiers, and also the default rule used for identifiers that do not appear in the table. | +| [IConfigTsdocMetadata](./api-extractor.iconfigtsdocmetadata.md) | Configures how the tsdoc-metadata.json file will be generated. | +| [IExtractorConfigPrepareOptions](./api-extractor.iextractorconfigprepareoptions.md) | Options for [ExtractorConfig.prepare()](./api-extractor.extractorconfig.prepare.md). | +| [IExtractorInvokeOptions](./api-extractor.iextractorinvokeoptions.md) | Runtime options for Extractor. | +| [IExtractorMessageProperties](./api-extractor.iextractormessageproperties.md) | Used by [ExtractorMessage.properties](./api-extractor.extractormessage.properties.md). | +| [IExtractorMessagesConfig](./api-extractor.iextractormessagesconfig.md) | Configures how API Extractor reports error and warning messages produced during analysis. | + diff --git a/pages/api/index.md b/pages/api/index.md new file mode 100644 index 000000000..a03ef13f5 --- /dev/null +++ b/pages/api/index.md @@ -0,0 +1,24 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) + +## API Reference + +## Packages + +| Package | Description | +| --- | --- | +| [@microsoft/api-documenter](./api-documenter.md) | | +| [@microsoft/api-extractor](./api-extractor.md) | API Extractor helps you build better TypeScript library packages. It helps with validation, documentation, and reviewing of the exported API for a TypeScript library. | +| [@microsoft/api-extractor-model](./api-extractor-model.md) | API Extractor helps you build better TypeScript library packages. It helps with validation, documentation, and reviewing of the exported API for a TypeScript library. | +| [@microsoft/node-core-library](./node-core-library.md) | Core libraries that every NodeJS toolchain project should use. | +| [@microsoft/package-deps-hash](./package-deps-hash.md) | | +| [@microsoft/rush-lib](./rush-lib.md) | A library for writing scripts that interact with the Rush tool. | +| [@microsoft/stream-collator](./stream-collator.md) | | +| [@microsoft/ts-command-line](./ts-command-line.md) | An object-oriented command-line parser for TypeScript projects. | + diff --git a/pages/api/node-core-library.callback.md b/pages/api/node-core-library.callback.md new file mode 100644 index 000000000..b507f6d00 --- /dev/null +++ b/pages/api/node-core-library.callback.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [callback](./node-core-library.callback.md) + +## callback type + +> 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. +> + +Callback used by [LegacyAdapters](./node-core-library.legacyadapters.md). + +Signature: + +```typescript +export declare type callback = (error: TError, result: TResult) => void; +``` diff --git a/pages/api/node-core-library.colors.black.md b/pages/api/node-core-library.colors.black.md new file mode 100644 index 000000000..4e7719380 --- /dev/null +++ b/pages/api/node-core-library.colors.black.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [black](./node-core-library.colors.black.md) + +## Colors.black() method + +> 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. +> + +Signature: + +```typescript +static black(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.blackbackground.md b/pages/api/node-core-library.colors.blackbackground.md new file mode 100644 index 000000000..a13a4b360 --- /dev/null +++ b/pages/api/node-core-library.colors.blackbackground.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [blackBackground](./node-core-library.colors.blackbackground.md) + +## Colors.blackBackground() method + +> 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. +> + +Signature: + +```typescript +static blackBackground(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.blink.md b/pages/api/node-core-library.colors.blink.md new file mode 100644 index 000000000..f96af0810 --- /dev/null +++ b/pages/api/node-core-library.colors.blink.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [blink](./node-core-library.colors.blink.md) + +## Colors.blink() method + +> 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. +> + +Signature: + +```typescript +static blink(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.blue.md b/pages/api/node-core-library.colors.blue.md new file mode 100644 index 000000000..86048ee2b --- /dev/null +++ b/pages/api/node-core-library.colors.blue.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [blue](./node-core-library.colors.blue.md) + +## Colors.blue() method + +> 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. +> + +Signature: + +```typescript +static blue(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.bluebackground.md b/pages/api/node-core-library.colors.bluebackground.md new file mode 100644 index 000000000..f71b9772c --- /dev/null +++ b/pages/api/node-core-library.colors.bluebackground.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [blueBackground](./node-core-library.colors.bluebackground.md) + +## Colors.blueBackground() method + +> 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. +> + +Signature: + +```typescript +static blueBackground(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.bold.md b/pages/api/node-core-library.colors.bold.md new file mode 100644 index 000000000..8d76bdd2e --- /dev/null +++ b/pages/api/node-core-library.colors.bold.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [bold](./node-core-library.colors.bold.md) + +## Colors.bold() method + +> 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. +> + +Signature: + +```typescript +static bold(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.cyan.md b/pages/api/node-core-library.colors.cyan.md new file mode 100644 index 000000000..5c5f5a014 --- /dev/null +++ b/pages/api/node-core-library.colors.cyan.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [cyan](./node-core-library.colors.cyan.md) + +## Colors.cyan() method + +> 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. +> + +Signature: + +```typescript +static cyan(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.cyanbackground.md b/pages/api/node-core-library.colors.cyanbackground.md new file mode 100644 index 000000000..d0d31bcd2 --- /dev/null +++ b/pages/api/node-core-library.colors.cyanbackground.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [cyanBackground](./node-core-library.colors.cyanbackground.md) + +## Colors.cyanBackground() method + +> 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. +> + +Signature: + +```typescript +static cyanBackground(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.dim.md b/pages/api/node-core-library.colors.dim.md new file mode 100644 index 000000000..9d7f8991a --- /dev/null +++ b/pages/api/node-core-library.colors.dim.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [dim](./node-core-library.colors.dim.md) + +## Colors.dim() method + +> 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. +> + +Signature: + +```typescript +static dim(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.gray.md b/pages/api/node-core-library.colors.gray.md new file mode 100644 index 000000000..999354202 --- /dev/null +++ b/pages/api/node-core-library.colors.gray.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [gray](./node-core-library.colors.gray.md) + +## Colors.gray() method + +> 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. +> + +Signature: + +```typescript +static gray(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.graybackground.md b/pages/api/node-core-library.colors.graybackground.md new file mode 100644 index 000000000..948f4540f --- /dev/null +++ b/pages/api/node-core-library.colors.graybackground.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [grayBackground](./node-core-library.colors.graybackground.md) + +## Colors.grayBackground() method + +> 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. +> + +Signature: + +```typescript +static grayBackground(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.green.md b/pages/api/node-core-library.colors.green.md new file mode 100644 index 000000000..b40ca4b60 --- /dev/null +++ b/pages/api/node-core-library.colors.green.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [green](./node-core-library.colors.green.md) + +## Colors.green() method + +> 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. +> + +Signature: + +```typescript +static green(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.greenbackground.md b/pages/api/node-core-library.colors.greenbackground.md new file mode 100644 index 000000000..c0495b78f --- /dev/null +++ b/pages/api/node-core-library.colors.greenbackground.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [greenBackground](./node-core-library.colors.greenbackground.md) + +## Colors.greenBackground() method + +> 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. +> + +Signature: + +```typescript +static greenBackground(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.hidden.md b/pages/api/node-core-library.colors.hidden.md new file mode 100644 index 000000000..8ecc7f8f2 --- /dev/null +++ b/pages/api/node-core-library.colors.hidden.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [hidden](./node-core-library.colors.hidden.md) + +## Colors.hidden() method + +> 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. +> + +Signature: + +```typescript +static hidden(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.invertcolor.md b/pages/api/node-core-library.colors.invertcolor.md new file mode 100644 index 000000000..49a734008 --- /dev/null +++ b/pages/api/node-core-library.colors.invertcolor.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [invertColor](./node-core-library.colors.invertcolor.md) + +## Colors.invertColor() method + +> 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. +> + +Signature: + +```typescript +static invertColor(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.magenta.md b/pages/api/node-core-library.colors.magenta.md new file mode 100644 index 000000000..de116591c --- /dev/null +++ b/pages/api/node-core-library.colors.magenta.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [magenta](./node-core-library.colors.magenta.md) + +## Colors.magenta() method + +> 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. +> + +Signature: + +```typescript +static magenta(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.magentabackground.md b/pages/api/node-core-library.colors.magentabackground.md new file mode 100644 index 000000000..be76ad996 --- /dev/null +++ b/pages/api/node-core-library.colors.magentabackground.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [magentaBackground](./node-core-library.colors.magentabackground.md) + +## Colors.magentaBackground() method + +> 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. +> + +Signature: + +```typescript +static magentaBackground(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.md b/pages/api/node-core-library.colors.md new file mode 100644 index 000000000..402c60410 --- /dev/null +++ b/pages/api/node-core-library.colors.md @@ -0,0 +1,55 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) + +## Colors class + +> 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. +> + +The static functions on this class are used to produce colored text for use with the node-core-library terminal. + +Signature: + +```typescript +export declare class Colors +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [black(text)](./node-core-library.colors.black.md) | static | (BETA) | +| [blackBackground(text)](./node-core-library.colors.blackbackground.md) | static | (BETA) | +| [blink(text)](./node-core-library.colors.blink.md) | static | (BETA) | +| [blue(text)](./node-core-library.colors.blue.md) | static | (BETA) | +| [blueBackground(text)](./node-core-library.colors.bluebackground.md) | static | (BETA) | +| [bold(text)](./node-core-library.colors.bold.md) | static | (BETA) | +| [cyan(text)](./node-core-library.colors.cyan.md) | static | (BETA) | +| [cyanBackground(text)](./node-core-library.colors.cyanbackground.md) | static | (BETA) | +| [dim(text)](./node-core-library.colors.dim.md) | static | (BETA) | +| [gray(text)](./node-core-library.colors.gray.md) | static | (BETA) | +| [grayBackground(text)](./node-core-library.colors.graybackground.md) | static | (BETA) | +| [green(text)](./node-core-library.colors.green.md) | static | (BETA) | +| [greenBackground(text)](./node-core-library.colors.greenbackground.md) | static | (BETA) | +| [hidden(text)](./node-core-library.colors.hidden.md) | static | (BETA) | +| [invertColor(text)](./node-core-library.colors.invertcolor.md) | static | (BETA) | +| [magenta(text)](./node-core-library.colors.magenta.md) | static | (BETA) | +| [magentaBackground(text)](./node-core-library.colors.magentabackground.md) | static | (BETA) | +| [red(text)](./node-core-library.colors.red.md) | static | (BETA) | +| [redBackground(text)](./node-core-library.colors.redbackground.md) | static | (BETA) | +| [underline(text)](./node-core-library.colors.underline.md) | static | (BETA) | +| [white(text)](./node-core-library.colors.white.md) | static | (BETA) | +| [whiteBackground(text)](./node-core-library.colors.whitebackground.md) | static | (BETA) | +| [yellow(text)](./node-core-library.colors.yellow.md) | static | (BETA) | +| [yellowBackground(text)](./node-core-library.colors.yellowbackground.md) | static | (BETA) | + +## Example + +terminal.writeLine(Colors.green('Green Text!'), ' ', Colors.blue('Blue Text!')); + diff --git a/pages/api/node-core-library.colors.red.md b/pages/api/node-core-library.colors.red.md new file mode 100644 index 000000000..d749f5d1e --- /dev/null +++ b/pages/api/node-core-library.colors.red.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [red](./node-core-library.colors.red.md) + +## Colors.red() method + +> 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. +> + +Signature: + +```typescript +static red(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.redbackground.md b/pages/api/node-core-library.colors.redbackground.md new file mode 100644 index 000000000..9b6a7903b --- /dev/null +++ b/pages/api/node-core-library.colors.redbackground.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [redBackground](./node-core-library.colors.redbackground.md) + +## Colors.redBackground() method + +> 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. +> + +Signature: + +```typescript +static redBackground(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.underline.md b/pages/api/node-core-library.colors.underline.md new file mode 100644 index 000000000..a35a4ceb6 --- /dev/null +++ b/pages/api/node-core-library.colors.underline.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [underline](./node-core-library.colors.underline.md) + +## Colors.underline() method + +> 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. +> + +Signature: + +```typescript +static underline(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.white.md b/pages/api/node-core-library.colors.white.md new file mode 100644 index 000000000..9eb1f78dd --- /dev/null +++ b/pages/api/node-core-library.colors.white.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [white](./node-core-library.colors.white.md) + +## Colors.white() method + +> 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. +> + +Signature: + +```typescript +static white(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.whitebackground.md b/pages/api/node-core-library.colors.whitebackground.md new file mode 100644 index 000000000..4cdf5bc8a --- /dev/null +++ b/pages/api/node-core-library.colors.whitebackground.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [whiteBackground](./node-core-library.colors.whitebackground.md) + +## Colors.whiteBackground() method + +> 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. +> + +Signature: + +```typescript +static whiteBackground(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.yellow.md b/pages/api/node-core-library.colors.yellow.md new file mode 100644 index 000000000..14955435d --- /dev/null +++ b/pages/api/node-core-library.colors.yellow.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [yellow](./node-core-library.colors.yellow.md) + +## Colors.yellow() method + +> 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. +> + +Signature: + +```typescript +static yellow(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colors.yellowbackground.md b/pages/api/node-core-library.colors.yellowbackground.md new file mode 100644 index 000000000..76fe230a2 --- /dev/null +++ b/pages/api/node-core-library.colors.yellowbackground.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Colors](./node-core-library.colors.md) > [yellowBackground](./node-core-library.colors.yellowbackground.md) + +## Colors.yellowBackground() method + +> 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. +> + +Signature: + +```typescript +static yellowBackground(text: string | IColorableSequence): IColorableSequence; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | IColorableSequence | | + +Returns: + +`IColorableSequence` + diff --git a/pages/api/node-core-library.colorvalue.md b/pages/api/node-core-library.colorvalue.md new file mode 100644 index 000000000..4fb20dfee --- /dev/null +++ b/pages/api/node-core-library.colorvalue.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ColorValue](./node-core-library.colorvalue.md) + +## ColorValue enum + +> 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. +> + +Colors used with [IColorableSequence](./node-core-library.icolorablesequence.md). + +Signature: + +```typescript +export declare enum ColorValue +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Black | 0 | (BETA) | +| Blue | 4 | (BETA) | +| Cyan | 6 | (BETA) | +| Gray | 8 | (BETA) | +| Green | 2 | (BETA) | +| Magenta | 5 | (BETA) | +| Red | 1 | (BETA) | +| White | 7 | (BETA) | +| Yellow | 3 | (BETA) | + diff --git a/pages/api/node-core-library.consoleterminalprovider._constructor_.md b/pages/api/node-core-library.consoleterminalprovider._constructor_.md new file mode 100644 index 000000000..84dc76688 --- /dev/null +++ b/pages/api/node-core-library.consoleterminalprovider._constructor_.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ConsoleTerminalProvider](./node-core-library.consoleterminalprovider.md) > [(constructor)](./node-core-library.consoleterminalprovider._constructor_.md) + +## ConsoleTerminalProvider.(constructor) + +> 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. +> + +Constructs a new instance of the `ConsoleTerminalProvider` class + +Signature: + +```typescript +constructor(options?: Partial); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | Partial<IConsoleTerminalProviderOptions> | | + diff --git a/pages/api/node-core-library.consoleterminalprovider.eolcharacter.md b/pages/api/node-core-library.consoleterminalprovider.eolcharacter.md new file mode 100644 index 000000000..2b62a9dff --- /dev/null +++ b/pages/api/node-core-library.consoleterminalprovider.eolcharacter.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ConsoleTerminalProvider](./node-core-library.consoleterminalprovider.md) > [eolCharacter](./node-core-library.consoleterminalprovider.eolcharacter.md) + +## ConsoleTerminalProvider.eolCharacter property + +> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> + +This property should return the newline character the terminal provider expects. + +Signature: + +```typescript +readonly eolCharacter: string; +``` diff --git a/pages/api/node-core-library.consoleterminalprovider.md b/pages/api/node-core-library.consoleterminalprovider.md new file mode 100644 index 000000000..a2eb1e5bd --- /dev/null +++ b/pages/api/node-core-library.consoleterminalprovider.md @@ -0,0 +1,42 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ConsoleTerminalProvider](./node-core-library.consoleterminalprovider.md) + +## ConsoleTerminalProvider class + +> 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. +> + +Terminal provider that prints to STDOUT (for log- and verbose-level messages) and STDERR (for warning- and error-level messsages). + +Signature: + +```typescript +export declare class ConsoleTerminalProvider implements ITerminalProvider +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./node-core-library.consoleterminalprovider._constructor_.md) | | (BETA) Constructs a new instance of the ConsoleTerminalProvider class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [eolCharacter](./node-core-library.consoleterminalprovider.eolcharacter.md) | | string | (BETA) This property should return the newline character the terminal provider expects. | +| [supportsColor](./node-core-library.consoleterminalprovider.supportscolor.md) | | boolean | (BETA) This property should return true only if the terminal provider supports rendering console colors. | +| [verboseEnabled](./node-core-library.consoleterminalprovider.verboseenabled.md) | | boolean | (BETA) If true, verbose-level messages should be written to the console. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [write(data, severity)](./node-core-library.consoleterminalprovider.write.md) | | (BETA) This function gets called on every terminal provider upon every message function call on the terminal instance. | + diff --git a/pages/api/node-core-library.consoleterminalprovider.supportscolor.md b/pages/api/node-core-library.consoleterminalprovider.supportscolor.md new file mode 100644 index 000000000..c4be3633c --- /dev/null +++ b/pages/api/node-core-library.consoleterminalprovider.supportscolor.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ConsoleTerminalProvider](./node-core-library.consoleterminalprovider.md) > [supportsColor](./node-core-library.consoleterminalprovider.supportscolor.md) + +## ConsoleTerminalProvider.supportsColor property + +> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> + +This property should return true only if the terminal provider supports rendering console colors. + +Signature: + +```typescript +readonly supportsColor: boolean; +``` diff --git a/pages/api/node-core-library.consoleterminalprovider.verboseenabled.md b/pages/api/node-core-library.consoleterminalprovider.verboseenabled.md new file mode 100644 index 000000000..a624f9ddf --- /dev/null +++ b/pages/api/node-core-library.consoleterminalprovider.verboseenabled.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ConsoleTerminalProvider](./node-core-library.consoleterminalprovider.md) > [verboseEnabled](./node-core-library.consoleterminalprovider.verboseenabled.md) + +## ConsoleTerminalProvider.verboseEnabled 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 true, verbose-level messages should be written to the console. + +Signature: + +```typescript +verboseEnabled: boolean; +``` diff --git a/pages/api/node-core-library.consoleterminalprovider.write.md b/pages/api/node-core-library.consoleterminalprovider.write.md new file mode 100644 index 000000000..7457fa57b --- /dev/null +++ b/pages/api/node-core-library.consoleterminalprovider.write.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ConsoleTerminalProvider](./node-core-library.consoleterminalprovider.md) > [write](./node-core-library.consoleterminalprovider.write.md) + +## ConsoleTerminalProvider.write() method + +> 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 gets called on every terminal provider upon every message function call on the terminal instance. + +Signature: + +```typescript +write(data: string, severity: TerminalProviderSeverity): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| data | string | The terminal message. | +| severity | TerminalProviderSeverity | The message severity. Terminal providers can route different kinds of messages to different streams and may choose to ignore verbose messages. | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.encoding.md b/pages/api/node-core-library.encoding.md new file mode 100644 index 000000000..b14800d79 --- /dev/null +++ b/pages/api/node-core-library.encoding.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Encoding](./node-core-library.encoding.md) + +## Encoding enum + +The allowed types of encodings, as supported by Node.js + +Signature: + +```typescript +export declare const enum Encoding +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Utf8 | "utf8" | | + diff --git a/pages/api/node-core-library.executable.md b/pages/api/node-core-library.executable.md new file mode 100644 index 000000000..914a4bb27 --- /dev/null +++ b/pages/api/node-core-library.executable.md @@ -0,0 +1,40 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Executable](./node-core-library.executable.md) + +## Executable class + +The Executable class provides a safe, portable, recommended solution for tools that need to launch child processes. + +Signature: + +```typescript +export declare class Executable +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [spawnSync(filename, args, options)](./node-core-library.executable.spawnsync.md) | static | Synchronously create a child process and optionally capture its output. | +| [tryResolve(filename, options)](./node-core-library.executable.tryresolve.md) | static | 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. | + +## Remarks + +The NodeJS child\_process API provides a solution for launching child processes, however its design encourages reliance on the operating system shell for certain features. Invoking the OS shell is not safe, not portable, and generally not recommended: + +- Different shells have different behavior and command-line syntax, and which shell you will get with NodeJS is unpredictable. There is no universal shell guaranteed to be available on all platforms. + +- If a command parameter contains symbol characters, a shell may interpret them, which can introduce a security vulnerability + +- Each shell has different rules for escaping these symbols. On Windows, the default shell is incapable of escaping certain character sequences. + +The Executable API provides a pure JavaScript implementation of primitive shell-like functionality for searching the default PATH, appending default file extensions on Windows, and executing a file that may contain a POSIX shebang. This primitive functionality is sufficient (and recommended) for most tooling scenarios. + +If you need additional shell features such as wildcard globbing, environment variable expansion, piping, or built-in commands, then we recommend to use the `@microsoft/rushell` library instead. Rushell is a pure JavaScript shell with a standard syntax that is guaranteed to work consistently across all platforms. + diff --git a/pages/api/node-core-library.executable.spawnsync.md b/pages/api/node-core-library.executable.spawnsync.md new file mode 100644 index 000000000..1ad9694aa --- /dev/null +++ b/pages/api/node-core-library.executable.spawnsync.md @@ -0,0 +1,39 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Executable](./node-core-library.executable.md) > [spawnSync](./node-core-library.executable.spawnsync.md) + +## Executable.spawnSync() method + +Synchronously create a child process and optionally capture its output. + +Signature: + +```typescript +static spawnSync(filename: string, args: string[], options?: IExecutableSpawnSyncOptions): child_process.SpawnSyncReturns; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filename | string | The name of the executable file. This string must not contain any command-line arguments. If the name contains any path delimiters, then the shell's default PATH will not be searched. | +| args | string[] | The command-line arguments to be passed to the process. | +| options | IExecutableSpawnSyncOptions | Additional options | + +Returns: + +`child_process.SpawnSyncReturns` + +the same data type as returned by the NodeJS child\_process.spawnSync() API + +## Remarks + +This function is similar to child\_process.spawnSync(). The main differences are: + +- It does not invoke the OS shell unless the executable file is a shell script. - Command-line arguments containing special characters are more accurately passed through to the child process. - 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. + diff --git a/pages/api/node-core-library.executable.tryresolve.md b/pages/api/node-core-library.executable.tryresolve.md new file mode 100644 index 000000000..771033e2a --- /dev/null +++ b/pages/api/node-core-library.executable.tryresolve.md @@ -0,0 +1,37 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Executable](./node-core-library.executable.md) > [tryResolve](./node-core-library.executable.tryresolve.md) + +## Executable.tryResolve() method + +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. + +Signature: + +```typescript +static tryResolve(filename: string, options?: IExecutableResolveOptions): string | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filename | string | The name of the executable file. This string must not contain any command-line arguments. If the name contains any path delimiters, then the shell's default PATH will not be searched. | +| options | IExecutableResolveOptions | optional other parameters | + +Returns: + +`string | undefined` + +the absolute path of the executable, or undefined if it was not found + +## Remarks + + diff --git a/pages/api/node-core-library.executablestdiomapping.md b/pages/api/node-core-library.executablestdiomapping.md new file mode 100644 index 000000000..9993c181f --- /dev/null +++ b/pages/api/node-core-library.executablestdiomapping.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ExecutableStdioMapping](./node-core-library.executablestdiomapping.md) + +## ExecutableStdioMapping type + +Typings for IExecutableSpawnSyncOptions.stdio. + +Signature: + +```typescript +export declare type ExecutableStdioMapping = 'pipe' | 'ignore' | 'inherit' | ExecutableStdioStreamMapping[]; +``` diff --git a/pages/api/node-core-library.executablestdiostreammapping.md b/pages/api/node-core-library.executablestdiostreammapping.md new file mode 100644 index 000000000..b14611e92 --- /dev/null +++ b/pages/api/node-core-library.executablestdiostreammapping.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ExecutableStdioStreamMapping](./node-core-library.executablestdiostreammapping.md) + +## ExecutableStdioStreamMapping type + +Typings for one of the streams inside IExecutableSpawnSyncOptions.stdio. + +Signature: + +```typescript +export declare type ExecutableStdioStreamMapping = 'pipe' | 'ignore' | 'inherit' | NodeJS.WritableStream | NodeJS.ReadableStream | number | undefined; +``` diff --git a/pages/api/node-core-library.fileconstants.md b/pages/api/node-core-library.fileconstants.md new file mode 100644 index 000000000..b63b4624b --- /dev/null +++ b/pages/api/node-core-library.fileconstants.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileConstants](./node-core-library.fileconstants.md) + +## FileConstants enum + +String constants for common filenames and parts of filenames. + +Signature: + +```typescript +export declare const enum FileConstants +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| PackageJson | "package.json" | "package.json" - the configuration file that defines an NPM package | + diff --git a/pages/api/node-core-library.filesystem.appendtofile.md b/pages/api/node-core-library.filesystem.appendtofile.md new file mode 100644 index 000000000..9c863cf7d --- /dev/null +++ b/pages/api/node-core-library.filesystem.appendtofile.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [appendToFile](./node-core-library.filesystem.appendtofile.md) + +## FileSystem.appendToFile() method + +Writes a text string to a file on disk, appending to the file if it already exists. Behind the scenes it uses `fs.appendFileSync()`. + +Signature: + +```typescript +static appendToFile(filePath: string, contents: string | Buffer, options?: IFileSystemWriteFileOptions): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filePath | string | The absolute or relative path of the file. | +| contents | string | Buffer | The text that should be written to the file. | +| options | IFileSystemWriteFileOptions | Optional settings that can change the behavior. Type: IWriteFileOptions | + +Returns: + +`void` + +## Remarks + +Throws an error if the folder doesn't exist, unless ensureFolder=true. + diff --git a/pages/api/node-core-library.filesystem.changeposixmodebits.md b/pages/api/node-core-library.filesystem.changeposixmodebits.md new file mode 100644 index 000000000..7813997d0 --- /dev/null +++ b/pages/api/node-core-library.filesystem.changeposixmodebits.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [changePosixModeBits](./node-core-library.filesystem.changeposixmodebits.md) + +## FileSystem.changePosixModeBits() method + +Changes the permissions (i.e. file mode bits) for a filesystem object. Behind the scenes it uses `fs.chmodSync()`. + +Signature: + +```typescript +static changePosixModeBits(path: string, mode: PosixModeBits): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | string | The absolute or relative path to the object that should be updated. | +| mode | PosixModeBits | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.filesystem.copyfile.md b/pages/api/node-core-library.filesystem.copyfile.md new file mode 100644 index 000000000..c762a93b6 --- /dev/null +++ b/pages/api/node-core-library.filesystem.copyfile.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [copyFile](./node-core-library.filesystem.copyfile.md) + +## FileSystem.copyFile() method + +Copies a file from one location to another. By default, destinationPath is overwritten if it already exists. Behind the scenes it uses `fs.copyFileSync()`. + +Signature: + +```typescript +static copyFile(options: IFileSystemCopyFileOptions): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IFileSystemCopyFileOptions | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.filesystem.createhardlink.md b/pages/api/node-core-library.filesystem.createhardlink.md new file mode 100644 index 000000000..bcd76eec8 --- /dev/null +++ b/pages/api/node-core-library.filesystem.createhardlink.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [createHardLink](./node-core-library.filesystem.createhardlink.md) + +## FileSystem.createHardLink() method + +Creates a hard link. Behind the scenes it uses `fs.linkSync()`. + +Signature: + +```typescript +static createHardLink(options: IFileSystemCreateLinkOptions): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IFileSystemCreateLinkOptions | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.filesystem.createsymboliclinkfile.md b/pages/api/node-core-library.filesystem.createsymboliclinkfile.md new file mode 100644 index 000000000..395a00713 --- /dev/null +++ b/pages/api/node-core-library.filesystem.createsymboliclinkfile.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [createSymbolicLinkFile](./node-core-library.filesystem.createsymboliclinkfile.md) + +## FileSystem.createSymbolicLinkFile() method + +Creates a symbolic link to a file (on Windows this requires elevated permissionsBits). Behind the scenes it uses `fs.symlinkSync()`. + +Signature: + +```typescript +static createSymbolicLinkFile(options: IFileSystemCreateLinkOptions): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IFileSystemCreateLinkOptions | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.filesystem.createsymboliclinkfolder.md b/pages/api/node-core-library.filesystem.createsymboliclinkfolder.md new file mode 100644 index 000000000..0348770f8 --- /dev/null +++ b/pages/api/node-core-library.filesystem.createsymboliclinkfolder.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [createSymbolicLinkFolder](./node-core-library.filesystem.createsymboliclinkfolder.md) + +## FileSystem.createSymbolicLinkFolder() method + +Creates a symbolic link to a folder (on Windows this requires elevated permissionsBits). Behind the scenes it uses `fs.symlinkSync()`. + +Signature: + +```typescript +static createSymbolicLinkFolder(options: IFileSystemCreateLinkOptions): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IFileSystemCreateLinkOptions | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.filesystem.createsymboliclinkjunction.md b/pages/api/node-core-library.filesystem.createsymboliclinkjunction.md new file mode 100644 index 000000000..7db7678b3 --- /dev/null +++ b/pages/api/node-core-library.filesystem.createsymboliclinkjunction.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [createSymbolicLinkJunction](./node-core-library.filesystem.createsymboliclinkjunction.md) + +## FileSystem.createSymbolicLinkJunction() method + +Creates a Windows "directory junction". Behaves like `createSymbolicLinkToFile()` on other platforms. Behind the scenes it uses `fs.symlinkSync()`. + +Signature: + +```typescript +static createSymbolicLinkJunction(options: IFileSystemCreateLinkOptions): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IFileSystemCreateLinkOptions | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.filesystem.deletefile.md b/pages/api/node-core-library.filesystem.deletefile.md new file mode 100644 index 000000000..1ad263116 --- /dev/null +++ b/pages/api/node-core-library.filesystem.deletefile.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [deleteFile](./node-core-library.filesystem.deletefile.md) + +## FileSystem.deleteFile() method + +Deletes a file. Can optionally throw if the file doesn't exist. Behind the scenes it uses `fs.unlinkSync()`. + +Signature: + +```typescript +static deleteFile(filePath: string, options?: IFileSystemDeleteFileOptions): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filePath | string | The absolute or relative path to the file that should be deleted. | +| options | IFileSystemDeleteFileOptions | Optional settings that can change the behavior. Type: IDeleteFileOptions | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.filesystem.deletefolder.md b/pages/api/node-core-library.filesystem.deletefolder.md new file mode 100644 index 000000000..78754f3d1 --- /dev/null +++ b/pages/api/node-core-library.filesystem.deletefolder.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [deleteFolder](./node-core-library.filesystem.deletefolder.md) + +## FileSystem.deleteFolder() method + +Deletes a folder, including all of its contents. Behind the scenes is uses `fs-extra.removeSync()`. + +Signature: + +```typescript +static deleteFolder(folderPath: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| folderPath | string | The absolute or relative path to the folder which should be deleted. | + +Returns: + +`void` + +## Remarks + +Does not throw if the folderPath does not exist. + diff --git a/pages/api/node-core-library.filesystem.ensureemptyfolder.md b/pages/api/node-core-library.filesystem.ensureemptyfolder.md new file mode 100644 index 000000000..165f57bfa --- /dev/null +++ b/pages/api/node-core-library.filesystem.ensureemptyfolder.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [ensureEmptyFolder](./node-core-library.filesystem.ensureemptyfolder.md) + +## FileSystem.ensureEmptyFolder() method + +Deletes the content of a folder, but not the folder itself. Also ensures the folder exists. Behind the scenes it uses `fs-extra.emptyDirSync()`. + +Signature: + +```typescript +static ensureEmptyFolder(folderPath: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| folderPath | string | The absolute or relative path to the folder which should have its contents deleted. | + +Returns: + +`void` + +## Remarks + +This is a workaround for a common race condition, where the virus scanner holds a lock on the folder for a brief period after it was deleted, causing EBUSY errors for any code that tries to recreate the folder. + diff --git a/pages/api/node-core-library.filesystem.ensurefolder.md b/pages/api/node-core-library.filesystem.ensurefolder.md new file mode 100644 index 000000000..c398a2289 --- /dev/null +++ b/pages/api/node-core-library.filesystem.ensurefolder.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [ensureFolder](./node-core-library.filesystem.ensurefolder.md) + +## FileSystem.ensureFolder() method + +Recursively creates a folder at a given path. Behind the scenes is uses `fs-extra.ensureDirSync()`. + +Signature: + +```typescript +static ensureFolder(folderPath: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| folderPath | string | The absolute or relative path of the folder which should be created. | + +Returns: + +`void` + +## Remarks + +Throws an exception if anything in the folderPath is not a folder. + diff --git a/pages/api/node-core-library.filesystem.exists.md b/pages/api/node-core-library.filesystem.exists.md new file mode 100644 index 000000000..da55f99b1 --- /dev/null +++ b/pages/api/node-core-library.filesystem.exists.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [exists](./node-core-library.filesystem.exists.md) + +## FileSystem.exists() method + +Returns true if the path exists on disk. Behind the scenes it uses `fs.existsSync()`. + +Signature: + +```typescript +static exists(path: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | string | The absolute or relative path to the filesystem object. | + +Returns: + +`boolean` + +## Remarks + +There is a debate about the fact that after `fs.existsSync()` returns true, the file might be deleted before fs.readSync() is called, which would imply that everybody should catch a `readSync()` exception, and nobody should ever use `fs.existsSync()`. We find this to be unpersuasive, since "unexceptional exceptions" really hinder the break-on-exception debugging experience. Also, throwing/catching is generally slow. + diff --git a/pages/api/node-core-library.filesystem.formatposixmodebits.md b/pages/api/node-core-library.filesystem.formatposixmodebits.md new file mode 100644 index 000000000..38afe670b --- /dev/null +++ b/pages/api/node-core-library.filesystem.formatposixmodebits.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [formatPosixModeBits](./node-core-library.filesystem.formatposixmodebits.md) + +## FileSystem.formatPosixModeBits() method + +Returns a 10-character string representation of a PosixModeBits value similar to what would be displayed by a command such as "ls -l" on a POSIX-like operating system. + +Signature: + +```typescript +static formatPosixModeBits(modeBits: PosixModeBits): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| modeBits | PosixModeBits | POSIX-style file mode bits specified using the [PosixModeBits](./node-core-library.posixmodebits.md) enum | + +Returns: + +`string` + +## Remarks + +For example, `PosixModeBits.AllRead | PosixModeBits.AllWrite` would be formatted as "-rw-rw-rw-". + diff --git a/pages/api/node-core-library.filesystem.getlinkstatistics.md b/pages/api/node-core-library.filesystem.getlinkstatistics.md new file mode 100644 index 000000000..f0d073464 --- /dev/null +++ b/pages/api/node-core-library.filesystem.getlinkstatistics.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [getLinkStatistics](./node-core-library.filesystem.getlinkstatistics.md) + +## FileSystem.getLinkStatistics() method + +Gets the statistics of a filesystem object. Does NOT follow the link to its target. Behind the scenes it uses `fs.lstatSync()`. + +Signature: + +```typescript +static getLinkStatistics(path: string): fs.Stats; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | string | The absolute or relative path to the filesystem object. | + +Returns: + +`fs.Stats` + diff --git a/pages/api/node-core-library.filesystem.getposixmodebits.md b/pages/api/node-core-library.filesystem.getposixmodebits.md new file mode 100644 index 000000000..e12020e0e --- /dev/null +++ b/pages/api/node-core-library.filesystem.getposixmodebits.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [getPosixModeBits](./node-core-library.filesystem.getposixmodebits.md) + +## FileSystem.getPosixModeBits() method + +Retrieves the permissions (i.e. file mode bits) for a filesystem object. Behind the scenes it uses `fs.chmodSync()`. + +Signature: + +```typescript +static getPosixModeBits(path: string): PosixModeBits; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | string | The absolute or relative path to the object that should be updated. | + +Returns: + +`PosixModeBits` + diff --git a/pages/api/node-core-library.filesystem.getrealpath.md b/pages/api/node-core-library.filesystem.getrealpath.md new file mode 100644 index 000000000..e5b78f636 --- /dev/null +++ b/pages/api/node-core-library.filesystem.getrealpath.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [getRealPath](./node-core-library.filesystem.getrealpath.md) + +## FileSystem.getRealPath() method + +Follows a link to its destination and returns the absolute path to the final target of the link. Behind the scenes it uses `fs.realpathSync()`. + +Signature: + +```typescript +static getRealPath(linkPath: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| linkPath | string | The path to the link. | + +Returns: + +`string` + diff --git a/pages/api/node-core-library.filesystem.getstatistics.md b/pages/api/node-core-library.filesystem.getstatistics.md new file mode 100644 index 000000000..fbefdbffa --- /dev/null +++ b/pages/api/node-core-library.filesystem.getstatistics.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [getStatistics](./node-core-library.filesystem.getstatistics.md) + +## FileSystem.getStatistics() method + +Gets the statistics for a particular filesystem object. If the path is a link, this function follows the link and returns statistics about the link target. Behind the scenes it uses `fs.statSync()`. + +Signature: + +```typescript +static getStatistics(path: string): fs.Stats; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | string | The absolute or relative path to the filesystem object. | + +Returns: + +`fs.Stats` + diff --git a/pages/api/node-core-library.filesystem.md b/pages/api/node-core-library.filesystem.md new file mode 100644 index 000000000..5d510e008 --- /dev/null +++ b/pages/api/node-core-library.filesystem.md @@ -0,0 +1,53 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) + +## FileSystem class + +The FileSystem API provides a complete set of recommended operations for interacting with the file system. + +Signature: + +```typescript +export declare class FileSystem +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [appendToFile(filePath, contents, options)](./node-core-library.filesystem.appendtofile.md) | static | Writes a text string to a file on disk, appending to the file if it already exists. Behind the scenes it uses fs.appendFileSync(). | +| [changePosixModeBits(path, mode)](./node-core-library.filesystem.changeposixmodebits.md) | static | Changes the permissions (i.e. file mode bits) for a filesystem object. Behind the scenes it uses fs.chmodSync(). | +| [copyFile(options)](./node-core-library.filesystem.copyfile.md) | static | Copies a file from one location to another. By default, destinationPath is overwritten if it already exists. Behind the scenes it uses fs.copyFileSync(). | +| [createHardLink(options)](./node-core-library.filesystem.createhardlink.md) | static | Creates a hard link. Behind the scenes it uses fs.linkSync(). | +| [createSymbolicLinkFile(options)](./node-core-library.filesystem.createsymboliclinkfile.md) | static | Creates a symbolic link to a file (on Windows this requires elevated permissionsBits). Behind the scenes it uses fs.symlinkSync(). | +| [createSymbolicLinkFolder(options)](./node-core-library.filesystem.createsymboliclinkfolder.md) | static | Creates a symbolic link to a folder (on Windows this requires elevated permissionsBits). Behind the scenes it uses fs.symlinkSync(). | +| [createSymbolicLinkJunction(options)](./node-core-library.filesystem.createsymboliclinkjunction.md) | static | Creates a Windows "directory junction". Behaves like createSymbolicLinkToFile() on other platforms. Behind the scenes it uses fs.symlinkSync(). | +| [deleteFile(filePath, options)](./node-core-library.filesystem.deletefile.md) | static | Deletes a file. Can optionally throw if the file doesn't exist. Behind the scenes it uses fs.unlinkSync(). | +| [deleteFolder(folderPath)](./node-core-library.filesystem.deletefolder.md) | static | Deletes a folder, including all of its contents. Behind the scenes is uses fs-extra.removeSync(). | +| [ensureEmptyFolder(folderPath)](./node-core-library.filesystem.ensureemptyfolder.md) | static | Deletes the content of a folder, but not the folder itself. Also ensures the folder exists. Behind the scenes it uses fs-extra.emptyDirSync(). | +| [ensureFolder(folderPath)](./node-core-library.filesystem.ensurefolder.md) | static | Recursively creates a folder at a given path. Behind the scenes is uses fs-extra.ensureDirSync(). | +| [exists(path)](./node-core-library.filesystem.exists.md) | static | Returns true if the path exists on disk. Behind the scenes it uses fs.existsSync(). | +| [formatPosixModeBits(modeBits)](./node-core-library.filesystem.formatposixmodebits.md) | static | Returns a 10-character string representation of a PosixModeBits value similar to what would be displayed by a command such as "ls -l" on a POSIX-like operating system. | +| [getLinkStatistics(path)](./node-core-library.filesystem.getlinkstatistics.md) | static | Gets the statistics of a filesystem object. Does NOT follow the link to its target. Behind the scenes it uses fs.lstatSync(). | +| [getPosixModeBits(path)](./node-core-library.filesystem.getposixmodebits.md) | static | Retrieves the permissions (i.e. file mode bits) for a filesystem object. Behind the scenes it uses fs.chmodSync(). | +| [getRealPath(linkPath)](./node-core-library.filesystem.getrealpath.md) | static | Follows a link to its destination and returns the absolute path to the final target of the link. Behind the scenes it uses fs.realpathSync(). | +| [getStatistics(path)](./node-core-library.filesystem.getstatistics.md) | static | Gets the statistics for a particular filesystem object. If the path is a link, this function follows the link and returns statistics about the link target. Behind the scenes it uses fs.statSync(). | +| [move(options)](./node-core-library.filesystem.move.md) | static | Moves a file. The folder must exist, unless the ensureFolderExists option is provided. Behind the scenes it uses fs-extra.moveSync() | +| [readFile(filePath, options)](./node-core-library.filesystem.readfile.md) | static | Reads the contents of a file into a string. Behind the scenes it uses fs.readFileSync(). | +| [readFileToBuffer(filePath)](./node-core-library.filesystem.readfiletobuffer.md) | static | Reads the contents of a file into a buffer. Behind the scenes is uses fs.readFileSync(). | +| [readFolder(folderPath, options)](./node-core-library.filesystem.readfolder.md) | static | Reads the contents of the folder, not including "." or "..". Behind the scenes it uses fs.readdirSync(). | +| [updateTimes(path, times)](./node-core-library.filesystem.updatetimes.md) | static | Updates the accessed and modified timestamps of the filesystem object referenced by path. Behind the scenes it uses fs.utimesSync(). The caller should specify both times in the times parameter. | +| [writeFile(filePath, contents, options)](./node-core-library.filesystem.writefile.md) | static | Writes a text string to a file on disk, overwriting the file if it already exists. Behind the scenes it uses fs.writeFileSync(). | + +## Remarks + +We recommend to use this instead of the native `fs` API, because `fs` is a minimal set of low-level primitives that must be mapped for each supported operating system. The FileSystem API takes a philosophical approach of providing "one obvious way" to do each operation. We also prefer synchronous operations except in cases where there would be a clear performance benefit for using async, since synchronous code is much easier to read and debug. Also, indiscriminate parallelism has been seen to actually worsen performance, versus improving it. + +Note that in the documentation, we refer to "filesystem objects", this can be a file, folder, symbolic link, hard link, directory junction, etc. + diff --git a/pages/api/node-core-library.filesystem.move.md b/pages/api/node-core-library.filesystem.move.md new file mode 100644 index 000000000..1766e0470 --- /dev/null +++ b/pages/api/node-core-library.filesystem.move.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [move](./node-core-library.filesystem.move.md) + +## FileSystem.move() method + +Moves a file. The folder must exist, unless the `ensureFolderExists` option is provided. Behind the scenes it uses `fs-extra.moveSync()` + +Signature: + +```typescript +static move(options: IFileSystemMoveOptions): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | IFileSystemMoveOptions | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.filesystem.readfile.md b/pages/api/node-core-library.filesystem.readfile.md new file mode 100644 index 000000000..148927850 --- /dev/null +++ b/pages/api/node-core-library.filesystem.readfile.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [readFile](./node-core-library.filesystem.readfile.md) + +## FileSystem.readFile() method + +Reads the contents of a file into a string. Behind the scenes it uses `fs.readFileSync()`. + +Signature: + +```typescript +static readFile(filePath: string, options?: IFileSystemReadFileOptions): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filePath | string | The relative or absolute path to the file whose contents should be read. | +| options | IFileSystemReadFileOptions | Optional settings that can change the behavior. Type: IReadFileOptions | + +Returns: + +`string` + diff --git a/pages/api/node-core-library.filesystem.readfiletobuffer.md b/pages/api/node-core-library.filesystem.readfiletobuffer.md new file mode 100644 index 000000000..15df67412 --- /dev/null +++ b/pages/api/node-core-library.filesystem.readfiletobuffer.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [readFileToBuffer](./node-core-library.filesystem.readfiletobuffer.md) + +## FileSystem.readFileToBuffer() method + +Reads the contents of a file into a buffer. Behind the scenes is uses `fs.readFileSync()`. + +Signature: + +```typescript +static readFileToBuffer(filePath: string): Buffer; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filePath | string | The relative or absolute path to the file whose contents should be read. | + +Returns: + +`Buffer` + diff --git a/pages/api/node-core-library.filesystem.readfolder.md b/pages/api/node-core-library.filesystem.readfolder.md new file mode 100644 index 000000000..349cbb0e6 --- /dev/null +++ b/pages/api/node-core-library.filesystem.readfolder.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [readFolder](./node-core-library.filesystem.readfolder.md) + +## FileSystem.readFolder() method + +Reads the contents of the folder, not including "." or "..". Behind the scenes it uses `fs.readdirSync()`. + +Signature: + +```typescript +static readFolder(folderPath: string, options?: IFileSystemReadFolderOptions): Array; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| folderPath | string | The absolute or relative path to the folder which should be read. | +| options | IFileSystemReadFolderOptions | Optional settings that can change the behavior. Type: IReadFolderOptions | + +Returns: + +`Array` + diff --git a/pages/api/node-core-library.filesystem.updatetimes.md b/pages/api/node-core-library.filesystem.updatetimes.md new file mode 100644 index 000000000..cef9b3bed --- /dev/null +++ b/pages/api/node-core-library.filesystem.updatetimes.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [updateTimes](./node-core-library.filesystem.updatetimes.md) + +## FileSystem.updateTimes() method + +Updates the accessed and modified timestamps of the filesystem object referenced by path. Behind the scenes it uses `fs.utimesSync()`. The caller should specify both times in the `times` parameter. + +Signature: + +```typescript +static updateTimes(path: string, times: IFileSystemUpdateTimeParameters): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | string | The path of the file that should be modified. | +| times | IFileSystemUpdateTimeParameters | The times that the object should be updated to reflect. | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.filesystem.writefile.md b/pages/api/node-core-library.filesystem.writefile.md new file mode 100644 index 000000000..16c015b0d --- /dev/null +++ b/pages/api/node-core-library.filesystem.writefile.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [writeFile](./node-core-library.filesystem.writefile.md) + +## FileSystem.writeFile() method + +Writes a text string to a file on disk, overwriting the file if it already exists. Behind the scenes it uses `fs.writeFileSync()`. + +Signature: + +```typescript +static writeFile(filePath: string, contents: string | Buffer, options?: IFileSystemWriteFileOptions): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filePath | string | The absolute or relative path of the file. | +| contents | string | Buffer | The text that should be written to the file. | +| options | IFileSystemWriteFileOptions | Optional settings that can change the behavior. Type: IWriteFileOptions | + +Returns: + +`void` + +## Remarks + +Throws an error if the folder doesn't exist, unless ensureFolder=true. + diff --git a/pages/api/node-core-library.filewriter.close.md b/pages/api/node-core-library.filewriter.close.md new file mode 100644 index 000000000..b8859d8a0 --- /dev/null +++ b/pages/api/node-core-library.filewriter.close.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileWriter](./node-core-library.filewriter.md) > [close](./node-core-library.filewriter.close.md) + +## FileWriter.close() method + +Closes the file handle permanently. No operations can be made on this file handle after calling this. Behind the scenes it uses `fs.closeSync()` and releases the file descriptor to be re-used. + +Signature: + +```typescript +close(): void; +``` +Returns: + +`void` + diff --git a/pages/api/node-core-library.filewriter.md b/pages/api/node-core-library.filewriter.md new file mode 100644 index 000000000..da69aff83 --- /dev/null +++ b/pages/api/node-core-library.filewriter.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileWriter](./node-core-library.filewriter.md) + +## FileWriter class + +API for interacting with file handles. + +Signature: + +```typescript +export declare class FileWriter +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [close()](./node-core-library.filewriter.close.md) | | Closes the file handle permanently. No operations can be made on this file handle after calling this. Behind the scenes it uses fs.closeSync() and releases the file descriptor to be re-used. | +| [open(path, flags)](./node-core-library.filewriter.open.md) | static | Opens a new file handle to the file at the specified path and given mode. Behind the scenes it uses fs.openSync(). The behaviour of this function is platform specific. See: https://nodejs.org/docs/latest-v8.x/api/fs.html\#fs\_fs\_open\_path\_flags\_mode\_callback | +| [write(text)](./node-core-library.filewriter.write.md) | | Writes some text to the given file handle. Throws if the file handle has been closed. Behind the scenes it uses fs.writeSync(). | + diff --git a/pages/api/node-core-library.filewriter.open.md b/pages/api/node-core-library.filewriter.open.md new file mode 100644 index 000000000..8836f4c04 --- /dev/null +++ b/pages/api/node-core-library.filewriter.open.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileWriter](./node-core-library.filewriter.md) > [open](./node-core-library.filewriter.open.md) + +## FileWriter.open() method + +Opens a new file handle to the file at the specified path and given mode. Behind the scenes it uses `fs.openSync()`. The behaviour of this function is platform specific. See: https://nodejs.org/docs/latest-v8.x/api/fs.html\#fs\_fs\_open\_path\_flags\_mode\_callback + +Signature: + +```typescript +static open(path: string, flags?: IFileWriterFlags): FileWriter; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | string | The absolute or relative path to the file handle that should be opened. | +| flags | IFileWriterFlags | The flags for opening the handle | + +Returns: + +`FileWriter` + diff --git a/pages/api/node-core-library.filewriter.write.md b/pages/api/node-core-library.filewriter.write.md new file mode 100644 index 000000000..3b70df440 --- /dev/null +++ b/pages/api/node-core-library.filewriter.write.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FileWriter](./node-core-library.filewriter.md) > [write](./node-core-library.filewriter.write.md) + +## FileWriter.write() method + +Writes some text to the given file handle. Throws if the file handle has been closed. Behind the scenes it uses `fs.writeSync()`. + +Signature: + +```typescript +write(text: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | The text to write to the file. | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.folderconstants.md b/pages/api/node-core-library.folderconstants.md new file mode 100644 index 000000000..5786df812 --- /dev/null +++ b/pages/api/node-core-library.folderconstants.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [FolderConstants](./node-core-library.folderconstants.md) + +## FolderConstants enum + +String constants for common folder names. + +Signature: + +```typescript +export declare const enum FolderConstants +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Git | ".git" | ".git" - the data storage for a Git working folder | +| NodeModules | "node_modules" | "node\_modules" - the folder where package managers install their files | + diff --git a/pages/api/node-core-library.icolorablesequence.backgroundcolor.md b/pages/api/node-core-library.icolorablesequence.backgroundcolor.md new file mode 100644 index 000000000..440c92417 --- /dev/null +++ b/pages/api/node-core-library.icolorablesequence.backgroundcolor.md @@ -0,0 +1,19 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IColorableSequence](./node-core-library.icolorablesequence.md) > [backgroundColor](./node-core-library.icolorablesequence.backgroundcolor.md) + +## IColorableSequence.backgroundColor 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. +> + +Signature: + +```typescript +backgroundColor?: ColorValue; +``` diff --git a/pages/api/node-core-library.icolorablesequence.foregroundcolor.md b/pages/api/node-core-library.icolorablesequence.foregroundcolor.md new file mode 100644 index 000000000..de90103cb --- /dev/null +++ b/pages/api/node-core-library.icolorablesequence.foregroundcolor.md @@ -0,0 +1,19 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IColorableSequence](./node-core-library.icolorablesequence.md) > [foregroundColor](./node-core-library.icolorablesequence.foregroundcolor.md) + +## IColorableSequence.foregroundColor 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. +> + +Signature: + +```typescript +foregroundColor?: ColorValue; +``` diff --git a/pages/api/node-core-library.icolorablesequence.iseol.md b/pages/api/node-core-library.icolorablesequence.iseol.md new file mode 100644 index 000000000..8a21b7f7c --- /dev/null +++ b/pages/api/node-core-library.icolorablesequence.iseol.md @@ -0,0 +1,19 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IColorableSequence](./node-core-library.icolorablesequence.md) > [isEol](./node-core-library.icolorablesequence.iseol.md) + +## IColorableSequence.isEol 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. +> + +Signature: + +```typescript +isEol?: boolean; +``` diff --git a/pages/api/node-core-library.icolorablesequence.md b/pages/api/node-core-library.icolorablesequence.md new file mode 100644 index 000000000..050b66664 --- /dev/null +++ b/pages/api/node-core-library.icolorablesequence.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IColorableSequence](./node-core-library.icolorablesequence.md) + +## IColorableSequence interface + +> 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. +> + + +Signature: + +```typescript +export interface IColorableSequence +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [backgroundColor](./node-core-library.icolorablesequence.backgroundcolor.md) | ColorValue | (BETA) | +| [foregroundColor](./node-core-library.icolorablesequence.foregroundcolor.md) | ColorValue | (BETA) | +| [isEol](./node-core-library.icolorablesequence.iseol.md) | boolean | (BETA) | +| [text](./node-core-library.icolorablesequence.text.md) | string | (BETA) | +| [textAttributes](./node-core-library.icolorablesequence.textattributes.md) | TextAttribute[] | (BETA) | + diff --git a/pages/api/node-core-library.icolorablesequence.text.md b/pages/api/node-core-library.icolorablesequence.text.md new file mode 100644 index 000000000..59b77ed14 --- /dev/null +++ b/pages/api/node-core-library.icolorablesequence.text.md @@ -0,0 +1,19 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IColorableSequence](./node-core-library.icolorablesequence.md) > [text](./node-core-library.icolorablesequence.text.md) + +## IColorableSequence.text 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. +> + +Signature: + +```typescript +text: string; +``` diff --git a/pages/api/node-core-library.icolorablesequence.textattributes.md b/pages/api/node-core-library.icolorablesequence.textattributes.md new file mode 100644 index 000000000..c4395d0e7 --- /dev/null +++ b/pages/api/node-core-library.icolorablesequence.textattributes.md @@ -0,0 +1,19 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IColorableSequence](./node-core-library.icolorablesequence.md) > [textAttributes](./node-core-library.icolorablesequence.textattributes.md) + +## IColorableSequence.textAttributes 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. +> + +Signature: + +```typescript +textAttributes?: TextAttribute[]; +``` diff --git a/pages/api/node-core-library.iconsoleterminalprovideroptions.md b/pages/api/node-core-library.iconsoleterminalprovideroptions.md new file mode 100644 index 000000000..615f7a237 --- /dev/null +++ b/pages/api/node-core-library.iconsoleterminalprovideroptions.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IConsoleTerminalProviderOptions](./node-core-library.iconsoleterminalprovideroptions.md) + +## IConsoleTerminalProviderOptions interface + +> 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. +> + +Options to be provided to a [ConsoleTerminalProvider](./node-core-library.consoleterminalprovider.md) + +Signature: + +```typescript +export interface IConsoleTerminalProviderOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [verboseEnabled](./node-core-library.iconsoleterminalprovideroptions.verboseenabled.md) | boolean | (BETA) If true, print verbose logging messages | + diff --git a/pages/api/node-core-library.iconsoleterminalprovideroptions.verboseenabled.md b/pages/api/node-core-library.iconsoleterminalprovideroptions.verboseenabled.md new file mode 100644 index 000000000..0e8295d61 --- /dev/null +++ b/pages/api/node-core-library.iconsoleterminalprovideroptions.verboseenabled.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IConsoleTerminalProviderOptions](./node-core-library.iconsoleterminalprovideroptions.md) > [verboseEnabled](./node-core-library.iconsoleterminalprovideroptions.verboseenabled.md) + +## IConsoleTerminalProviderOptions.verboseEnabled 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 true, print verbose logging messages + +Signature: + +```typescript +verboseEnabled: boolean; +``` diff --git a/pages/api/node-core-library.iexecutableresolveoptions.currentworkingdirectory.md b/pages/api/node-core-library.iexecutableresolveoptions.currentworkingdirectory.md new file mode 100644 index 000000000..6e3729363 --- /dev/null +++ b/pages/api/node-core-library.iexecutableresolveoptions.currentworkingdirectory.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IExecutableResolveOptions](./node-core-library.iexecutableresolveoptions.md) > [currentWorkingDirectory](./node-core-library.iexecutableresolveoptions.currentworkingdirectory.md) + +## IExecutableResolveOptions.currentWorkingDirectory property + +The current working directory. If omitted, process.cwd() will be used. + +Signature: + +```typescript +currentWorkingDirectory?: string; +``` diff --git a/pages/api/node-core-library.iexecutableresolveoptions.environment.md b/pages/api/node-core-library.iexecutableresolveoptions.environment.md new file mode 100644 index 000000000..038ce3961 --- /dev/null +++ b/pages/api/node-core-library.iexecutableresolveoptions.environment.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IExecutableResolveOptions](./node-core-library.iexecutableresolveoptions.md) > [environment](./node-core-library.iexecutableresolveoptions.environment.md) + +## IExecutableResolveOptions.environment property + +The environment variables for the child process. If omitted, process.env will be used. + +Signature: + +```typescript +environment?: NodeJS.ProcessEnv; +``` diff --git a/pages/api/node-core-library.iexecutableresolveoptions.md b/pages/api/node-core-library.iexecutableresolveoptions.md new file mode 100644 index 000000000..22849a421 --- /dev/null +++ b/pages/api/node-core-library.iexecutableresolveoptions.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IExecutableResolveOptions](./node-core-library.iexecutableresolveoptions.md) + +## IExecutableResolveOptions interface + +Options for Executable.tryResolve(). + +Signature: + +```typescript +export interface IExecutableResolveOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [currentWorkingDirectory](./node-core-library.iexecutableresolveoptions.currentworkingdirectory.md) | string | The current working directory. If omitted, process.cwd() will be used. | +| [environment](./node-core-library.iexecutableresolveoptions.environment.md) | NodeJS.ProcessEnv | The environment variables for the child process. If omitted, process.env will be used. | + diff --git a/pages/api/node-core-library.iexecutablespawnsyncoptions.input.md b/pages/api/node-core-library.iexecutablespawnsyncoptions.input.md new file mode 100644 index 000000000..bc2554c8a --- /dev/null +++ b/pages/api/node-core-library.iexecutablespawnsyncoptions.input.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IExecutableSpawnSyncOptions](./node-core-library.iexecutablespawnsyncoptions.md) > [input](./node-core-library.iexecutablespawnsyncoptions.input.md) + +## IExecutableSpawnSyncOptions.input property + +The content to be passed to the child process's stdin. + +NOTE: If specified, this content replaces any IExecutableSpawnSyncOptions.stdio\[0\] mapping for stdin. + +Signature: + +```typescript +input?: string; +``` diff --git a/pages/api/node-core-library.iexecutablespawnsyncoptions.maxbuffer.md b/pages/api/node-core-library.iexecutablespawnsyncoptions.maxbuffer.md new file mode 100644 index 000000000..02425e9f5 --- /dev/null +++ b/pages/api/node-core-library.iexecutablespawnsyncoptions.maxbuffer.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IExecutableSpawnSyncOptions](./node-core-library.iexecutablespawnsyncoptions.md) > [maxBuffer](./node-core-library.iexecutablespawnsyncoptions.maxbuffer.md) + +## 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. + +Signature: + +```typescript +maxBuffer?: number; +``` diff --git a/pages/api/node-core-library.iexecutablespawnsyncoptions.md b/pages/api/node-core-library.iexecutablespawnsyncoptions.md new file mode 100644 index 000000000..311a769fd --- /dev/null +++ b/pages/api/node-core-library.iexecutablespawnsyncoptions.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IExecutableSpawnSyncOptions](./node-core-library.iexecutablespawnsyncoptions.md) + +## IExecutableSpawnSyncOptions interface + +Options for Executable.execute(). + +Signature: + +```typescript +export interface IExecutableSpawnSyncOptions extends IExecutableResolveOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [input](./node-core-library.iexecutablespawnsyncoptions.input.md) | string | 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 | 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. | +| [stdio](./node-core-library.iexecutablespawnsyncoptions.stdio.md) | ExecutableStdioMapping | 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 | The maximum time the process is allowed to run before it will be terminated. | + diff --git a/pages/api/node-core-library.iexecutablespawnsyncoptions.stdio.md b/pages/api/node-core-library.iexecutablespawnsyncoptions.stdio.md new file mode 100644 index 000000000..758ce7704 --- /dev/null +++ b/pages/api/node-core-library.iexecutablespawnsyncoptions.stdio.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IExecutableSpawnSyncOptions](./node-core-library.iexecutablespawnsyncoptions.md) > [stdio](./node-core-library.iexecutablespawnsyncoptions.stdio.md) + +## IExecutableSpawnSyncOptions.stdio property + +The stdio mappings for the child process. + +NOTE: If IExecutableSpawnSyncOptions.input is provided, it will take precedence over the stdin mapping (stdio\[0\]). + +Signature: + +```typescript +stdio?: ExecutableStdioMapping; +``` diff --git a/pages/api/node-core-library.iexecutablespawnsyncoptions.timeoutms.md b/pages/api/node-core-library.iexecutablespawnsyncoptions.timeoutms.md new file mode 100644 index 000000000..c33d61b81 --- /dev/null +++ b/pages/api/node-core-library.iexecutablespawnsyncoptions.timeoutms.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IExecutableSpawnSyncOptions](./node-core-library.iexecutablespawnsyncoptions.md) > [timeoutMs](./node-core-library.iexecutablespawnsyncoptions.timeoutms.md) + +## IExecutableSpawnSyncOptions.timeoutMs property + +The maximum time the process is allowed to run before it will be terminated. + +Signature: + +```typescript +timeoutMs?: number; +``` diff --git a/pages/api/node-core-library.ifilesystemcopyfileoptions.destinationpath.md b/pages/api/node-core-library.ifilesystemcopyfileoptions.destinationpath.md new file mode 100644 index 000000000..76520ed1c --- /dev/null +++ b/pages/api/node-core-library.ifilesystemcopyfileoptions.destinationpath.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemCopyFileOptions](./node-core-library.ifilesystemcopyfileoptions.md) > [destinationPath](./node-core-library.ifilesystemcopyfileoptions.destinationpath.md) + +## IFileSystemCopyFileOptions.destinationPath property + +The path that the object will be copied to. The path may be absolute or relative. + +Signature: + +```typescript +destinationPath: string; +``` diff --git a/pages/api/node-core-library.ifilesystemcopyfileoptions.md b/pages/api/node-core-library.ifilesystemcopyfileoptions.md new file mode 100644 index 000000000..3d68b2bae --- /dev/null +++ b/pages/api/node-core-library.ifilesystemcopyfileoptions.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemCopyFileOptions](./node-core-library.ifilesystemcopyfileoptions.md) + +## IFileSystemCopyFileOptions interface + +The options for FileSystem.copyFile() + +Signature: + +```typescript +export interface IFileSystemCopyFileOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [destinationPath](./node-core-library.ifilesystemcopyfileoptions.destinationpath.md) | string | The path that the object will be copied to. The path may be absolute or relative. | +| [sourcePath](./node-core-library.ifilesystemcopyfileoptions.sourcepath.md) | string | The path of the existing object to be copied. The path may be absolute or relative. | + diff --git a/pages/api/node-core-library.ifilesystemcopyfileoptions.sourcepath.md b/pages/api/node-core-library.ifilesystemcopyfileoptions.sourcepath.md new file mode 100644 index 000000000..8b878c7bf --- /dev/null +++ b/pages/api/node-core-library.ifilesystemcopyfileoptions.sourcepath.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemCopyFileOptions](./node-core-library.ifilesystemcopyfileoptions.md) > [sourcePath](./node-core-library.ifilesystemcopyfileoptions.sourcepath.md) + +## IFileSystemCopyFileOptions.sourcePath property + +The path of the existing object to be copied. The path may be absolute or relative. + +Signature: + +```typescript +sourcePath: string; +``` diff --git a/pages/api/node-core-library.ifilesystemcreatelinkoptions.linktargetpath.md b/pages/api/node-core-library.ifilesystemcreatelinkoptions.linktargetpath.md new file mode 100644 index 000000000..2ce73d6e9 --- /dev/null +++ b/pages/api/node-core-library.ifilesystemcreatelinkoptions.linktargetpath.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemCreateLinkOptions](./node-core-library.ifilesystemcreatelinkoptions.md) > [linkTargetPath](./node-core-library.ifilesystemcreatelinkoptions.linktargetpath.md) + +## IFileSystemCreateLinkOptions.linkTargetPath property + +The existing path that the symbolic link will point to. + +Signature: + +```typescript +linkTargetPath: string; +``` diff --git a/pages/api/node-core-library.ifilesystemcreatelinkoptions.md b/pages/api/node-core-library.ifilesystemcreatelinkoptions.md new file mode 100644 index 000000000..6deedc783 --- /dev/null +++ b/pages/api/node-core-library.ifilesystemcreatelinkoptions.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemCreateLinkOptions](./node-core-library.ifilesystemcreatelinkoptions.md) + +## IFileSystemCreateLinkOptions interface + +The options for `FileSystem.createSymbolicLinkJunction()`, `createSymbolicLinkFile()`, `createSymbolicLinkFolder()`, and `createHardLink()`. + +Signature: + +```typescript +export interface IFileSystemCreateLinkOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [linkTargetPath](./node-core-library.ifilesystemcreatelinkoptions.linktargetpath.md) | string | The existing path that the symbolic link will point to. | +| [newLinkPath](./node-core-library.ifilesystemcreatelinkoptions.newlinkpath.md) | string | The new path for the new symlink link to be created. | + diff --git a/pages/api/node-core-library.ifilesystemcreatelinkoptions.newlinkpath.md b/pages/api/node-core-library.ifilesystemcreatelinkoptions.newlinkpath.md new file mode 100644 index 000000000..2b8580da6 --- /dev/null +++ b/pages/api/node-core-library.ifilesystemcreatelinkoptions.newlinkpath.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemCreateLinkOptions](./node-core-library.ifilesystemcreatelinkoptions.md) > [newLinkPath](./node-core-library.ifilesystemcreatelinkoptions.newlinkpath.md) + +## IFileSystemCreateLinkOptions.newLinkPath property + +The new path for the new symlink link to be created. + +Signature: + +```typescript +newLinkPath: string; +``` diff --git a/pages/api/node-core-library.ifilesystemdeletefileoptions.md b/pages/api/node-core-library.ifilesystemdeletefileoptions.md new file mode 100644 index 000000000..b509d6a3d --- /dev/null +++ b/pages/api/node-core-library.ifilesystemdeletefileoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemDeleteFileOptions](./node-core-library.ifilesystemdeletefileoptions.md) + +## IFileSystemDeleteFileOptions interface + +The options for FileSystem.deleteFile() + +Signature: + +```typescript +export interface IFileSystemDeleteFileOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [throwIfNotExists](./node-core-library.ifilesystemdeletefileoptions.throwifnotexists.md) | boolean | If true, will throw an exception if the file did not exist before deleteFile() was called. Defaults to false. | + diff --git a/pages/api/node-core-library.ifilesystemdeletefileoptions.throwifnotexists.md b/pages/api/node-core-library.ifilesystemdeletefileoptions.throwifnotexists.md new file mode 100644 index 000000000..29e25de8b --- /dev/null +++ b/pages/api/node-core-library.ifilesystemdeletefileoptions.throwifnotexists.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemDeleteFileOptions](./node-core-library.ifilesystemdeletefileoptions.md) > [throwIfNotExists](./node-core-library.ifilesystemdeletefileoptions.throwifnotexists.md) + +## IFileSystemDeleteFileOptions.throwIfNotExists property + +If true, will throw an exception if the file did not exist before `deleteFile()` was called. Defaults to `false`. + +Signature: + +```typescript +throwIfNotExists?: boolean; +``` diff --git a/pages/api/node-core-library.ifilesystemmoveoptions.destinationpath.md b/pages/api/node-core-library.ifilesystemmoveoptions.destinationpath.md new file mode 100644 index 000000000..3b846da1f --- /dev/null +++ b/pages/api/node-core-library.ifilesystemmoveoptions.destinationpath.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemMoveOptions](./node-core-library.ifilesystemmoveoptions.md) > [destinationPath](./node-core-library.ifilesystemmoveoptions.destinationpath.md) + +## IFileSystemMoveOptions.destinationPath property + +The new path for the object. The path may be absolute or relative. + +Signature: + +```typescript +destinationPath: string; +``` diff --git a/pages/api/node-core-library.ifilesystemmoveoptions.ensurefolderexists.md b/pages/api/node-core-library.ifilesystemmoveoptions.ensurefolderexists.md new file mode 100644 index 000000000..32f7f3bb3 --- /dev/null +++ b/pages/api/node-core-library.ifilesystemmoveoptions.ensurefolderexists.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemMoveOptions](./node-core-library.ifilesystemmoveoptions.md) > [ensureFolderExists](./node-core-library.ifilesystemmoveoptions.ensurefolderexists.md) + +## IFileSystemMoveOptions.ensureFolderExists property + +If true, will ensure the folder is created before writing the file. Defaults to `false`. + +Signature: + +```typescript +ensureFolderExists?: boolean; +``` diff --git a/pages/api/node-core-library.ifilesystemmoveoptions.md b/pages/api/node-core-library.ifilesystemmoveoptions.md new file mode 100644 index 000000000..91582ee8b --- /dev/null +++ b/pages/api/node-core-library.ifilesystemmoveoptions.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemMoveOptions](./node-core-library.ifilesystemmoveoptions.md) + +## IFileSystemMoveOptions interface + +The options for FileSystem.move() + +Signature: + +```typescript +export interface IFileSystemMoveOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [destinationPath](./node-core-library.ifilesystemmoveoptions.destinationpath.md) | string | The new path for the object. The path may be absolute or relative. | +| [ensureFolderExists](./node-core-library.ifilesystemmoveoptions.ensurefolderexists.md) | boolean | If true, will ensure the folder is created before writing the file. Defaults to false. | +| [overwrite](./node-core-library.ifilesystemmoveoptions.overwrite.md) | boolean | If true, will overwrite the file if it already exists. Defaults to true. | +| [sourcePath](./node-core-library.ifilesystemmoveoptions.sourcepath.md) | string | The path of the existing object to be moved. The path may be absolute or relative. | + diff --git a/pages/api/node-core-library.ifilesystemmoveoptions.overwrite.md b/pages/api/node-core-library.ifilesystemmoveoptions.overwrite.md new file mode 100644 index 000000000..27f684427 --- /dev/null +++ b/pages/api/node-core-library.ifilesystemmoveoptions.overwrite.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemMoveOptions](./node-core-library.ifilesystemmoveoptions.md) > [overwrite](./node-core-library.ifilesystemmoveoptions.overwrite.md) + +## IFileSystemMoveOptions.overwrite property + +If true, will overwrite the file if it already exists. Defaults to true. + +Signature: + +```typescript +overwrite?: boolean; +``` diff --git a/pages/api/node-core-library.ifilesystemmoveoptions.sourcepath.md b/pages/api/node-core-library.ifilesystemmoveoptions.sourcepath.md new file mode 100644 index 000000000..570a5f5fe --- /dev/null +++ b/pages/api/node-core-library.ifilesystemmoveoptions.sourcepath.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemMoveOptions](./node-core-library.ifilesystemmoveoptions.md) > [sourcePath](./node-core-library.ifilesystemmoveoptions.sourcepath.md) + +## IFileSystemMoveOptions.sourcePath property + +The path of the existing object to be moved. The path may be absolute or relative. + +Signature: + +```typescript +sourcePath: string; +``` diff --git a/pages/api/node-core-library.ifilesystemreadfileoptions.convertlineendings.md b/pages/api/node-core-library.ifilesystemreadfileoptions.convertlineendings.md new file mode 100644 index 000000000..1f5a64c99 --- /dev/null +++ b/pages/api/node-core-library.ifilesystemreadfileoptions.convertlineendings.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemReadFileOptions](./node-core-library.ifilesystemreadfileoptions.md) > [convertLineEndings](./node-core-library.ifilesystemreadfileoptions.convertlineendings.md) + +## IFileSystemReadFileOptions.convertLineEndings property + +If specified, will normalize line endings to the specified style of newline. Defaults to `NewlineKind.None`. + +Signature: + +```typescript +convertLineEndings?: NewlineKind; +``` diff --git a/pages/api/node-core-library.ifilesystemreadfileoptions.encoding.md b/pages/api/node-core-library.ifilesystemreadfileoptions.encoding.md new file mode 100644 index 000000000..556965ed7 --- /dev/null +++ b/pages/api/node-core-library.ifilesystemreadfileoptions.encoding.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemReadFileOptions](./node-core-library.ifilesystemreadfileoptions.md) > [encoding](./node-core-library.ifilesystemreadfileoptions.encoding.md) + +## IFileSystemReadFileOptions.encoding property + +If specified, will change the encoding of the file that will be written. Defaults to `"utf8"`. + +Signature: + +```typescript +encoding?: Encoding; +``` diff --git a/pages/api/node-core-library.ifilesystemreadfileoptions.md b/pages/api/node-core-library.ifilesystemreadfileoptions.md new file mode 100644 index 000000000..971d71b8a --- /dev/null +++ b/pages/api/node-core-library.ifilesystemreadfileoptions.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemReadFileOptions](./node-core-library.ifilesystemreadfileoptions.md) + +## IFileSystemReadFileOptions interface + +The options for FileSystem.readFile() + +Signature: + +```typescript +export interface IFileSystemReadFileOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [convertLineEndings](./node-core-library.ifilesystemreadfileoptions.convertlineendings.md) | NewlineKind | If specified, will normalize line endings to the specified style of newline. Defaults to NewlineKind.None. | +| [encoding](./node-core-library.ifilesystemreadfileoptions.encoding.md) | Encoding | If specified, will change the encoding of the file that will be written. Defaults to "utf8". | + diff --git a/pages/api/node-core-library.ifilesystemreadfolderoptions.absolutepaths.md b/pages/api/node-core-library.ifilesystemreadfolderoptions.absolutepaths.md new file mode 100644 index 000000000..79aa77dfc --- /dev/null +++ b/pages/api/node-core-library.ifilesystemreadfolderoptions.absolutepaths.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemReadFolderOptions](./node-core-library.ifilesystemreadfolderoptions.md) > [absolutePaths](./node-core-library.ifilesystemreadfolderoptions.absolutepaths.md) + +## IFileSystemReadFolderOptions.absolutePaths property + +If true, returns the absolute paths of the files in the folder. Defaults to `false`. + +Signature: + +```typescript +absolutePaths?: boolean; +``` diff --git a/pages/api/node-core-library.ifilesystemreadfolderoptions.md b/pages/api/node-core-library.ifilesystemreadfolderoptions.md new file mode 100644 index 000000000..892f7a4fa --- /dev/null +++ b/pages/api/node-core-library.ifilesystemreadfolderoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemReadFolderOptions](./node-core-library.ifilesystemreadfolderoptions.md) + +## IFileSystemReadFolderOptions interface + +The options for FileSystem.readFolder() + +Signature: + +```typescript +export interface IFileSystemReadFolderOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [absolutePaths](./node-core-library.ifilesystemreadfolderoptions.absolutepaths.md) | boolean | If true, returns the absolute paths of the files in the folder. Defaults to false. | + diff --git a/pages/api/node-core-library.ifilesystemupdatetimeparameters.accessedtime.md b/pages/api/node-core-library.ifilesystemupdatetimeparameters.accessedtime.md new file mode 100644 index 000000000..e5f61c11f --- /dev/null +++ b/pages/api/node-core-library.ifilesystemupdatetimeparameters.accessedtime.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemUpdateTimeParameters](./node-core-library.ifilesystemupdatetimeparameters.md) > [accessedTime](./node-core-library.ifilesystemupdatetimeparameters.accessedtime.md) + +## IFileSystemUpdateTimeParameters.accessedTime property + +The POSIX epoch time or Date when this was last accessed. + +Signature: + +```typescript +accessedTime: number | Date; +``` diff --git a/pages/api/node-core-library.ifilesystemupdatetimeparameters.md b/pages/api/node-core-library.ifilesystemupdatetimeparameters.md new file mode 100644 index 000000000..0b51377e8 --- /dev/null +++ b/pages/api/node-core-library.ifilesystemupdatetimeparameters.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemUpdateTimeParameters](./node-core-library.ifilesystemupdatetimeparameters.md) + +## IFileSystemUpdateTimeParameters interface + +The parameters for `updateTimes()`. Both times must be specified. + +Signature: + +```typescript +export interface IFileSystemUpdateTimeParameters +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [accessedTime](./node-core-library.ifilesystemupdatetimeparameters.accessedtime.md) | number | Date | The POSIX epoch time or Date when this was last accessed. | +| [modifiedTime](./node-core-library.ifilesystemupdatetimeparameters.modifiedtime.md) | number | Date | The POSIX epoch time or Date when this was last modified | + diff --git a/pages/api/node-core-library.ifilesystemupdatetimeparameters.modifiedtime.md b/pages/api/node-core-library.ifilesystemupdatetimeparameters.modifiedtime.md new file mode 100644 index 000000000..302b41daa --- /dev/null +++ b/pages/api/node-core-library.ifilesystemupdatetimeparameters.modifiedtime.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemUpdateTimeParameters](./node-core-library.ifilesystemupdatetimeparameters.md) > [modifiedTime](./node-core-library.ifilesystemupdatetimeparameters.modifiedtime.md) + +## IFileSystemUpdateTimeParameters.modifiedTime property + +The POSIX epoch time or Date when this was last modified + +Signature: + +```typescript +modifiedTime: number | Date; +``` diff --git a/pages/api/node-core-library.ifilesystemwritefileoptions.convertlineendings.md b/pages/api/node-core-library.ifilesystemwritefileoptions.convertlineendings.md new file mode 100644 index 000000000..7b31602a3 --- /dev/null +++ b/pages/api/node-core-library.ifilesystemwritefileoptions.convertlineendings.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemWriteFileOptions](./node-core-library.ifilesystemwritefileoptions.md) > [convertLineEndings](./node-core-library.ifilesystemwritefileoptions.convertlineendings.md) + +## IFileSystemWriteFileOptions.convertLineEndings property + +If specified, will normalize line endings to the specified style of newline. Defaults to `NewlineKind.None`. + +Signature: + +```typescript +convertLineEndings?: NewlineKind; +``` diff --git a/pages/api/node-core-library.ifilesystemwritefileoptions.encoding.md b/pages/api/node-core-library.ifilesystemwritefileoptions.encoding.md new file mode 100644 index 000000000..9af041e6d --- /dev/null +++ b/pages/api/node-core-library.ifilesystemwritefileoptions.encoding.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemWriteFileOptions](./node-core-library.ifilesystemwritefileoptions.md) > [encoding](./node-core-library.ifilesystemwritefileoptions.encoding.md) + +## IFileSystemWriteFileOptions.encoding property + +If specified, will change the encoding of the file that will be written. Defaults to `"utf8"`. + +Signature: + +```typescript +encoding?: Encoding; +``` diff --git a/pages/api/node-core-library.ifilesystemwritefileoptions.ensurefolderexists.md b/pages/api/node-core-library.ifilesystemwritefileoptions.ensurefolderexists.md new file mode 100644 index 000000000..8c0b96087 --- /dev/null +++ b/pages/api/node-core-library.ifilesystemwritefileoptions.ensurefolderexists.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemWriteFileOptions](./node-core-library.ifilesystemwritefileoptions.md) > [ensureFolderExists](./node-core-library.ifilesystemwritefileoptions.ensurefolderexists.md) + +## IFileSystemWriteFileOptions.ensureFolderExists property + +If true, will ensure the folder is created before writing the file. Defaults to `false`. + +Signature: + +```typescript +ensureFolderExists?: boolean; +``` diff --git a/pages/api/node-core-library.ifilesystemwritefileoptions.md b/pages/api/node-core-library.ifilesystemwritefileoptions.md new file mode 100644 index 000000000..6855596f1 --- /dev/null +++ b/pages/api/node-core-library.ifilesystemwritefileoptions.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileSystemWriteFileOptions](./node-core-library.ifilesystemwritefileoptions.md) + +## IFileSystemWriteFileOptions interface + +The options for FileSystem.writeFile() + +Signature: + +```typescript +export interface IFileSystemWriteFileOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [convertLineEndings](./node-core-library.ifilesystemwritefileoptions.convertlineendings.md) | NewlineKind | If specified, will normalize line endings to the specified style of newline. Defaults to NewlineKind.None. | +| [encoding](./node-core-library.ifilesystemwritefileoptions.encoding.md) | Encoding | If specified, will change the encoding of the file that will be written. Defaults to "utf8". | +| [ensureFolderExists](./node-core-library.ifilesystemwritefileoptions.ensurefolderexists.md) | boolean | If true, will ensure the folder is created before writing the file. Defaults to false. | + diff --git a/pages/api/node-core-library.ifilewriterflags.append.md b/pages/api/node-core-library.ifilewriterflags.append.md new file mode 100644 index 000000000..7f133b322 --- /dev/null +++ b/pages/api/node-core-library.ifilewriterflags.append.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileWriterFlags](./node-core-library.ifilewriterflags.md) > [append](./node-core-library.ifilewriterflags.append.md) + +## IFileWriterFlags.append property + +Open file for appending. + +Signature: + +```typescript +append?: boolean; +``` diff --git a/pages/api/node-core-library.ifilewriterflags.exclusive.md b/pages/api/node-core-library.ifilewriterflags.exclusive.md new file mode 100644 index 000000000..1d7ff59c4 --- /dev/null +++ b/pages/api/node-core-library.ifilewriterflags.exclusive.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileWriterFlags](./node-core-library.ifilewriterflags.md) > [exclusive](./node-core-library.ifilewriterflags.exclusive.md) + +## IFileWriterFlags.exclusive property + +Fails if path exists. The exclusive flag ensures that path is newly created. + +Signature: + +```typescript +exclusive?: boolean; +``` + +## Remarks + +On POSIX-like operating systems, path is considered to exist even if it is a symlink to a non-existent file. The exclusive flag may or may not work with network file systems. + +POSIX is a registered trademark of the Institute of Electrical and Electronic Engineers, Inc. + diff --git a/pages/api/node-core-library.ifilewriterflags.md b/pages/api/node-core-library.ifilewriterflags.md new file mode 100644 index 000000000..cdd2e4c38 --- /dev/null +++ b/pages/api/node-core-library.ifilewriterflags.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IFileWriterFlags](./node-core-library.ifilewriterflags.md) + +## IFileWriterFlags interface + +Interface which represents the flags about which mode the file should be opened in. + +Signature: + +```typescript +export interface IFileWriterFlags +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [append](./node-core-library.ifilewriterflags.append.md) | boolean | Open file for appending. | +| [exclusive](./node-core-library.ifilewriterflags.exclusive.md) | boolean | Fails if path exists. The exclusive flag ensures that path is newly created. | + diff --git a/pages/api/node-core-library.ijsonfilesaveoptions.ensurefolderexists.md b/pages/api/node-core-library.ijsonfilesaveoptions.ensurefolderexists.md new file mode 100644 index 000000000..c0ec53f44 --- /dev/null +++ b/pages/api/node-core-library.ijsonfilesaveoptions.ensurefolderexists.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IJsonFileSaveOptions](./node-core-library.ijsonfilesaveoptions.md) > [ensureFolderExists](./node-core-library.ijsonfilesaveoptions.ensurefolderexists.md) + +## IJsonFileSaveOptions.ensureFolderExists property + +Creates the folder recursively using FileSystem.ensureFolder() Defaults to false. + +Signature: + +```typescript +ensureFolderExists?: boolean; +``` diff --git a/pages/api/node-core-library.ijsonfilesaveoptions.md b/pages/api/node-core-library.ijsonfilesaveoptions.md new file mode 100644 index 000000000..091911a9c --- /dev/null +++ b/pages/api/node-core-library.ijsonfilesaveoptions.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IJsonFileSaveOptions](./node-core-library.ijsonfilesaveoptions.md) + +## IJsonFileSaveOptions interface + +Options for JsonFile.saveJsonFile() + +Signature: + +```typescript +export interface IJsonFileSaveOptions extends IJsonFileStringifyOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [ensureFolderExists](./node-core-library.ijsonfilesaveoptions.ensurefolderexists.md) | boolean | Creates the folder recursively using FileSystem.ensureFolder() Defaults to false. | +| [onlyIfChanged](./node-core-library.ijsonfilesaveoptions.onlyifchanged.md) | boolean | If there is an existing file, and the contents have not changed, then don't write anything; this preserves the old timestamp. | +| [updateExistingFile](./node-core-library.ijsonfilesaveoptions.updateexistingfile.md) | boolean | If true, use the "jju" library to preserve the existing JSON formatting: The file will be loaded from the target filename, the new content will be merged in (preserving whitespace and comments), and then the file will be overwritten with the merged contents. If the target file does not exist, then the file is saved normally. | + diff --git a/pages/api/node-core-library.ijsonfilesaveoptions.onlyifchanged.md b/pages/api/node-core-library.ijsonfilesaveoptions.onlyifchanged.md new file mode 100644 index 000000000..8422d7dd4 --- /dev/null +++ b/pages/api/node-core-library.ijsonfilesaveoptions.onlyifchanged.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IJsonFileSaveOptions](./node-core-library.ijsonfilesaveoptions.md) > [onlyIfChanged](./node-core-library.ijsonfilesaveoptions.onlyifchanged.md) + +## IJsonFileSaveOptions.onlyIfChanged property + +If there is an existing file, and the contents have not changed, then don't write anything; this preserves the old timestamp. + +Signature: + +```typescript +onlyIfChanged?: boolean; +``` diff --git a/pages/api/node-core-library.ijsonfilesaveoptions.updateexistingfile.md b/pages/api/node-core-library.ijsonfilesaveoptions.updateexistingfile.md new file mode 100644 index 000000000..7b00d09fc --- /dev/null +++ b/pages/api/node-core-library.ijsonfilesaveoptions.updateexistingfile.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IJsonFileSaveOptions](./node-core-library.ijsonfilesaveoptions.md) > [updateExistingFile](./node-core-library.ijsonfilesaveoptions.updateexistingfile.md) + +## IJsonFileSaveOptions.updateExistingFile property + +If true, use the "jju" library to preserve the existing JSON formatting: The file will be loaded from the target filename, the new content will be merged in (preserving whitespace and comments), and then the file will be overwritten with the merged contents. If the target file does not exist, then the file is saved normally. + +Signature: + +```typescript +updateExistingFile?: boolean; +``` diff --git a/pages/api/node-core-library.ijsonfilestringifyoptions.md b/pages/api/node-core-library.ijsonfilestringifyoptions.md new file mode 100644 index 000000000..8932b2fbe --- /dev/null +++ b/pages/api/node-core-library.ijsonfilestringifyoptions.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IJsonFileStringifyOptions](./node-core-library.ijsonfilestringifyoptions.md) + +## IJsonFileStringifyOptions interface + +Options for JsonFile.stringify() + +Signature: + +```typescript +export interface IJsonFileStringifyOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [newlineConversion](./node-core-library.ijsonfilestringifyoptions.newlineconversion.md) | NewlineKind | If true, then \n will be used for newlines instead of the default \r\n. | +| [prettyFormatting](./node-core-library.ijsonfilestringifyoptions.prettyformatting.md) | boolean | 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. | + diff --git a/pages/api/node-core-library.ijsonfilestringifyoptions.newlineconversion.md b/pages/api/node-core-library.ijsonfilestringifyoptions.newlineconversion.md new file mode 100644 index 000000000..3993be10e --- /dev/null +++ b/pages/api/node-core-library.ijsonfilestringifyoptions.newlineconversion.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IJsonFileStringifyOptions](./node-core-library.ijsonfilestringifyoptions.md) > [newlineConversion](./node-core-library.ijsonfilestringifyoptions.newlineconversion.md) + +## IJsonFileStringifyOptions.newlineConversion property + +If true, then `\n` will be used for newlines instead of the default `\r\n`. + +Signature: + +```typescript +newlineConversion?: NewlineKind; +``` diff --git a/pages/api/node-core-library.ijsonfilestringifyoptions.prettyformatting.md b/pages/api/node-core-library.ijsonfilestringifyoptions.prettyformatting.md new file mode 100644 index 000000000..d48767f71 --- /dev/null +++ b/pages/api/node-core-library.ijsonfilestringifyoptions.prettyformatting.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IJsonFileStringifyOptions](./node-core-library.ijsonfilestringifyoptions.md) > [prettyFormatting](./node-core-library.ijsonfilestringifyoptions.prettyformatting.md) + +## IJsonFileStringifyOptions.prettyFormatting property + +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. + +Signature: + +```typescript +prettyFormatting?: boolean; +``` diff --git a/pages/api/node-core-library.ijsonschemaerrorinfo.details.md b/pages/api/node-core-library.ijsonschemaerrorinfo.details.md new file mode 100644 index 000000000..6a53552e7 --- /dev/null +++ b/pages/api/node-core-library.ijsonschemaerrorinfo.details.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IJsonSchemaErrorInfo](./node-core-library.ijsonschemaerrorinfo.md) > [details](./node-core-library.ijsonschemaerrorinfo.details.md) + +## IJsonSchemaErrorInfo.details property + +The z-schema error tree, formatted as an indented text string. + +Signature: + +```typescript +details: string; +``` diff --git a/pages/api/node-core-library.ijsonschemaerrorinfo.md b/pages/api/node-core-library.ijsonschemaerrorinfo.md new file mode 100644 index 000000000..6c4d4b0a6 --- /dev/null +++ b/pages/api/node-core-library.ijsonschemaerrorinfo.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IJsonSchemaErrorInfo](./node-core-library.ijsonschemaerrorinfo.md) + +## IJsonSchemaErrorInfo interface + +Callback function arguments for JsonSchema.validateObjectWithCallback(); + +Signature: + +```typescript +export interface IJsonSchemaErrorInfo +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [details](./node-core-library.ijsonschemaerrorinfo.details.md) | string | The z-schema error tree, formatted as an indented text string. | + diff --git a/pages/api/node-core-library.ijsonschemafromfileoptions.dependentschemas.md b/pages/api/node-core-library.ijsonschemafromfileoptions.dependentschemas.md new file mode 100644 index 000000000..a7eb978b9 --- /dev/null +++ b/pages/api/node-core-library.ijsonschemafromfileoptions.dependentschemas.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IJsonSchemaFromFileOptions](./node-core-library.ijsonschemafromfileoptions.md) > [dependentSchemas](./node-core-library.ijsonschemafromfileoptions.dependentschemas.md) + +## IJsonSchemaFromFileOptions.dependentSchemas property + +Other schemas that this schema references, e.g. via the "$ref" directive. + +Signature: + +```typescript +dependentSchemas?: JsonSchema[]; +``` + +## Remarks + +The tree of dependent schemas may reference the same schema more than once. However, if the same schema "id" is used by two different JsonSchema instances, an error will be reported. This means you cannot load the same filename twice and use them both together, and you cannot have diamond dependencies on different versions of the same schema. Although technically this would be possible to support, it normally indicates an error or design problem. + +JsonSchema also does not allow circular references between schema dependencies. + diff --git a/pages/api/node-core-library.ijsonschemafromfileoptions.md b/pages/api/node-core-library.ijsonschemafromfileoptions.md new file mode 100644 index 000000000..0b3f8274d --- /dev/null +++ b/pages/api/node-core-library.ijsonschemafromfileoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IJsonSchemaFromFileOptions](./node-core-library.ijsonschemafromfileoptions.md) + +## IJsonSchemaFromFileOptions interface + +Options for JsonSchema.fromFile() + +Signature: + +```typescript +export interface IJsonSchemaFromFileOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [dependentSchemas](./node-core-library.ijsonschemafromfileoptions.dependentschemas.md) | JsonSchema[] | Other schemas that this schema references, e.g. via the "$ref" directive. | + diff --git a/pages/api/node-core-library.ijsonschemavalidateoptions.customerrorheader.md b/pages/api/node-core-library.ijsonschemavalidateoptions.customerrorheader.md new file mode 100644 index 000000000..5fb96ac06 --- /dev/null +++ b/pages/api/node-core-library.ijsonschemavalidateoptions.customerrorheader.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IJsonSchemaValidateOptions](./node-core-library.ijsonschemavalidateoptions.md) > [customErrorHeader](./node-core-library.ijsonschemavalidateoptions.customerrorheader.md) + +## IJsonSchemaValidateOptions.customErrorHeader property + +A custom header that will be used to report schema errors. + +Signature: + +```typescript +customErrorHeader?: string; +``` + +## Remarks + +If omitted, the default header is "JSON validation failed:". The error message starts with the header, followed by the full input filename, followed by the z-schema error tree. If you wish to customize all aspects of the error message, use JsonFile.loadAndValidateWithCallback() or JsonSchema.validateObjectWithCallback(). + diff --git a/pages/api/node-core-library.ijsonschemavalidateoptions.md b/pages/api/node-core-library.ijsonschemavalidateoptions.md new file mode 100644 index 000000000..9ad39f36a --- /dev/null +++ b/pages/api/node-core-library.ijsonschemavalidateoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IJsonSchemaValidateOptions](./node-core-library.ijsonschemavalidateoptions.md) + +## IJsonSchemaValidateOptions interface + +Options for JsonSchema.validateObject() + +Signature: + +```typescript +export interface IJsonSchemaValidateOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [customErrorHeader](./node-core-library.ijsonschemavalidateoptions.customerrorheader.md) | string | A custom header that will be used to report schema errors. | + diff --git a/pages/api/node-core-library.inodepackagejson.bin.md b/pages/api/node-core-library.inodepackagejson.bin.md new file mode 100644 index 000000000..0b8dec36b --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.bin.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [bin](./node-core-library.inodepackagejson.bin.md) + +## INodePackageJson.bin property + +The main entry point for the package. + +Signature: + +```typescript +bin?: string; +``` diff --git a/pages/api/node-core-library.inodepackagejson.dependencies.md b/pages/api/node-core-library.inodepackagejson.dependencies.md new file mode 100644 index 000000000..7920b13e4 --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.dependencies.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [dependencies](./node-core-library.inodepackagejson.dependencies.md) + +## INodePackageJson.dependencies property + +An array of dependencies that must always be installed for this package. + +Signature: + +```typescript +dependencies?: IPackageJsonDependencyTable; +``` diff --git a/pages/api/node-core-library.inodepackagejson.description.md b/pages/api/node-core-library.inodepackagejson.description.md new file mode 100644 index 000000000..16fce7ca0 --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.description.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [description](./node-core-library.inodepackagejson.description.md) + +## INodePackageJson.description property + +A brief description of the package. + +Signature: + +```typescript +description?: string; +``` diff --git a/pages/api/node-core-library.inodepackagejson.devdependencies.md b/pages/api/node-core-library.inodepackagejson.devdependencies.md new file mode 100644 index 000000000..8af17b03e --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.devdependencies.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [devDependencies](./node-core-library.inodepackagejson.devdependencies.md) + +## INodePackageJson.devDependencies property + +An array of dependencies that must only be installed for developers who will build this package. + +Signature: + +```typescript +devDependencies?: IPackageJsonDependencyTable; +``` diff --git a/pages/api/node-core-library.inodepackagejson.homepage.md b/pages/api/node-core-library.inodepackagejson.homepage.md new file mode 100644 index 000000000..d56a68099 --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.homepage.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [homepage](./node-core-library.inodepackagejson.homepage.md) + +## INodePackageJson.homepage property + +The URL to the project's web page. + +Signature: + +```typescript +homepage?: string; +``` diff --git a/pages/api/node-core-library.inodepackagejson.license.md b/pages/api/node-core-library.inodepackagejson.license.md new file mode 100644 index 000000000..16fbbf691 --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.license.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [license](./node-core-library.inodepackagejson.license.md) + +## INodePackageJson.license property + +The name of the license. + +Signature: + +```typescript +license?: string; +``` diff --git a/pages/api/node-core-library.inodepackagejson.main.md b/pages/api/node-core-library.inodepackagejson.main.md new file mode 100644 index 000000000..b17ebc0c2 --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.main.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [main](./node-core-library.inodepackagejson.main.md) + +## INodePackageJson.main property + +The path to the module file that will act as the main entry point. + +Signature: + +```typescript +main?: string; +``` diff --git a/pages/api/node-core-library.inodepackagejson.md b/pages/api/node-core-library.inodepackagejson.md new file mode 100644 index 000000000..576e2e94b --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.md @@ -0,0 +1,49 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) + +## INodePackageJson interface + +An interface for accessing common fields from a package.json file whose version field may be missing. + +Signature: + +```typescript +export interface INodePackageJson +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [bin](./node-core-library.inodepackagejson.bin.md) | string | The main entry point for the package. | +| [dependencies](./node-core-library.inodepackagejson.dependencies.md) | IPackageJsonDependencyTable | An array of dependencies that must always be installed for this package. | +| [description](./node-core-library.inodepackagejson.description.md) | string | A brief description of the package. | +| [devDependencies](./node-core-library.inodepackagejson.devdependencies.md) | IPackageJsonDependencyTable | An array of dependencies that must only be installed for developers who will build this package. | +| [homepage](./node-core-library.inodepackagejson.homepage.md) | string | The URL to the project's web page. | +| [license](./node-core-library.inodepackagejson.license.md) | string | The name of the license. | +| [main](./node-core-library.inodepackagejson.main.md) | string | The path to the module file that will act as the main entry point. | +| [name](./node-core-library.inodepackagejson.name.md) | string | The name of the package. | +| [optionalDependencies](./node-core-library.inodepackagejson.optionaldependencies.md) | IPackageJsonDependencyTable | An array of optional dependencies that may be installed for this package. | +| [peerDependencies](./node-core-library.inodepackagejson.peerdependencies.md) | IPackageJsonDependencyTable | 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 | Indicates whether this package is allowed to be published or not. | +| [repository](./node-core-library.inodepackagejson.repository.md) | string | The URL of the project's repository. | +| [scripts](./node-core-library.inodepackagejson.scripts.md) | IPackageJsonScriptTable | A table of script hooks that a package manager or build tool may invoke. | +| [tsdocMetadata](./node-core-library.inodepackagejson.tsdocmetadata.md) | string | (BETA) 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 | The path to the TypeScript \*.d.ts file describing the module file that will act as the main entry point. | +| [typings](./node-core-library.inodepackagejson.typings.md) | string | Alias for types | +| [version](./node-core-library.inodepackagejson.version.md) | string | A version number conforming to the Semantic Versioning (SemVer) standard. | + +## Remarks + +This interface is the same as [IPackageJson](./node-core-library.ipackagejson.md), except that the `version` field is optional. According to the [NPM documentation](https://docs.npmjs.com/files/package.json) and [CommonJS Packages specification](http://wiki.commonjs.org/wiki/Packages/1.0), the `version` field is normally a required field for package.json files. + +However, NodeJS relaxes this requirement for its `require()` API. The ["Folders as Modules" section](https://nodejs.org/dist/latest-v10.x/docs/api/modules.html#modules_folders_as_modules) from the NodeJS documentation gives an example of a package.json file that has only the `name` and `main` fields. NodeJS does not consider the `version` field during resolution, so it can be omitted. Some libraries do this. + +Use the `INodePackageJson` interface when loading such files. Use `IPackageJson` for package.json files that are installed from an NPM registry, or are otherwise known to have a `version` field. + diff --git a/pages/api/node-core-library.inodepackagejson.name.md b/pages/api/node-core-library.inodepackagejson.name.md new file mode 100644 index 000000000..0c6519144 --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.name.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [name](./node-core-library.inodepackagejson.name.md) + +## INodePackageJson.name property + +The name of the package. + +Signature: + +```typescript +name: string; +``` diff --git a/pages/api/node-core-library.inodepackagejson.optionaldependencies.md b/pages/api/node-core-library.inodepackagejson.optionaldependencies.md new file mode 100644 index 000000000..14e7aea88 --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.optionaldependencies.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [optionalDependencies](./node-core-library.inodepackagejson.optionaldependencies.md) + +## INodePackageJson.optionalDependencies property + +An array of optional dependencies that may be installed for this package. + +Signature: + +```typescript +optionalDependencies?: IPackageJsonDependencyTable; +``` diff --git a/pages/api/node-core-library.inodepackagejson.peerdependencies.md b/pages/api/node-core-library.inodepackagejson.peerdependencies.md new file mode 100644 index 000000000..bbaafeaee --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.peerdependencies.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [peerDependencies](./node-core-library.inodepackagejson.peerdependencies.md) + +## INodePackageJson.peerDependencies property + +An array of dependencies that must be installed by a consumer of this package, but which will not be automatically installed by this package. + +Signature: + +```typescript +peerDependencies?: IPackageJsonDependencyTable; +``` diff --git a/pages/api/node-core-library.inodepackagejson.private.md b/pages/api/node-core-library.inodepackagejson.private.md new file mode 100644 index 000000000..601544ef3 --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.private.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [private](./node-core-library.inodepackagejson.private.md) + +## INodePackageJson.private property + +Indicates whether this package is allowed to be published or not. + +Signature: + +```typescript +private?: boolean; +``` diff --git a/pages/api/node-core-library.inodepackagejson.repository.md b/pages/api/node-core-library.inodepackagejson.repository.md new file mode 100644 index 000000000..f45d2acc6 --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.repository.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [repository](./node-core-library.inodepackagejson.repository.md) + +## INodePackageJson.repository property + +The URL of the project's repository. + +Signature: + +```typescript +repository?: string; +``` diff --git a/pages/api/node-core-library.inodepackagejson.scripts.md b/pages/api/node-core-library.inodepackagejson.scripts.md new file mode 100644 index 000000000..da52bfd7e --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.scripts.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [scripts](./node-core-library.inodepackagejson.scripts.md) + +## INodePackageJson.scripts property + +A table of script hooks that a package manager or build tool may invoke. + +Signature: + +```typescript +scripts?: IPackageJsonScriptTable; +``` diff --git a/pages/api/node-core-library.inodepackagejson.tsdocmetadata.md b/pages/api/node-core-library.inodepackagejson.tsdocmetadata.md new file mode 100644 index 000000000..5f7de699d --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.tsdocmetadata.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [tsdocMetadata](./node-core-library.inodepackagejson.tsdocmetadata.md) + +## INodePackageJson.tsdocMetadata 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. +> + +The path to the TSDoc metadata file. This is still being standardized: https://github.com/Microsoft/tsdoc/issues/7\#issuecomment-442271815 + +Signature: + +```typescript +tsdocMetadata?: string; +``` diff --git a/pages/api/node-core-library.inodepackagejson.types.md b/pages/api/node-core-library.inodepackagejson.types.md new file mode 100644 index 000000000..2d6f2ed0d --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.types.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [types](./node-core-library.inodepackagejson.types.md) + +## INodePackageJson.types property + +The path to the TypeScript \*.d.ts file describing the module file that will act as the main entry point. + +Signature: + +```typescript +types?: string; +``` diff --git a/pages/api/node-core-library.inodepackagejson.typings.md b/pages/api/node-core-library.inodepackagejson.typings.md new file mode 100644 index 000000000..1840098b7 --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.typings.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [typings](./node-core-library.inodepackagejson.typings.md) + +## INodePackageJson.typings property + +Alias for `types` + +Signature: + +```typescript +typings?: string; +``` diff --git a/pages/api/node-core-library.inodepackagejson.version.md b/pages/api/node-core-library.inodepackagejson.version.md new file mode 100644 index 000000000..4b0afc6bc --- /dev/null +++ b/pages/api/node-core-library.inodepackagejson.version.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [INodePackageJson](./node-core-library.inodepackagejson.md) > [version](./node-core-library.inodepackagejson.version.md) + +## INodePackageJson.version property + +A version number conforming to the Semantic Versioning (SemVer) standard. + +Signature: + +```typescript +version?: string; +``` diff --git a/pages/api/node-core-library.internalerror._constructor_.md b/pages/api/node-core-library.internalerror._constructor_.md new file mode 100644 index 000000000..5d108eace --- /dev/null +++ b/pages/api/node-core-library.internalerror._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [InternalError](./node-core-library.internalerror.md) > [(constructor)](./node-core-library.internalerror._constructor_.md) + +## InternalError.(constructor) + +Constructs a new instance of the [InternalError](./node-core-library.internalerror.md) class. + +Signature: + +```typescript +constructor(message: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| message | string | A message describing the error. This will be assigned to [InternalError.unformattedMessage](./node-core-library.internalerror.unformattedmessage.md). The Error.message field will have additional boilerplate explaining that the user has encountered a software defect. | + diff --git a/pages/api/node-core-library.internalerror.breakindebugger.md b/pages/api/node-core-library.internalerror.breakindebugger.md new file mode 100644 index 000000000..5e9260039 --- /dev/null +++ b/pages/api/node-core-library.internalerror.breakindebugger.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [InternalError](./node-core-library.internalerror.md) > [breakInDebugger](./node-core-library.internalerror.breakindebugger.md) + +## InternalError.breakInDebugger property + +If true, a JavScript `debugger;` statement will be invoked whenever the `InternalError` constructor is called. + +Signature: + +```typescript +static breakInDebugger: boolean; +``` + +## Remarks + +Generally applications should not be catching and ignoring an `InternalError`. Instead, the error should be reported and typically the application will terminate. Thus, if `InternalError` is constructed, it's almost always something we want to examine in a debugger. + diff --git a/pages/api/node-core-library.internalerror.md b/pages/api/node-core-library.internalerror.md new file mode 100644 index 000000000..d6937ed55 --- /dev/null +++ b/pages/api/node-core-library.internalerror.md @@ -0,0 +1,42 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [InternalError](./node-core-library.internalerror.md) + +## InternalError class + +An `Error` subclass that should be thrown to report an unexpected state that may indicate a software defect. An application may handle this error by instructing the end user to report an issue to the application maintainers. + +Signature: + +```typescript +export declare class InternalError extends Error +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(message)](./node-core-library.internalerror._constructor_.md) | | Constructs a new instance of the [InternalError](./node-core-library.internalerror.md) class. | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [breakInDebugger](./node-core-library.internalerror.breakindebugger.md) | static | boolean | If true, a JavScript debugger; statement will be invoked whenever the InternalError constructor is called. | +| [unformattedMessage](./node-core-library.internalerror.unformattedmessage.md) | | string | The underlying error message, without the additional boilerplate for an InternalError. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [toString()](./node-core-library.internalerror.tostring.md) | | | + +## Remarks + +Do not use this class unless you intend to solicit bug reports from end users. + diff --git a/pages/api/node-core-library.internalerror.tostring.md b/pages/api/node-core-library.internalerror.tostring.md new file mode 100644 index 000000000..9dcec0483 --- /dev/null +++ b/pages/api/node-core-library.internalerror.tostring.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [InternalError](./node-core-library.internalerror.md) > [toString](./node-core-library.internalerror.tostring.md) + +## InternalError.toString() method + + +Signature: + +```typescript +/** @override */ +toString(): string; +``` +Returns: + +`string` + diff --git a/pages/api/node-core-library.internalerror.unformattedmessage.md b/pages/api/node-core-library.internalerror.unformattedmessage.md new file mode 100644 index 000000000..6b3cbc73c --- /dev/null +++ b/pages/api/node-core-library.internalerror.unformattedmessage.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [InternalError](./node-core-library.internalerror.md) > [unformattedMessage](./node-core-library.internalerror.unformattedmessage.md) + +## InternalError.unformattedMessage property + +The underlying error message, without the additional boilerplate for an `InternalError`. + +Signature: + +```typescript +readonly unformattedMessage: string; +``` diff --git a/pages/api/node-core-library.ipackagejson.md b/pages/api/node-core-library.ipackagejson.md new file mode 100644 index 000000000..7a589409e --- /dev/null +++ b/pages/api/node-core-library.ipackagejson.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IPackageJson](./node-core-library.ipackagejson.md) + +## IPackageJson interface + +An interface for accessing common fields from a package.json file. + +Signature: + +```typescript +export interface IPackageJson extends INodePackageJson +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [version](./node-core-library.ipackagejson.version.md) | string | A version number conforming to the Semantic Versioning (SemVer) standard. | + +## Remarks + +This interface describes a package.json file format whose `name` and `version` field are required. In some situations, the `version` field is optional; in that case, use the [INodePackageJson](./node-core-library.inodepackagejson.md) interface instead. + +More fields may be added to this interface in the future. For documentation about the package.json file format, see the [CommonJS Packages specification](http://wiki.commonjs.org/wiki/Packages/1.0) and the [NPM manual page](https://docs.npmjs.com/files/package.json). + diff --git a/pages/api/node-core-library.ipackagejson.version.md b/pages/api/node-core-library.ipackagejson.version.md new file mode 100644 index 000000000..28cb11ea9 --- /dev/null +++ b/pages/api/node-core-library.ipackagejson.version.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IPackageJson](./node-core-library.ipackagejson.md) > [version](./node-core-library.ipackagejson.version.md) + +## IPackageJson.version property + +A version number conforming to the Semantic Versioning (SemVer) standard. + +Signature: + +```typescript +version: string; +``` diff --git a/pages/api/node-core-library.ipackagejsondependencytable.md b/pages/api/node-core-library.ipackagejsondependencytable.md new file mode 100644 index 000000000..de779f460 --- /dev/null +++ b/pages/api/node-core-library.ipackagejsondependencytable.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IPackageJsonDependencyTable](./node-core-library.ipackagejsondependencytable.md) + +## IPackageJsonDependencyTable interface + +This interface is part of the IPackageJson file format. It is used for the "dependencies", "optionalDependencies", and "devDependencies" fields. + +Signature: + +```typescript +export interface IPackageJsonDependencyTable +``` diff --git a/pages/api/node-core-library.ipackagejsonlookupparameters.loadextrafields.md b/pages/api/node-core-library.ipackagejsonlookupparameters.loadextrafields.md new file mode 100644 index 000000000..9e68a3db8 --- /dev/null +++ b/pages/api/node-core-library.ipackagejsonlookupparameters.loadextrafields.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IPackageJsonLookupParameters](./node-core-library.ipackagejsonlookupparameters.md) > [loadExtraFields](./node-core-library.ipackagejsonlookupparameters.loadextrafields.md) + +## IPackageJsonLookupParameters.loadExtraFields property + +Certain package.json fields such as "contributors" can be very large, and may significantly increase the memory footprint for the PackageJsonLookup cache. By default, PackageJsonLookup only loads a subset of standard commonly used fields names. Set loadExtraFields=true to always return all fields. + +Signature: + +```typescript +loadExtraFields?: boolean; +``` diff --git a/pages/api/node-core-library.ipackagejsonlookupparameters.md b/pages/api/node-core-library.ipackagejsonlookupparameters.md new file mode 100644 index 000000000..1b1e8a91c --- /dev/null +++ b/pages/api/node-core-library.ipackagejsonlookupparameters.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IPackageJsonLookupParameters](./node-core-library.ipackagejsonlookupparameters.md) + +## IPackageJsonLookupParameters interface + +Constructor parameters for [PackageJsonLookup](./node-core-library.packagejsonlookup.md) + +Signature: + +```typescript +export interface IPackageJsonLookupParameters +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [loadExtraFields](./node-core-library.ipackagejsonlookupparameters.loadextrafields.md) | boolean | Certain package.json fields such as "contributors" can be very large, and may significantly increase the memory footprint for the PackageJsonLookup cache. By default, PackageJsonLookup only loads a subset of standard commonly used fields names. Set loadExtraFields=true to always return all fields. | + diff --git a/pages/api/node-core-library.ipackagejsonscripttable.md b/pages/api/node-core-library.ipackagejsonscripttable.md new file mode 100644 index 000000000..126f15e9c --- /dev/null +++ b/pages/api/node-core-library.ipackagejsonscripttable.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IPackageJsonScriptTable](./node-core-library.ipackagejsonscripttable.md) + +## IPackageJsonScriptTable interface + +This interface is part of the IPackageJson file format. It is used for the "scripts" field. + +Signature: + +```typescript +export interface IPackageJsonScriptTable +``` diff --git a/pages/api/node-core-library.iparsedpackagename.md b/pages/api/node-core-library.iparsedpackagename.md new file mode 100644 index 000000000..0c7927b16 --- /dev/null +++ b/pages/api/node-core-library.iparsedpackagename.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IParsedPackageName](./node-core-library.iparsedpackagename.md) + +## IParsedPackageName interface + +A package name that has been separated into its scope and unscoped name. + +Signature: + +```typescript +export interface IParsedPackageName +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [scope](./node-core-library.iparsedpackagename.scope.md) | string | The parsed NPM scope, or an empty string if there was no scope. The scope value will always include the at-sign. | +| [unscopedName](./node-core-library.iparsedpackagename.unscopedname.md) | string | The parsed NPM package name without the scope. | + diff --git a/pages/api/node-core-library.iparsedpackagename.scope.md b/pages/api/node-core-library.iparsedpackagename.scope.md new file mode 100644 index 000000000..80aa56303 --- /dev/null +++ b/pages/api/node-core-library.iparsedpackagename.scope.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IParsedPackageName](./node-core-library.iparsedpackagename.md) > [scope](./node-core-library.iparsedpackagename.scope.md) + +## IParsedPackageName.scope property + +The parsed NPM scope, or an empty string if there was no scope. The scope value will always include the at-sign. + +Signature: + +```typescript +scope: string; +``` + +## Remarks + +For example, if the parsed input was "@scope/example", then scope would be "@scope". + diff --git a/pages/api/node-core-library.iparsedpackagename.unscopedname.md b/pages/api/node-core-library.iparsedpackagename.unscopedname.md new file mode 100644 index 000000000..aefede965 --- /dev/null +++ b/pages/api/node-core-library.iparsedpackagename.unscopedname.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IParsedPackageName](./node-core-library.iparsedpackagename.md) > [unscopedName](./node-core-library.iparsedpackagename.unscopedname.md) + +## IParsedPackageName.unscopedName property + +The parsed NPM package name without the scope. + +Signature: + +```typescript +unscopedName: string; +``` + +## Remarks + +For example, if the parsed input was "@scope/example", then the name would be "example". + diff --git a/pages/api/node-core-library.iparsedpackagenameorerror.error.md b/pages/api/node-core-library.iparsedpackagenameorerror.error.md new file mode 100644 index 000000000..1b43846a5 --- /dev/null +++ b/pages/api/node-core-library.iparsedpackagenameorerror.error.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IParsedPackageNameOrError](./node-core-library.iparsedpackagenameorerror.md) > [error](./node-core-library.iparsedpackagenameorerror.error.md) + +## IParsedPackageNameOrError.error property + +If the input string could not be parsed, then this string will contain a nonempty error message. Otherwise it will be an empty string. + +Signature: + +```typescript +error: string; +``` diff --git a/pages/api/node-core-library.iparsedpackagenameorerror.md b/pages/api/node-core-library.iparsedpackagenameorerror.md new file mode 100644 index 000000000..2e340ea9f --- /dev/null +++ b/pages/api/node-core-library.iparsedpackagenameorerror.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IParsedPackageNameOrError](./node-core-library.iparsedpackagenameorerror.md) + +## IParsedPackageNameOrError interface + +Result object returned by [PackageName.tryParse()](./node-core-library.packagename.tryparse.md) + +Signature: + +```typescript +export interface IParsedPackageNameOrError extends IParsedPackageName +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [error](./node-core-library.iparsedpackagenameorerror.error.md) | string | If the input string could not be parsed, then this string will contain a nonempty error message. Otherwise it will be an empty string. | + diff --git a/pages/api/node-core-library.iprotectablemapparameters.md b/pages/api/node-core-library.iprotectablemapparameters.md new file mode 100644 index 000000000..1e4475057 --- /dev/null +++ b/pages/api/node-core-library.iprotectablemapparameters.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IProtectableMapParameters](./node-core-library.iprotectablemapparameters.md) + +## IProtectableMapParameters interface + +Constructor parameters for [ProtectableMap](./node-core-library.protectablemap.md) + +Signature: + +```typescript +export interface IProtectableMapParameters +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [onClear](./node-core-library.iprotectablemapparameters.onclear.md) | (source: ProtectableMap<K, V>) => void | An optional hook that will be invoked before Map.clear() is performed. | +| [onDelete](./node-core-library.iprotectablemapparameters.ondelete.md) | (source: ProtectableMap<K, V>, key: K) => void | An optional hook that will be invoked before Map.delete() is performed. | +| [onSet](./node-core-library.iprotectablemapparameters.onset.md) | (source: ProtectableMap<K, V>, key: K, value: V) => V | An optional hook that will be invoked before Map.set() is performed. | + diff --git a/pages/api/node-core-library.iprotectablemapparameters.onclear.md b/pages/api/node-core-library.iprotectablemapparameters.onclear.md new file mode 100644 index 000000000..c9f1c3c7d --- /dev/null +++ b/pages/api/node-core-library.iprotectablemapparameters.onclear.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IProtectableMapParameters](./node-core-library.iprotectablemapparameters.md) > [onClear](./node-core-library.iprotectablemapparameters.onclear.md) + +## IProtectableMapParameters.onClear property + +An optional hook that will be invoked before Map.clear() is performed. + +Signature: + +```typescript +onClear?: (source: ProtectableMap) => void; +``` diff --git a/pages/api/node-core-library.iprotectablemapparameters.ondelete.md b/pages/api/node-core-library.iprotectablemapparameters.ondelete.md new file mode 100644 index 000000000..3b9a37e47 --- /dev/null +++ b/pages/api/node-core-library.iprotectablemapparameters.ondelete.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IProtectableMapParameters](./node-core-library.iprotectablemapparameters.md) > [onDelete](./node-core-library.iprotectablemapparameters.ondelete.md) + +## IProtectableMapParameters.onDelete property + +An optional hook that will be invoked before Map.delete() is performed. + +Signature: + +```typescript +onDelete?: (source: ProtectableMap, key: K) => void; +``` diff --git a/pages/api/node-core-library.iprotectablemapparameters.onset.md b/pages/api/node-core-library.iprotectablemapparameters.onset.md new file mode 100644 index 000000000..08ed00c34 --- /dev/null +++ b/pages/api/node-core-library.iprotectablemapparameters.onset.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IProtectableMapParameters](./node-core-library.iprotectablemapparameters.md) > [onSet](./node-core-library.iprotectablemapparameters.onset.md) + +## IProtectableMapParameters.onSet property + +An optional hook that will be invoked before Map.set() is performed. + +Signature: + +```typescript +onSet?: (source: ProtectableMap, key: K, value: V) => V; +``` + +## Remarks + +If this hook is provided, the function MUST return the `value` parameter. This provides the opportunity to modify the value before it is added to the map. + diff --git a/pages/api/node-core-library.istringbuilder.append.md b/pages/api/node-core-library.istringbuilder.append.md new file mode 100644 index 000000000..469401992 --- /dev/null +++ b/pages/api/node-core-library.istringbuilder.append.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IStringBuilder](./node-core-library.istringbuilder.md) > [append](./node-core-library.istringbuilder.append.md) + +## IStringBuilder.append() method + +Append the specified text to the buffer. + +Signature: + +```typescript +append(text: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.istringbuilder.md b/pages/api/node-core-library.istringbuilder.md new file mode 100644 index 000000000..2c2621324 --- /dev/null +++ b/pages/api/node-core-library.istringbuilder.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IStringBuilder](./node-core-library.istringbuilder.md) + +## IStringBuilder interface + +An interface for a builder object that allows a large text string to be constructed incrementally by appending small chunks. + +Signature: + +```typescript +export interface IStringBuilder +``` + +## Methods + +| Method | Description | +| --- | --- | +| [append(text)](./node-core-library.istringbuilder.append.md) | Append the specified text to the buffer. | +| [toString()](./node-core-library.istringbuilder.tostring.md) | Returns a single string containing all the text that was appended to the buffer so far. | + +## Remarks + +[StringBuilder](./node-core-library.stringbuilder.md) is the default implementation of this contract. + diff --git a/pages/api/node-core-library.istringbuilder.tostring.md b/pages/api/node-core-library.istringbuilder.tostring.md new file mode 100644 index 000000000..b0c5caed5 --- /dev/null +++ b/pages/api/node-core-library.istringbuilder.tostring.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [IStringBuilder](./node-core-library.istringbuilder.md) > [toString](./node-core-library.istringbuilder.tostring.md) + +## IStringBuilder.toString() method + +Returns a single string containing all the text that was appended to the buffer so far. + +Signature: + +```typescript +toString(): string; +``` +Returns: + +`string` + +## Remarks + +This is a potentially expensive operation. + diff --git a/pages/api/node-core-library.iterminalprovider.eolcharacter.md b/pages/api/node-core-library.iterminalprovider.eolcharacter.md new file mode 100644 index 000000000..0c1579d40 --- /dev/null +++ b/pages/api/node-core-library.iterminalprovider.eolcharacter.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ITerminalProvider](./node-core-library.iterminalprovider.md) > [eolCharacter](./node-core-library.iterminalprovider.eolcharacter.md) + +## ITerminalProvider.eolCharacter property + +> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> + +This property should return the newline character the terminal provider expects. + +Signature: + +```typescript +eolCharacter: string; +``` diff --git a/pages/api/node-core-library.iterminalprovider.md b/pages/api/node-core-library.iterminalprovider.md new file mode 100644 index 000000000..82817a46e --- /dev/null +++ b/pages/api/node-core-library.iterminalprovider.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ITerminalProvider](./node-core-library.iterminalprovider.md) + +## ITerminalProvider interface + +> 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. +> + +Implement the interface to create a terminal provider. Terminal providers can be registered to a [Terminal](./node-core-library.terminal.md) instance to receive messages. + +Signature: + +```typescript +export interface ITerminalProvider +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [eolCharacter](./node-core-library.iterminalprovider.eolcharacter.md) | string | (BETA) This property should return the newline character the terminal provider expects. | +| [supportsColor](./node-core-library.iterminalprovider.supportscolor.md) | boolean | (BETA) This property should return true only if the terminal provider supports rendering console colors. | + +## Methods + +| Method | Description | +| --- | --- | +| [write(data, severity)](./node-core-library.iterminalprovider.write.md) | (BETA) This function gets called on every terminal provider upon every message function call on the terminal instance. | + diff --git a/pages/api/node-core-library.iterminalprovider.supportscolor.md b/pages/api/node-core-library.iterminalprovider.supportscolor.md new file mode 100644 index 000000000..ab14fe583 --- /dev/null +++ b/pages/api/node-core-library.iterminalprovider.supportscolor.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ITerminalProvider](./node-core-library.iterminalprovider.md) > [supportsColor](./node-core-library.iterminalprovider.supportscolor.md) + +## ITerminalProvider.supportsColor property + +> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> + +This property should return true only if the terminal provider supports rendering console colors. + +Signature: + +```typescript +supportsColor: boolean; +``` diff --git a/pages/api/node-core-library.iterminalprovider.write.md b/pages/api/node-core-library.iterminalprovider.write.md new file mode 100644 index 000000000..3a9481eed --- /dev/null +++ b/pages/api/node-core-library.iterminalprovider.write.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ITerminalProvider](./node-core-library.iterminalprovider.md) > [write](./node-core-library.iterminalprovider.write.md) + +## ITerminalProvider.write() method + +> 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 gets called on every terminal provider upon every message function call on the terminal instance. + +Signature: + +```typescript +write(data: string, severity: TerminalProviderSeverity): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| data | string | The terminal message. | +| severity | TerminalProviderSeverity | The message severity. Terminal providers can route different kinds of messages to different streams and may choose to ignore verbose messages. | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.jsonfile.load.md b/pages/api/node-core-library.jsonfile.load.md new file mode 100644 index 000000000..17130f606 --- /dev/null +++ b/pages/api/node-core-library.jsonfile.load.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [JsonFile](./node-core-library.jsonfile.md) > [load](./node-core-library.jsonfile.load.md) + +## JsonFile.load() method + +Loads a JSON file. + +Signature: + +```typescript +static load(jsonFilename: string): any; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonFilename | string | | + +Returns: + +`any` + diff --git a/pages/api/node-core-library.jsonfile.loadandvalidate.md b/pages/api/node-core-library.jsonfile.loadandvalidate.md new file mode 100644 index 000000000..5fdfed00c --- /dev/null +++ b/pages/api/node-core-library.jsonfile.loadandvalidate.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [JsonFile](./node-core-library.jsonfile.md) > [loadAndValidate](./node-core-library.jsonfile.loadandvalidate.md) + +## JsonFile.loadAndValidate() method + +Loads a JSON file and validate its schema. + +Signature: + +```typescript +static loadAndValidate(jsonFilename: string, jsonSchema: JsonSchema, options?: IJsonSchemaValidateOptions): any; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonFilename | string | | +| jsonSchema | JsonSchema | | +| options | IJsonSchemaValidateOptions | | + +Returns: + +`any` + diff --git a/pages/api/node-core-library.jsonfile.loadandvalidatewithcallback.md b/pages/api/node-core-library.jsonfile.loadandvalidatewithcallback.md new file mode 100644 index 000000000..67cddf1ab --- /dev/null +++ b/pages/api/node-core-library.jsonfile.loadandvalidatewithcallback.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [JsonFile](./node-core-library.jsonfile.md) > [loadAndValidateWithCallback](./node-core-library.jsonfile.loadandvalidatewithcallback.md) + +## JsonFile.loadAndValidateWithCallback() method + +Loads a JSON file and validate its schema, reporting errors using a callback + +Signature: + +```typescript +static loadAndValidateWithCallback(jsonFilename: string, jsonSchema: JsonSchema, errorCallback: (errorInfo: IJsonSchemaErrorInfo) => void): any; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonFilename | string | | +| jsonSchema | JsonSchema | | +| errorCallback | (errorInfo: IJsonSchemaErrorInfo) => void | | + +Returns: + +`any` + +## Remarks + +See JsonSchema.validateObjectWithCallback() for more info. + diff --git a/pages/api/node-core-library.jsonfile.md b/pages/api/node-core-library.jsonfile.md new file mode 100644 index 000000000..44584c428 --- /dev/null +++ b/pages/api/node-core-library.jsonfile.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [JsonFile](./node-core-library.jsonfile.md) + +## JsonFile class + +Utilities for reading/writing JSON files. + +Signature: + +```typescript +export declare class JsonFile +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [load(jsonFilename)](./node-core-library.jsonfile.load.md) | static | Loads a JSON file. | +| [loadAndValidate(jsonFilename, jsonSchema, options)](./node-core-library.jsonfile.loadandvalidate.md) | static | Loads a JSON file and validate its schema. | +| [loadAndValidateWithCallback(jsonFilename, jsonSchema, errorCallback)](./node-core-library.jsonfile.loadandvalidatewithcallback.md) | static | Loads a JSON file and validate its schema, reporting errors using a callback | +| [save(jsonObject, jsonFilename, options)](./node-core-library.jsonfile.save.md) | static | Saves the file to disk. Returns false if nothing was written due to options.onlyIfChanged. | +| [stringify(jsonObject, options)](./node-core-library.jsonfile.stringify.md) | static | Serializes the specified JSON object to a string buffer. | +| [updateString(previousJson, newJsonObject, options)](./node-core-library.jsonfile.updatestring.md) | static | Serializes the specified JSON object to a string buffer. | +| [validateNoUndefinedMembers(jsonObject)](./node-core-library.jsonfile.validatenoundefinedmembers.md) | static | Used to validate a data structure before writing. Reports an error if there are any undefined members. | + diff --git a/pages/api/node-core-library.jsonfile.save.md b/pages/api/node-core-library.jsonfile.save.md new file mode 100644 index 000000000..a7dd73a5c --- /dev/null +++ b/pages/api/node-core-library.jsonfile.save.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [JsonFile](./node-core-library.jsonfile.md) > [save](./node-core-library.jsonfile.save.md) + +## JsonFile.save() method + +Saves the file to disk. Returns false if nothing was written due to options.onlyIfChanged. + +Signature: + +```typescript +static save(jsonObject: Object, jsonFilename: string, options?: IJsonFileSaveOptions): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Object | the object to be saved | +| jsonFilename | string | the file path to write | +| options | IJsonFileSaveOptions | other settings that control how the file is saved | + +Returns: + +`boolean` + +false if ISaveJsonFileOptions.onlyIfChanged didn't save anything; true otherwise + diff --git a/pages/api/node-core-library.jsonfile.stringify.md b/pages/api/node-core-library.jsonfile.stringify.md new file mode 100644 index 000000000..3dabc7a60 --- /dev/null +++ b/pages/api/node-core-library.jsonfile.stringify.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [JsonFile](./node-core-library.jsonfile.md) > [stringify](./node-core-library.jsonfile.stringify.md) + +## JsonFile.stringify() method + +Serializes the specified JSON object to a string buffer. + +Signature: + +```typescript +static stringify(jsonObject: Object, options?: IJsonFileStringifyOptions): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Object | the object to be serialized | +| options | IJsonFileStringifyOptions | other settings that control serialization | + +Returns: + +`string` + +a JSON string, with newlines, and indented with two spaces + diff --git a/pages/api/node-core-library.jsonfile.updatestring.md b/pages/api/node-core-library.jsonfile.updatestring.md new file mode 100644 index 000000000..dad4d5ae7 --- /dev/null +++ b/pages/api/node-core-library.jsonfile.updatestring.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [JsonFile](./node-core-library.jsonfile.md) > [updateString](./node-core-library.jsonfile.updatestring.md) + +## JsonFile.updateString() method + +Serializes the specified JSON object to a string buffer. + +Signature: + +```typescript +static updateString(previousJson: string, newJsonObject: Object, options?: IJsonFileStringifyOptions): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| previousJson | string | | +| newJsonObject | Object | | +| options | IJsonFileStringifyOptions | other settings that control serialization | + +Returns: + +`string` + +a JSON string, with newlines, and indented with two spaces + diff --git a/pages/api/node-core-library.jsonfile.validatenoundefinedmembers.md b/pages/api/node-core-library.jsonfile.validatenoundefinedmembers.md new file mode 100644 index 000000000..f6800b7c9 --- /dev/null +++ b/pages/api/node-core-library.jsonfile.validatenoundefinedmembers.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [JsonFile](./node-core-library.jsonfile.md) > [validateNoUndefinedMembers](./node-core-library.jsonfile.validatenoundefinedmembers.md) + +## JsonFile.validateNoUndefinedMembers() method + +Used to validate a data structure before writing. Reports an error if there are any undefined members. + +Signature: + +```typescript +static validateNoUndefinedMembers(jsonObject: Object): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Object | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.jsonschema.ensurecompiled.md b/pages/api/node-core-library.jsonschema.ensurecompiled.md new file mode 100644 index 000000000..5ac59007c --- /dev/null +++ b/pages/api/node-core-library.jsonschema.ensurecompiled.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [JsonSchema](./node-core-library.jsonschema.md) > [ensureCompiled](./node-core-library.jsonschema.ensurecompiled.md) + +## JsonSchema.ensureCompiled() method + +If not already done, this loads the schema from disk and compiles it. + +Signature: + +```typescript +ensureCompiled(): void; +``` +Returns: + +`void` + +## Remarks + +Any dependencies will be compiled as well. + diff --git a/pages/api/node-core-library.jsonschema.fromfile.md b/pages/api/node-core-library.jsonschema.fromfile.md new file mode 100644 index 000000000..01a5a2948 --- /dev/null +++ b/pages/api/node-core-library.jsonschema.fromfile.md @@ -0,0 +1,34 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [JsonSchema](./node-core-library.jsonschema.md) > [fromFile](./node-core-library.jsonschema.fromfile.md) + +## JsonSchema.fromFile() method + +Registers a JsonSchema that will be loaded from a file on disk. + +Signature: + +```typescript +static fromFile(filename: string, options?: IJsonSchemaFromFileOptions): JsonSchema; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filename | string | | +| options | IJsonSchemaFromFileOptions | | + +Returns: + +`JsonSchema` + +## Remarks + +NOTE: An error occurs if the file does not exist; however, the file itself is not loaded or validated until it the schema is actually used. + diff --git a/pages/api/node-core-library.jsonschema.fromloadedobject.md b/pages/api/node-core-library.jsonschema.fromloadedobject.md new file mode 100644 index 000000000..58f38bea0 --- /dev/null +++ b/pages/api/node-core-library.jsonschema.fromloadedobject.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [JsonSchema](./node-core-library.jsonschema.md) > [fromLoadedObject](./node-core-library.jsonschema.fromloadedobject.md) + +## JsonSchema.fromLoadedObject() method + +Registers a JsonSchema that will be loaded from a file on disk. + +Signature: + +```typescript +static fromLoadedObject(schemaObject: Object): JsonSchema; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| schemaObject | Object | | + +Returns: + +`JsonSchema` + +## Remarks + +NOTE: An error occurs if the file does not exist; however, the file itself is not loaded or validated until it the schema is actually used. + diff --git a/pages/api/node-core-library.jsonschema.md b/pages/api/node-core-library.jsonschema.md new file mode 100644 index 000000000..ef9a7045b --- /dev/null +++ b/pages/api/node-core-library.jsonschema.md @@ -0,0 +1,39 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [JsonSchema](./node-core-library.jsonschema.md) + +## JsonSchema class + +Represents a JSON schema that can be used to validate JSON data files loaded by the JsonFile class. + +Signature: + +```typescript +export declare class JsonSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [shortName](./node-core-library.jsonschema.shortname.md) | | string | Returns a short name for this schema, for use in error messages. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [ensureCompiled()](./node-core-library.jsonschema.ensurecompiled.md) | | If not already done, this loads the schema from disk and compiles it. | +| [fromFile(filename, options)](./node-core-library.jsonschema.fromfile.md) | static | Registers a JsonSchema that will be loaded from a file on disk. | +| [fromLoadedObject(schemaObject)](./node-core-library.jsonschema.fromloadedobject.md) | static | Registers a JsonSchema that will be loaded from a file on disk. | +| [validateObject(jsonObject, filenameForErrors, options)](./node-core-library.jsonschema.validateobject.md) | | Validates the specified JSON object against this JSON schema. If the validation fails, an exception will be thrown. | +| [validateObjectWithCallback(jsonObject, errorCallback)](./node-core-library.jsonschema.validateobjectwithcallback.md) | | Validates the specified JSON object against this JSON schema. If the validation fails, a callback is called for each validation error. | + +## Remarks + +The schema itself is normally loaded and compiled later, only if it is actually required to validate an input. To avoid schema errors at runtime, it's recommended to create a unit test that calls JsonSchema.ensureCompiled() for each of your schema objects. + diff --git a/pages/api/node-core-library.jsonschema.shortname.md b/pages/api/node-core-library.jsonschema.shortname.md new file mode 100644 index 000000000..b54dfb665 --- /dev/null +++ b/pages/api/node-core-library.jsonschema.shortname.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [JsonSchema](./node-core-library.jsonschema.md) > [shortName](./node-core-library.jsonschema.shortname.md) + +## JsonSchema.shortName property + +Returns a short name for this schema, for use in error messages. + +Signature: + +```typescript +readonly shortName: string; +``` + +## Remarks + +If the schema was loaded from a file, then the base filename is used. Otherwise, the "id" field is used if available. + diff --git a/pages/api/node-core-library.jsonschema.validateobject.md b/pages/api/node-core-library.jsonschema.validateobject.md new file mode 100644 index 000000000..1ebf0c2e3 --- /dev/null +++ b/pages/api/node-core-library.jsonschema.validateobject.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [JsonSchema](./node-core-library.jsonschema.md) > [validateObject](./node-core-library.jsonschema.validateobject.md) + +## JsonSchema.validateObject() method + +Validates the specified JSON object against this JSON schema. If the validation fails, an exception will be thrown. + +Signature: + +```typescript +validateObject(jsonObject: Object, filenameForErrors: string, options?: IJsonSchemaValidateOptions): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Object | The JSON data to be validated | +| filenameForErrors | string | The filename that the JSON data was available, or an empty string if not applicable | +| options | IJsonSchemaValidateOptions | Other options that control the validation | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.jsonschema.validateobjectwithcallback.md b/pages/api/node-core-library.jsonschema.validateobjectwithcallback.md new file mode 100644 index 000000000..f2218777d --- /dev/null +++ b/pages/api/node-core-library.jsonschema.validateobjectwithcallback.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [JsonSchema](./node-core-library.jsonschema.md) > [validateObjectWithCallback](./node-core-library.jsonschema.validateobjectwithcallback.md) + +## JsonSchema.validateObjectWithCallback() method + +Validates the specified JSON object against this JSON schema. If the validation fails, a callback is called for each validation error. + +Signature: + +```typescript +validateObjectWithCallback(jsonObject: Object, errorCallback: (errorInfo: IJsonSchemaErrorInfo) => void): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | Object | | +| errorCallback | (errorInfo: IJsonSchemaErrorInfo) => void | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.legacyadapters.convertcallbacktopromise.md b/pages/api/node-core-library.legacyadapters.convertcallbacktopromise.md new file mode 100644 index 000000000..61fab551d --- /dev/null +++ b/pages/api/node-core-library.legacyadapters.convertcallbacktopromise.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [LegacyAdapters](./node-core-library.legacyadapters.md) > [convertCallbackToPromise](./node-core-library.legacyadapters.convertcallbacktopromise.md) + +## LegacyAdapters.convertCallbackToPromise() method + +> 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 wraps a function with a callback in a promise. + +Signature: + +```typescript +static convertCallbackToPromise(fn: (cb: callback) => void): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | (cb: callback<TResult, TError>) => void | | + +Returns: + +`Promise` + diff --git a/pages/api/node-core-library.legacyadapters.convertcallbacktopromise_1.md b/pages/api/node-core-library.legacyadapters.convertcallbacktopromise_1.md new file mode 100644 index 000000000..1761abba9 --- /dev/null +++ b/pages/api/node-core-library.legacyadapters.convertcallbacktopromise_1.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [LegacyAdapters](./node-core-library.legacyadapters.md) > [convertCallbackToPromise](./node-core-library.legacyadapters.convertcallbacktopromise_1.md) + +## LegacyAdapters.convertCallbackToPromise() method + +> 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. +> + +Signature: + +```typescript +static convertCallbackToPromise(fn: (arg1: TArg1, cb: callback) => void, arg1: TArg1): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | (arg1: TArg1, cb: callback<TResult, TError>) => void | | +| arg1 | TArg1 | | + +Returns: + +`Promise` + diff --git a/pages/api/node-core-library.legacyadapters.convertcallbacktopromise_2.md b/pages/api/node-core-library.legacyadapters.convertcallbacktopromise_2.md new file mode 100644 index 000000000..5b7d4383d --- /dev/null +++ b/pages/api/node-core-library.legacyadapters.convertcallbacktopromise_2.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [LegacyAdapters](./node-core-library.legacyadapters.md) > [convertCallbackToPromise](./node-core-library.legacyadapters.convertcallbacktopromise_2.md) + +## LegacyAdapters.convertCallbackToPromise() method + +> 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. +> + +Signature: + +```typescript +static convertCallbackToPromise(fn: (arg1: TArg1, arg2: TArg2, cb: callback) => void, arg1: TArg1, arg2: TArg2): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | (arg1: TArg1, arg2: TArg2, cb: callback<TResult, TError>) => void | | +| arg1 | TArg1 | | +| arg2 | TArg2 | | + +Returns: + +`Promise` + diff --git a/pages/api/node-core-library.legacyadapters.md b/pages/api/node-core-library.legacyadapters.md new file mode 100644 index 000000000..0a058fe32 --- /dev/null +++ b/pages/api/node-core-library.legacyadapters.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [LegacyAdapters](./node-core-library.legacyadapters.md) + +## LegacyAdapters class + +> 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. +> + +Helper functions used when interacting with APIs that do not follow modern coding practices. + +Signature: + +```typescript +export declare class LegacyAdapters +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [convertCallbackToPromise(fn)](./node-core-library.legacyadapters.convertcallbacktopromise.md) | static | (BETA) This function wraps a function with a callback in a promise. | +| [convertCallbackToPromise(fn, arg1)](./node-core-library.legacyadapters.convertcallbacktopromise_1.md) | static | (BETA) | +| [convertCallbackToPromise(fn, arg1, arg2)](./node-core-library.legacyadapters.convertcallbacktopromise_2.md) | static | (BETA) | +| [scrubError(error)](./node-core-library.legacyadapters.scruberror.md) | static | (BETA) Normalizes an object into an Error object. | + diff --git a/pages/api/node-core-library.legacyadapters.scruberror.md b/pages/api/node-core-library.legacyadapters.scruberror.md new file mode 100644 index 000000000..fe59490db --- /dev/null +++ b/pages/api/node-core-library.legacyadapters.scruberror.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [LegacyAdapters](./node-core-library.legacyadapters.md) > [scrubError](./node-core-library.legacyadapters.scruberror.md) + +## LegacyAdapters.scrubError() method + +> 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. +> + +Normalizes an object into an `Error` object. + +Signature: + +```typescript +static scrubError(error: Error | string | any): Error; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| error | Error | string | any | | + +Returns: + +`Error` + diff --git a/pages/api/node-core-library.lockfile.acquire.md b/pages/api/node-core-library.lockfile.acquire.md new file mode 100644 index 000000000..3ee047214 --- /dev/null +++ b/pages/api/node-core-library.lockfile.acquire.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [LockFile](./node-core-library.lockfile.md) > [acquire](./node-core-library.lockfile.acquire.md) + +## LockFile.acquire() method + +Attempts to create the lockfile. Will continue to loop at every 100ms until the lock becomes available or the maxWaitMs is surpassed. + +Signature: + +```typescript +static acquire(resourceDir: string, resourceName: string, maxWaitMs?: number): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| resourceDir | string | | +| resourceName | string | | +| maxWaitMs | number | | + +Returns: + +`Promise` + +## Remarks + +This function is subject to starvation, whereby it does not ensure that the process that has been waiting the longest to acquire the lock will get it first. This means that a process could theoretically wait for the lock forever, while other processes skipped it in line and acquired the lock first. + diff --git a/pages/api/node-core-library.lockfile.dirtywhenacquired.md b/pages/api/node-core-library.lockfile.dirtywhenacquired.md new file mode 100644 index 000000000..3a5f0e726 --- /dev/null +++ b/pages/api/node-core-library.lockfile.dirtywhenacquired.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [LockFile](./node-core-library.lockfile.md) > [dirtyWhenAcquired](./node-core-library.lockfile.dirtywhenacquired.md) + +## LockFile.dirtyWhenAcquired property + +Returns the initial state of the lock. This can be used to detect if the previous process was terminated before releasing the resource. + +Signature: + +```typescript +readonly dirtyWhenAcquired: boolean; +``` diff --git a/pages/api/node-core-library.lockfile.filepath.md b/pages/api/node-core-library.lockfile.filepath.md new file mode 100644 index 000000000..c10fb6889 --- /dev/null +++ b/pages/api/node-core-library.lockfile.filepath.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [LockFile](./node-core-library.lockfile.md) > [filePath](./node-core-library.lockfile.filepath.md) + +## LockFile.filePath property + +Returns the absolute path to the lockfile + +Signature: + +```typescript +readonly filePath: string; +``` diff --git a/pages/api/node-core-library.lockfile.getlockfilepath.md b/pages/api/node-core-library.lockfile.getlockfilepath.md new file mode 100644 index 000000000..c81bc53ea --- /dev/null +++ b/pages/api/node-core-library.lockfile.getlockfilepath.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [LockFile](./node-core-library.lockfile.md) > [getLockFilePath](./node-core-library.lockfile.getlockfilepath.md) + +## LockFile.getLockFilePath() method + +Returns the path to the lockfile, should it be created successfully. + +Signature: + +```typescript +static getLockFilePath(resourceDir: string, resourceName: string, pid?: number): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| resourceDir | string | | +| resourceName | string | | +| pid | number | | + +Returns: + +`string` + diff --git a/pages/api/node-core-library.lockfile.isreleased.md b/pages/api/node-core-library.lockfile.isreleased.md new file mode 100644 index 000000000..36a2f669f --- /dev/null +++ b/pages/api/node-core-library.lockfile.isreleased.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [LockFile](./node-core-library.lockfile.md) > [isReleased](./node-core-library.lockfile.isreleased.md) + +## LockFile.isReleased property + +Returns true if this lock is currently being held. + +Signature: + +```typescript +readonly isReleased: boolean; +``` diff --git a/pages/api/node-core-library.lockfile.md b/pages/api/node-core-library.lockfile.md new file mode 100644 index 000000000..a16e4c9b7 --- /dev/null +++ b/pages/api/node-core-library.lockfile.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [LockFile](./node-core-library.lockfile.md) + +## LockFile class + +A helper utility for working with file-based locks. This class should only be used for locking resources across processes, but should not be used for attempting to lock a resource in the same process. + +Signature: + +```typescript +export declare class LockFile +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [dirtyWhenAcquired](./node-core-library.lockfile.dirtywhenacquired.md) | | boolean | Returns the initial state of the lock. This can be used to detect if the previous process was terminated before releasing the resource. | +| [filePath](./node-core-library.lockfile.filepath.md) | | string | Returns the absolute path to the lockfile | +| [isReleased](./node-core-library.lockfile.isreleased.md) | | boolean | Returns true if this lock is currently being held. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [acquire(resourceDir, resourceName, maxWaitMs)](./node-core-library.lockfile.acquire.md) | static | Attempts to create the lockfile. Will continue to loop at every 100ms until the lock becomes available or the maxWaitMs is surpassed. | +| [getLockFilePath(resourceDir, resourceName, pid)](./node-core-library.lockfile.getlockfilepath.md) | static | Returns the path to the lockfile, should it be created successfully. | +| [release()](./node-core-library.lockfile.release.md) | | Unlocks a file and removes it from disk. This can only be called once. | +| [tryAcquire(resourceDir, resourceName)](./node-core-library.lockfile.tryacquire.md) | static | Attempts to create a lockfile with the given filePath. If successful, returns a LockFile instance. If unable to get a lock, returns undefined. | + diff --git a/pages/api/node-core-library.lockfile.release.md b/pages/api/node-core-library.lockfile.release.md new file mode 100644 index 000000000..989e58c46 --- /dev/null +++ b/pages/api/node-core-library.lockfile.release.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [LockFile](./node-core-library.lockfile.md) > [release](./node-core-library.lockfile.release.md) + +## LockFile.release() method + +Unlocks a file and removes it from disk. This can only be called once. + +Signature: + +```typescript +release(): void; +``` +Returns: + +`void` + diff --git a/pages/api/node-core-library.lockfile.tryacquire.md b/pages/api/node-core-library.lockfile.tryacquire.md new file mode 100644 index 000000000..c28ec69d5 --- /dev/null +++ b/pages/api/node-core-library.lockfile.tryacquire.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [LockFile](./node-core-library.lockfile.md) > [tryAcquire](./node-core-library.lockfile.tryacquire.md) + +## LockFile.tryAcquire() method + +Attempts to create a lockfile with the given filePath. If successful, returns a LockFile instance. If unable to get a lock, returns undefined. + +Signature: + +```typescript +static tryAcquire(resourceDir: string, resourceName: string): LockFile | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| resourceDir | string | | +| resourceName | string | the name of the resource we are locking on. Should be an alphabetic string. | + +Returns: + +`LockFile | undefined` + diff --git a/pages/api/node-core-library.mapextensions.md b/pages/api/node-core-library.mapextensions.md new file mode 100644 index 000000000..03694c069 --- /dev/null +++ b/pages/api/node-core-library.mapextensions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [MapExtensions](./node-core-library.mapextensions.md) + +## MapExtensions class + +Helper functions for working with the `Map` data type. + +Signature: + +```typescript +export declare class MapExtensions +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [mergeFromMap(targetMap, sourceMap)](./node-core-library.mapextensions.mergefrommap.md) | static | Adds all the (key, value) pairs from the source map into the target map. | + diff --git a/pages/api/node-core-library.mapextensions.mergefrommap.md b/pages/api/node-core-library.mapextensions.mergefrommap.md new file mode 100644 index 000000000..fac0934af --- /dev/null +++ b/pages/api/node-core-library.mapextensions.mergefrommap.md @@ -0,0 +1,34 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [MapExtensions](./node-core-library.mapextensions.md) > [mergeFromMap](./node-core-library.mapextensions.mergefrommap.md) + +## MapExtensions.mergeFromMap() method + +Adds all the (key, value) pairs from the source map into the target map. + +Signature: + +```typescript +static mergeFromMap(targetMap: Map, sourceMap: ReadonlyMap): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| targetMap | Map<K, V> | The map that entries will be added to | +| sourceMap | ReadonlyMap<K, V> | The map containing the entries to be added | + +Returns: + +`void` + +## Remarks + +This function modifies targetMap. Any existing keys will be overwritten. + diff --git a/pages/api/node-core-library.md b/pages/api/node-core-library.md new file mode 100644 index 000000000..3ba780dca --- /dev/null +++ b/pages/api/node-core-library.md @@ -0,0 +1,92 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) + +## node-core-library package + +Core libraries that every NodeJS toolchain project should use. + +## Classes + +| Class | Description | +| --- | --- | +| [Colors](./node-core-library.colors.md) | (BETA) 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) | (BETA) Terminal provider that prints to STDOUT (for log- and verbose-level messages) and STDERR (for warning- and error-level messsages). | +| [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. | +| [InternalError](./node-core-library.internalerror.md) | An Error subclass that should be thrown to report an unexpected state that may indicate a software defect. An application may handle this error by instructing the end user to report an issue to the application maintainers. | +| [JsonFile](./node-core-library.jsonfile.md) | Utilities for reading/writing JSON files. | +| [JsonSchema](./node-core-library.jsonschema.md) | Represents a JSON schema that can be used to validate JSON data files loaded by the JsonFile class. | +| [LegacyAdapters](./node-core-library.legacyadapters.md) | (BETA) Helper functions used when interacting with APIs that do not follow modern coding practices. | +| [LockFile](./node-core-library.lockfile.md) | A helper utility for working with file-based locks. This class should only be used for locking resources across processes, but should not be used for attempting to lock a resource in the same process. | +| [MapExtensions](./node-core-library.mapextensions.md) | Helper functions for working with the Map<K, V> data type. | +| [PackageJsonLookup](./node-core-library.packagejsonlookup.md) | This class provides methods for finding the nearest "package.json" for a folder and retrieving the name of the package. The results are cached. | +| [PackageName](./node-core-library.packagename.md) | Various functions for working with package names that may include scopes. | +| [Path](./node-core-library.path.md) | Common operations for manipulating file and directory paths. | +| [ProtectableMap](./node-core-library.protectablemap.md) | The ProtectableMap provides an easy way for an API to expose a Map<K, V> property while intercepting and validating any write operations that are performed by consumers of the API. | +| [Sort](./node-core-library.sort.md) | Operations for sorting collections. | +| [StringBufferTerminalProvider](./node-core-library.stringbufferterminalprovider.md) | (BETA) Terminal provider that stores written data in buffers separated by severity. This terminal provider is designed to be used when code that prints to a terminal is being unit tested. | +| [StringBuilder](./node-core-library.stringbuilder.md) | This class allows a large text string to be constructed incrementally by appending small chunks. The final string can be obtained by calling StringBuilder.toString(). | +| [Terminal](./node-core-library.terminal.md) | (BETA) This class facilitates writing to a console. | +| [Text](./node-core-library.text.md) | Operations for working with strings that contain text. | + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [ColorValue](./node-core-library.colorvalue.md) | (BETA) Colors used with [IColorableSequence](./node-core-library.icolorablesequence.md). | +| [Encoding](./node-core-library.encoding.md) | The allowed types of encodings, as supported by Node.js | +| [FileConstants](./node-core-library.fileconstants.md) | String constants for common filenames and parts of filenames. | +| [FolderConstants](./node-core-library.folderconstants.md) | String constants for common folder names. | +| [NewlineKind](./node-core-library.newlinekind.md) | Enumeration controlling conversion of newline characters. | +| [PosixModeBits](./node-core-library.posixmodebits.md) | An integer value used to specify file permissions for POSIX-like operating systems. | +| [TerminalProviderSeverity](./node-core-library.terminalproviderseverity.md) | (BETA) | +| [TextAttribute](./node-core-library.textattribute.md) | (BETA) Text styles used with [IColorableSequence](./node-core-library.icolorablesequence.md). | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [IColorableSequence](./node-core-library.icolorablesequence.md) | (BETA) | +| [IConsoleTerminalProviderOptions](./node-core-library.iconsoleterminalprovideroptions.md) | (BETA) Options to be provided to a [ConsoleTerminalProvider](./node-core-library.consoleterminalprovider.md) | +| [IExecutableResolveOptions](./node-core-library.iexecutableresolveoptions.md) | Options for Executable.tryResolve(). | +| [IExecutableSpawnSyncOptions](./node-core-library.iexecutablespawnsyncoptions.md) | Options for Executable.execute(). | +| [IFileSystemCopyFileOptions](./node-core-library.ifilesystemcopyfileoptions.md) | The options for FileSystem.copyFile() | +| [IFileSystemCreateLinkOptions](./node-core-library.ifilesystemcreatelinkoptions.md) | The options for FileSystem.createSymbolicLinkJunction(), createSymbolicLinkFile(), createSymbolicLinkFolder(), and createHardLink(). | +| [IFileSystemDeleteFileOptions](./node-core-library.ifilesystemdeletefileoptions.md) | The options for FileSystem.deleteFile() | +| [IFileSystemMoveOptions](./node-core-library.ifilesystemmoveoptions.md) | The options for FileSystem.move() | +| [IFileSystemReadFileOptions](./node-core-library.ifilesystemreadfileoptions.md) | The options for FileSystem.readFile() | +| [IFileSystemReadFolderOptions](./node-core-library.ifilesystemreadfolderoptions.md) | The options for FileSystem.readFolder() | +| [IFileSystemUpdateTimeParameters](./node-core-library.ifilesystemupdatetimeparameters.md) | The parameters for updateTimes(). Both times must be specified. | +| [IFileSystemWriteFileOptions](./node-core-library.ifilesystemwritefileoptions.md) | The options for FileSystem.writeFile() | +| [IFileWriterFlags](./node-core-library.ifilewriterflags.md) | Interface which represents the flags about which mode the file should be opened in. | +| [IJsonFileSaveOptions](./node-core-library.ijsonfilesaveoptions.md) | Options for JsonFile.saveJsonFile() | +| [IJsonFileStringifyOptions](./node-core-library.ijsonfilestringifyoptions.md) | Options for JsonFile.stringify() | +| [IJsonSchemaErrorInfo](./node-core-library.ijsonschemaerrorinfo.md) | Callback function arguments for JsonSchema.validateObjectWithCallback(); | +| [IJsonSchemaFromFileOptions](./node-core-library.ijsonschemafromfileoptions.md) | Options for JsonSchema.fromFile() | +| [IJsonSchemaValidateOptions](./node-core-library.ijsonschemavalidateoptions.md) | Options for JsonSchema.validateObject() | +| [INodePackageJson](./node-core-library.inodepackagejson.md) | An interface for accessing common fields from a package.json file whose version field may be missing. | +| [IPackageJson](./node-core-library.ipackagejson.md) | An interface for accessing common fields from a package.json file. | +| [IPackageJsonDependencyTable](./node-core-library.ipackagejsondependencytable.md) | This interface is part of the IPackageJson file format. It is used for the "dependencies", "optionalDependencies", and "devDependencies" fields. | +| [IPackageJsonLookupParameters](./node-core-library.ipackagejsonlookupparameters.md) | Constructor parameters for [PackageJsonLookup](./node-core-library.packagejsonlookup.md) | +| [IPackageJsonScriptTable](./node-core-library.ipackagejsonscripttable.md) | This interface is part of the IPackageJson file format. It is used for the "scripts" field. | +| [IParsedPackageName](./node-core-library.iparsedpackagename.md) | A package name that has been separated into its scope and unscoped name. | +| [IParsedPackageNameOrError](./node-core-library.iparsedpackagenameorerror.md) | Result object returned by [PackageName.tryParse()](./node-core-library.packagename.tryparse.md) | +| [IProtectableMapParameters](./node-core-library.iprotectablemapparameters.md) | Constructor parameters for [ProtectableMap](./node-core-library.protectablemap.md) | +| [IStringBuilder](./node-core-library.istringbuilder.md) | An interface for a builder object that allows a large text string to be constructed incrementally by appending small chunks. | +| [ITerminalProvider](./node-core-library.iterminalprovider.md) | (BETA) Implement the interface to create a terminal provider. Terminal providers can be registered to a [Terminal](./node-core-library.terminal.md) instance to receive messages. | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [callback](./node-core-library.callback.md) | (BETA) Callback used by [LegacyAdapters](./node-core-library.legacyadapters.md). | +| [ExecutableStdioMapping](./node-core-library.executablestdiomapping.md) | Typings for IExecutableSpawnSyncOptions.stdio. | +| [ExecutableStdioStreamMapping](./node-core-library.executablestdiostreammapping.md) | Typings for one of the streams inside IExecutableSpawnSyncOptions.stdio. | + diff --git a/pages/api/node-core-library.newlinekind.md b/pages/api/node-core-library.newlinekind.md new file mode 100644 index 000000000..84fb4f27e --- /dev/null +++ b/pages/api/node-core-library.newlinekind.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [NewlineKind](./node-core-library.newlinekind.md) + +## NewlineKind enum + +Enumeration controlling conversion of newline characters. + +Signature: + +```typescript +export declare const enum NewlineKind +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| CrLf | "\r\n" | Windows-style newlines | +| Lf | "\n" | POSIX-style newlines | + diff --git a/pages/api/node-core-library.packagejsonlookup._constructor_.md b/pages/api/node-core-library.packagejsonlookup._constructor_.md new file mode 100644 index 000000000..fc0507502 --- /dev/null +++ b/pages/api/node-core-library.packagejsonlookup._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageJsonLookup](./node-core-library.packagejsonlookup.md) > [(constructor)](./node-core-library.packagejsonlookup._constructor_.md) + +## PackageJsonLookup.(constructor) + +Constructs a new instance of the `PackageJsonLookup` class + +Signature: + +```typescript +constructor(parameters?: IPackageJsonLookupParameters); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| parameters | IPackageJsonLookupParameters | | + diff --git a/pages/api/node-core-library.packagejsonlookup.clearcache.md b/pages/api/node-core-library.packagejsonlookup.clearcache.md new file mode 100644 index 000000000..678c5c4aa --- /dev/null +++ b/pages/api/node-core-library.packagejsonlookup.clearcache.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageJsonLookup](./node-core-library.packagejsonlookup.md) > [clearCache](./node-core-library.packagejsonlookup.clearcache.md) + +## PackageJsonLookup.clearCache() method + +Clears the internal file cache. + +Signature: + +```typescript +clearCache(): void; +``` +Returns: + +`void` + +## Remarks + +Call this method if changes have been made to the package.json files on disk. + diff --git a/pages/api/node-core-library.packagejsonlookup.loadnodepackagejson.md b/pages/api/node-core-library.packagejsonlookup.loadnodepackagejson.md new file mode 100644 index 000000000..a50987cb8 --- /dev/null +++ b/pages/api/node-core-library.packagejsonlookup.loadnodepackagejson.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageJsonLookup](./node-core-library.packagejsonlookup.md) > [loadNodePackageJson](./node-core-library.packagejsonlookup.loadnodepackagejson.md) + +## PackageJsonLookup.loadNodePackageJson() method + +This function is similar to [PackageJsonLookup.loadPackageJson()](./node-core-library.packagejsonlookup.loadpackagejson.md), except that it does not report an error if the `version` field is missing from the package.json file. + +Signature: + +```typescript +loadNodePackageJson(jsonFilename: string): INodePackageJson; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonFilename | string | | + +Returns: + +`INodePackageJson` + diff --git a/pages/api/node-core-library.packagejsonlookup.loadownpackagejson.md b/pages/api/node-core-library.packagejsonlookup.loadownpackagejson.md new file mode 100644 index 000000000..3361d6846 --- /dev/null +++ b/pages/api/node-core-library.packagejsonlookup.loadownpackagejson.md @@ -0,0 +1,47 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageJsonLookup](./node-core-library.packagejsonlookup.md) > [loadOwnPackageJson](./node-core-library.packagejsonlookup.loadownpackagejson.md) + +## PackageJsonLookup.loadOwnPackageJson() method + +A helper for loading the caller's own package.json file. + +Signature: + +```typescript +static loadOwnPackageJson(dirnameOfCaller: string): IPackageJson; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| dirnameOfCaller | string | The NodeJS __dirname macro for the caller. | + +Returns: + +`IPackageJson` + +This function always returns a valid `IPackageJson` object. If any problems are encountered during loading, an exception will be thrown instead. + +## Remarks + +This function provides a concise and efficient way for an NPM package to report metadata about itself. For example, a tool might want to report its version. + +The `loadOwnPackageJson()` probes upwards from the caller's folder, expecting to find a package.json file, which is assumed to be the caller's package. The result is cached, under the assumption that a tool's own package.json (and intermediary folders) will never change during the lifetime of the process. + +## Example + + +```ts +// Report the version of our NPM package +const myPackageVersion: string = PackageJsonLookup.loadOwnPackageJson(__dirname).version; +console.log(`Cool Tool - Version ${myPackageVersion}`); + +``` + diff --git a/pages/api/node-core-library.packagejsonlookup.loadpackagejson.md b/pages/api/node-core-library.packagejsonlookup.loadpackagejson.md new file mode 100644 index 000000000..8c39bcbc4 --- /dev/null +++ b/pages/api/node-core-library.packagejsonlookup.loadpackagejson.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageJsonLookup](./node-core-library.packagejsonlookup.md) > [loadPackageJson](./node-core-library.packagejsonlookup.loadpackagejson.md) + +## PackageJsonLookup.loadPackageJson() method + +Loads the specified package.json file, if it is not already present in the cache. + +Signature: + +```typescript +loadPackageJson(jsonFilename: string): IPackageJson; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonFilename | string | a relative or absolute path to a package.json file | + +Returns: + +`IPackageJson` + +## Remarks + +Unless [IPackageJsonLookupParameters.loadExtraFields](./node-core-library.ipackagejsonlookupparameters.loadextrafields.md) was specified, the returned IPackageJson object will contain a subset of essential fields. The returned object should be considered to be immutable; the caller must never modify it. + diff --git a/pages/api/node-core-library.packagejsonlookup.md b/pages/api/node-core-library.packagejsonlookup.md new file mode 100644 index 000000000..a91cbe6cb --- /dev/null +++ b/pages/api/node-core-library.packagejsonlookup.md @@ -0,0 +1,38 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageJsonLookup](./node-core-library.packagejsonlookup.md) + +## PackageJsonLookup class + +This class provides methods for finding the nearest "package.json" for a folder and retrieving the name of the package. The results are cached. + +Signature: + +```typescript +export declare class PackageJsonLookup +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(parameters)](./node-core-library.packagejsonlookup._constructor_.md) | | Constructs a new instance of the PackageJsonLookup class | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [clearCache()](./node-core-library.packagejsonlookup.clearcache.md) | | Clears the internal file cache. | +| [loadNodePackageJson(jsonFilename)](./node-core-library.packagejsonlookup.loadnodepackagejson.md) | | This function is similar to [PackageJsonLookup.loadPackageJson()](./node-core-library.packagejsonlookup.loadpackagejson.md), except that it does not report an error if the version field is missing from the package.json file. | +| [loadOwnPackageJson(dirnameOfCaller)](./node-core-library.packagejsonlookup.loadownpackagejson.md) | static | A helper for loading the caller's own package.json file. | +| [loadPackageJson(jsonFilename)](./node-core-library.packagejsonlookup.loadpackagejson.md) | | Loads the specified package.json file, if it is not already present in the cache. | +| [tryGetPackageFolderFor(fileOrFolderPath)](./node-core-library.packagejsonlookup.trygetpackagefolderfor.md) | | Returns the absolute path of a folder containing a package.json file, by looking upwards from the specified fileOrFolderPath. If no package.json can be found, undefined is returned. | +| [tryGetPackageJsonFilePathFor(fileOrFolderPath)](./node-core-library.packagejsonlookup.trygetpackagejsonfilepathfor.md) | | If the specified file or folder is part of a package, this returns the absolute path to the associated package.json file. | +| [tryLoadNodePackageJsonFor(fileOrFolderPath)](./node-core-library.packagejsonlookup.tryloadnodepackagejsonfor.md) | | This function is similar to [PackageJsonLookup.tryLoadPackageJsonFor()](./node-core-library.packagejsonlookup.tryloadpackagejsonfor.md), except that it does not report an error if the version field is missing from the package.json file. | +| [tryLoadPackageJsonFor(fileOrFolderPath)](./node-core-library.packagejsonlookup.tryloadpackagejsonfor.md) | | If the specified file or folder is part of a package, this loads and returns the associated package.json file. | + diff --git a/pages/api/node-core-library.packagejsonlookup.trygetpackagefolderfor.md b/pages/api/node-core-library.packagejsonlookup.trygetpackagefolderfor.md new file mode 100644 index 000000000..c7bc04b19 --- /dev/null +++ b/pages/api/node-core-library.packagejsonlookup.trygetpackagefolderfor.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageJsonLookup](./node-core-library.packagejsonlookup.md) > [tryGetPackageFolderFor](./node-core-library.packagejsonlookup.trygetpackagefolderfor.md) + +## PackageJsonLookup.tryGetPackageFolderFor() method + +Returns the absolute path of a folder containing a package.json file, by looking upwards from the specified fileOrFolderPath. If no package.json can be found, undefined is returned. + +Signature: + +```typescript +tryGetPackageFolderFor(fileOrFolderPath: string): string | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fileOrFolderPath | string | a relative or absolute path to a source file or folder that may be part of a package | + +Returns: + +`string | undefined` + +an absolute path to a folder containing a package.json file + +## Remarks + +The fileOrFolderPath is not required to actually exist on disk. The fileOrFolderPath itself can be the return value, if it is a folder containing a package.json file. Both positive and negative lookup results are cached. + diff --git a/pages/api/node-core-library.packagejsonlookup.trygetpackagejsonfilepathfor.md b/pages/api/node-core-library.packagejsonlookup.trygetpackagejsonfilepathfor.md new file mode 100644 index 000000000..c257e1dea --- /dev/null +++ b/pages/api/node-core-library.packagejsonlookup.trygetpackagejsonfilepathfor.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageJsonLookup](./node-core-library.packagejsonlookup.md) > [tryGetPackageJsonFilePathFor](./node-core-library.packagejsonlookup.trygetpackagejsonfilepathfor.md) + +## PackageJsonLookup.tryGetPackageJsonFilePathFor() method + +If the specified file or folder is part of a package, this returns the absolute path to the associated package.json file. + +Signature: + +```typescript +tryGetPackageJsonFilePathFor(fileOrFolderPath: string): string | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fileOrFolderPath | string | a relative or absolute path to a source file or folder that may be part of a package | + +Returns: + +`string | undefined` + +an absolute path to \* package.json file + +## Remarks + +The package folder is determined using the same algorithm as [PackageJsonLookup.tryGetPackageFolderFor()](./node-core-library.packagejsonlookup.trygetpackagefolderfor.md). + diff --git a/pages/api/node-core-library.packagejsonlookup.tryloadnodepackagejsonfor.md b/pages/api/node-core-library.packagejsonlookup.tryloadnodepackagejsonfor.md new file mode 100644 index 000000000..bddb515ec --- /dev/null +++ b/pages/api/node-core-library.packagejsonlookup.tryloadnodepackagejsonfor.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageJsonLookup](./node-core-library.packagejsonlookup.md) > [tryLoadNodePackageJsonFor](./node-core-library.packagejsonlookup.tryloadnodepackagejsonfor.md) + +## PackageJsonLookup.tryLoadNodePackageJsonFor() method + +This function is similar to [PackageJsonLookup.tryLoadPackageJsonFor()](./node-core-library.packagejsonlookup.tryloadpackagejsonfor.md), except that it does not report an error if the `version` field is missing from the package.json file. + +Signature: + +```typescript +tryLoadNodePackageJsonFor(fileOrFolderPath: string): INodePackageJson | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fileOrFolderPath | string | | + +Returns: + +`INodePackageJson | undefined` + diff --git a/pages/api/node-core-library.packagejsonlookup.tryloadpackagejsonfor.md b/pages/api/node-core-library.packagejsonlookup.tryloadpackagejsonfor.md new file mode 100644 index 000000000..eaebca267 --- /dev/null +++ b/pages/api/node-core-library.packagejsonlookup.tryloadpackagejsonfor.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageJsonLookup](./node-core-library.packagejsonlookup.md) > [tryLoadPackageJsonFor](./node-core-library.packagejsonlookup.tryloadpackagejsonfor.md) + +## PackageJsonLookup.tryLoadPackageJsonFor() method + +If the specified file or folder is part of a package, this loads and returns the associated package.json file. + +Signature: + +```typescript +tryLoadPackageJsonFor(fileOrFolderPath: string): IPackageJson | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fileOrFolderPath | string | a relative or absolute path to a source file or folder that may be part of a package | + +Returns: + +`IPackageJson | undefined` + +an IPackageJson object, or undefined if the fileOrFolderPath does not belong to a package + +## Remarks + +The package folder is determined using the same algorithm as [PackageJsonLookup.tryGetPackageFolderFor()](./node-core-library.packagejsonlookup.trygetpackagefolderfor.md). + diff --git a/pages/api/node-core-library.packagename.combineparts.md b/pages/api/node-core-library.packagename.combineparts.md new file mode 100644 index 000000000..28f8cd98b --- /dev/null +++ b/pages/api/node-core-library.packagename.combineparts.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageName](./node-core-library.packagename.md) > [combineParts](./node-core-library.packagename.combineparts.md) + +## PackageName.combineParts() method + +Combines an optional package scope with an unscoped root name. + +Signature: + +```typescript +static combineParts(scope: string, unscopedName: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| scope | string | Must be either an empty string, or a scope name such as "@example" | +| unscopedName | string | Must be a nonempty package name that does not contain a scope | + +Returns: + +`string` + +A full package name such as "@example/some-library". + diff --git a/pages/api/node-core-library.packagename.getscope.md b/pages/api/node-core-library.packagename.getscope.md new file mode 100644 index 000000000..5fa32d027 --- /dev/null +++ b/pages/api/node-core-library.packagename.getscope.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageName](./node-core-library.packagename.md) > [getScope](./node-core-library.packagename.getscope.md) + +## PackageName.getScope() method + +The parsed NPM scope, or an empty string if there was no scope. The scope value will always include the at-sign. + +Signature: + +```typescript +static getScope(packageName: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| packageName | string | | + +Returns: + +`string` + +## Remarks + +For example, if the parsed input was "@scope/example", then scope would be "@scope". + diff --git a/pages/api/node-core-library.packagename.getunscopedname.md b/pages/api/node-core-library.packagename.getunscopedname.md new file mode 100644 index 000000000..c07d427d3 --- /dev/null +++ b/pages/api/node-core-library.packagename.getunscopedname.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageName](./node-core-library.packagename.md) > [getUnscopedName](./node-core-library.packagename.getunscopedname.md) + +## PackageName.getUnscopedName() method + +The parsed NPM package name without the scope. + +Signature: + +```typescript +static getUnscopedName(packageName: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| packageName | string | | + +Returns: + +`string` + +## Remarks + +For example, if the parsed input was "@scope/example", then the name would be "example". + diff --git a/pages/api/node-core-library.packagename.isvalidname.md b/pages/api/node-core-library.packagename.isvalidname.md new file mode 100644 index 000000000..22b58f7c7 --- /dev/null +++ b/pages/api/node-core-library.packagename.isvalidname.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageName](./node-core-library.packagename.md) > [isValidName](./node-core-library.packagename.isvalidname.md) + +## PackageName.isValidName() method + +Returns true if the specified package name is valid, or false otherwise. + +Signature: + +```typescript +static isValidName(packageName: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| packageName | string | | + +Returns: + +`boolean` + +## Remarks + +This function will not throw an exception. + diff --git a/pages/api/node-core-library.packagename.md b/pages/api/node-core-library.packagename.md new file mode 100644 index 000000000..9a2f7eec9 --- /dev/null +++ b/pages/api/node-core-library.packagename.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageName](./node-core-library.packagename.md) + +## PackageName class + +Various functions for working with package names that may include scopes. + +Signature: + +```typescript +export declare class PackageName +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [combineParts(scope, unscopedName)](./node-core-library.packagename.combineparts.md) | static | Combines an optional package scope with an unscoped root name. | +| [getScope(packageName)](./node-core-library.packagename.getscope.md) | static | The parsed NPM scope, or an empty string if there was no scope. The scope value will always include the at-sign. | +| [getUnscopedName(packageName)](./node-core-library.packagename.getunscopedname.md) | static | The parsed NPM package name without the scope. | +| [isValidName(packageName)](./node-core-library.packagename.isvalidname.md) | static | Returns true if the specified package name is valid, or false otherwise. | +| [parse(packageName)](./node-core-library.packagename.parse.md) | static | Same as [PackageName.tryParse()](./node-core-library.packagename.tryparse.md), except this throws an exception if the input cannot be parsed. | +| [tryParse(packageName)](./node-core-library.packagename.tryparse.md) | static | This attempts to parse a package name that may include a scope component. The packageName must not be an empty string. | +| [validate(packageName)](./node-core-library.packagename.validate.md) | static | Throws an exception if the specified name is not a valid package name. The packageName must not be an empty string. | + diff --git a/pages/api/node-core-library.packagename.parse.md b/pages/api/node-core-library.packagename.parse.md new file mode 100644 index 000000000..a5910c2be --- /dev/null +++ b/pages/api/node-core-library.packagename.parse.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageName](./node-core-library.packagename.md) > [parse](./node-core-library.packagename.parse.md) + +## PackageName.parse() method + +Same as [PackageName.tryParse()](./node-core-library.packagename.tryparse.md), except this throws an exception if the input cannot be parsed. + +Signature: + +```typescript +static parse(packageName: string): IParsedPackageName; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| packageName | string | | + +Returns: + +`IParsedPackageName` + +## Remarks + +The packageName must not be an empty string. + diff --git a/pages/api/node-core-library.packagename.tryparse.md b/pages/api/node-core-library.packagename.tryparse.md new file mode 100644 index 000000000..e2f42595f --- /dev/null +++ b/pages/api/node-core-library.packagename.tryparse.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageName](./node-core-library.packagename.md) > [tryParse](./node-core-library.packagename.tryparse.md) + +## PackageName.tryParse() method + +This attempts to parse a package name that may include a scope component. The packageName must not be an empty string. + +Signature: + +```typescript +static tryParse(packageName: string): IParsedPackageNameOrError; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| packageName | string | | + +Returns: + +`IParsedPackageNameOrError` + +an [IParsedPackageNameOrError](./node-core-library.iparsedpackagenameorerror.md) structure whose `error` property will be nonempty if the string could not be parsed. + +## Remarks + +This function will not throw an exception. + diff --git a/pages/api/node-core-library.packagename.validate.md b/pages/api/node-core-library.packagename.validate.md new file mode 100644 index 000000000..e830a3852 --- /dev/null +++ b/pages/api/node-core-library.packagename.validate.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PackageName](./node-core-library.packagename.md) > [validate](./node-core-library.packagename.validate.md) + +## PackageName.validate() method + +Throws an exception if the specified name is not a valid package name. The packageName must not be an empty string. + +Signature: + +```typescript +static validate(packageName: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| packageName | string | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.path.isunder.md b/pages/api/node-core-library.path.isunder.md new file mode 100644 index 000000000..0ef829974 --- /dev/null +++ b/pages/api/node-core-library.path.isunder.md @@ -0,0 +1,34 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Path](./node-core-library.path.md) > [isUnder](./node-core-library.path.isunder.md) + +## Path.isUnder() method + +Returns true if "childPath" is located inside the "parentFolderPath" folder or one of its child folders. Note that "parentFolderPath" is not considered to be under itself. The "childPath" can refer to any type of file system object. + +Signature: + +```typescript +static isUnder(childPath: string, parentFolderPath: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| childPath | string | | +| parentFolderPath | string | | + +Returns: + +`boolean` + +## Remarks + +The indicated file/folder objects are not required to actually exist on disk. For example, "parentFolderPath" is interpreted as a folder name even if it refers to a file. If the paths are relative, they will first be resolved using path.resolve(). + diff --git a/pages/api/node-core-library.path.isunderorequal.md b/pages/api/node-core-library.path.isunderorequal.md new file mode 100644 index 000000000..07c12cc97 --- /dev/null +++ b/pages/api/node-core-library.path.isunderorequal.md @@ -0,0 +1,34 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Path](./node-core-library.path.md) > [isUnderOrEqual](./node-core-library.path.isunderorequal.md) + +## Path.isUnderOrEqual() method + +Returns true if "childPath" is equal to "parentFolderPath", or if it is inside that folder or one of its children. The "childPath" can refer to any type of file system object. + +Signature: + +```typescript +static isUnderOrEqual(childPath: string, parentFolderPath: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| childPath | string | | +| parentFolderPath | string | | + +Returns: + +`boolean` + +## Remarks + +The indicated file/folder objects are not required to actually exist on disk. For example, "parentFolderPath" is interpreted as a folder name even if it refers to a file. If the paths are relative, they will first be resolved using path.resolve(). + diff --git a/pages/api/node-core-library.path.md b/pages/api/node-core-library.path.md new file mode 100644 index 000000000..26cc2e86a --- /dev/null +++ b/pages/api/node-core-library.path.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Path](./node-core-library.path.md) + +## Path class + +Common operations for manipulating file and directory paths. + +Signature: + +```typescript +export declare class Path +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [isUnder(childPath, parentFolderPath)](./node-core-library.path.isunder.md) | static | Returns true if "childPath" is located inside the "parentFolderPath" folder or one of its child folders. Note that "parentFolderPath" is not considered to be under itself. The "childPath" can refer to any type of file system object. | +| [isUnderOrEqual(childPath, parentFolderPath)](./node-core-library.path.isunderorequal.md) | static | Returns true if "childPath" is equal to "parentFolderPath", or if it is inside that folder or one of its children. The "childPath" can refer to any type of file system object. | + +## Remarks + +This API is intended to eventually be a complete replacement for the NodeJS "path" API. + diff --git a/pages/api/node-core-library.posixmodebits.md b/pages/api/node-core-library.posixmodebits.md new file mode 100644 index 000000000..faf553eee --- /dev/null +++ b/pages/api/node-core-library.posixmodebits.md @@ -0,0 +1,45 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [PosixModeBits](./node-core-library.posixmodebits.md) + +## PosixModeBits enum + +An integer value used to specify file permissions for POSIX-like operating systems. + +Signature: + +```typescript +export declare const enum PosixModeBits +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| AllExecute | 73 | An alias combining OthersExecute, GroupExecute, and UserExecute permission bits. | +| AllRead | 292 | An alias combining OthersRead, GroupRead, and UserRead permission bits. | +| AllWrite | 146 | An alias combining OthersWrite, GroupWrite, and UserWrite permission bits. | +| GroupExecute | 8 | Indicates that users belonging to the item's group can execute the item (if it is a file) or search the item (if it is a directory). | +| GroupRead | 32 | Indicates that users belonging to the item's group can read the item. | +| GroupWrite | 16 | Indicates that users belonging to the item's group can modify the item. | +| None | 0 | A zero value where no permissions bits are set. | +| OthersExecute | 1 | Indicates that other users (besides the item's owner user or group) can execute the item (if it is a file) or search the item (if it is a directory). | +| OthersRead | 4 | Indicates that other users (besides the item's owner user or group) can read the item. | +| OthersWrite | 2 | Indicates that other users (besides the item's owner user or group) can modify the item. | +| UserExecute | 64 | Indicates that the item's owner can execute the item (if it is a file) or search the item (if it is a directory). | +| UserRead | 256 | Indicates that the item's owner can read the item. | +| UserWrite | 128 | Indicates that the item's owner can modify the item. | + +## Remarks + +This bitfield corresponds to the "mode\_t" structure described in this document: http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys\_stat.h.html + +It is used with NodeJS APIs such as fs.Stat.mode and fs.chmodSync(). These values represent a set of permissions and can be combined using bitwise arithmetic. + +POSIX is a registered trademark of the Institute of Electrical and Electronic Engineers, Inc. + diff --git a/pages/api/node-core-library.protectablemap._constructor_.md b/pages/api/node-core-library.protectablemap._constructor_.md new file mode 100644 index 000000000..2fc152d61 --- /dev/null +++ b/pages/api/node-core-library.protectablemap._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ProtectableMap](./node-core-library.protectablemap.md) > [(constructor)](./node-core-library.protectablemap._constructor_.md) + +## ProtectableMap.(constructor) + +Constructs a new instance of the `ProtectableMap` class + +Signature: + +```typescript +constructor(parameters: IProtectableMapParameters); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| parameters | IProtectableMapParameters<K, V> | | + diff --git a/pages/api/node-core-library.protectablemap.clear.md b/pages/api/node-core-library.protectablemap.clear.md new file mode 100644 index 000000000..ca0badf10 --- /dev/null +++ b/pages/api/node-core-library.protectablemap.clear.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ProtectableMap](./node-core-library.protectablemap.md) > [clear](./node-core-library.protectablemap.clear.md) + +## ProtectableMap.clear() method + +Removes all entries from the map. This operation does NOT invoke the ProtectableMap onClear() hook. + +Signature: + +```typescript +clear(): void; +``` +Returns: + +`void` + diff --git a/pages/api/node-core-library.protectablemap.delete.md b/pages/api/node-core-library.protectablemap.delete.md new file mode 100644 index 000000000..0b6ea99f0 --- /dev/null +++ b/pages/api/node-core-library.protectablemap.delete.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ProtectableMap](./node-core-library.protectablemap.md) > [delete](./node-core-library.protectablemap.delete.md) + +## ProtectableMap.delete() method + +Removes the specified key from the map. This operation does NOT invoke the ProtectableMap onDelete() hook. + +Signature: + +```typescript +delete(key: K): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| key | K | | + +Returns: + +`boolean` + diff --git a/pages/api/node-core-library.protectablemap.foreach.md b/pages/api/node-core-library.protectablemap.foreach.md new file mode 100644 index 000000000..af81ab717 --- /dev/null +++ b/pages/api/node-core-library.protectablemap.foreach.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ProtectableMap](./node-core-library.protectablemap.md) > [forEach](./node-core-library.protectablemap.foreach.md) + +## ProtectableMap.forEach() method + +Performs an operation for each (key, value) entries in the map. + +Signature: + +```typescript +forEach(callbackfn: (value: V, key: K, map: Map) => void, thisArg?: any): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| callbackfn | (value: V, key: K, map: Map<K, V>) => void | | +| thisArg | any | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.protectablemap.get.md b/pages/api/node-core-library.protectablemap.get.md new file mode 100644 index 000000000..4c9fe92b8 --- /dev/null +++ b/pages/api/node-core-library.protectablemap.get.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ProtectableMap](./node-core-library.protectablemap.md) > [get](./node-core-library.protectablemap.get.md) + +## ProtectableMap.get() method + +Retrieves the value for the specified key. + +Signature: + +```typescript +get(key: K): V | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| key | K | | + +Returns: + +`V | undefined` + +undefined if the value is undefined OR if the key is missing; otherwise returns the value associated with the key. + diff --git a/pages/api/node-core-library.protectablemap.has.md b/pages/api/node-core-library.protectablemap.has.md new file mode 100644 index 000000000..0e6836106 --- /dev/null +++ b/pages/api/node-core-library.protectablemap.has.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ProtectableMap](./node-core-library.protectablemap.md) > [has](./node-core-library.protectablemap.has.md) + +## ProtectableMap.has() method + +Returns true if the specified key belongs to the map. + +Signature: + +```typescript +has(key: K): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| key | K | | + +Returns: + +`boolean` + diff --git a/pages/api/node-core-library.protectablemap.md b/pages/api/node-core-library.protectablemap.md new file mode 100644 index 000000000..5512a149c --- /dev/null +++ b/pages/api/node-core-library.protectablemap.md @@ -0,0 +1,49 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ProtectableMap](./node-core-library.protectablemap.md) + +## ProtectableMap class + +The ProtectableMap provides an easy way for an API to expose a `Map` property while intercepting and validating any write operations that are performed by consumers of the API. + +Signature: + +```typescript +export declare class ProtectableMap +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(parameters)](./node-core-library.protectablemap._constructor_.md) | | Constructs a new instance of the ProtectableMap class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [protectedView](./node-core-library.protectablemap.protectedview.md) | | Map<K, V> | The owner of the protectable map should return this object via its public API. | +| [size](./node-core-library.protectablemap.size.md) | | number | Returns the number of (key, value) entries in the map. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [clear()](./node-core-library.protectablemap.clear.md) | | Removes all entries from the map. This operation does NOT invoke the ProtectableMap onClear() hook. | +| [delete(key)](./node-core-library.protectablemap.delete.md) | | Removes the specified key from the map. This operation does NOT invoke the ProtectableMap onDelete() hook. | +| [forEach(callbackfn, thisArg)](./node-core-library.protectablemap.foreach.md) | | Performs an operation for each (key, value) entries in the map. | +| [get(key)](./node-core-library.protectablemap.get.md) | | Retrieves the value for the specified key. | +| [has(key)](./node-core-library.protectablemap.has.md) | | Returns true if the specified key belongs to the map. | +| [set(key, value)](./node-core-library.protectablemap.set.md) | | Sets a value for the specified key. This operation does NOT invoke the ProtectableMap onSet() hook. | + +## Remarks + +The ProtectableMap itself is intended to be a private object that only its owner can access directly. Any operations performed directly on the ProtectableMap will bypass the hooks and any validation they perform. The public property that is exposed to API consumers should return [ProtectableMap.protectedView](./node-core-library.protectablemap.protectedview.md) instead. + +For example, suppose you want to share your `Map` data structure, but you want to enforce that the key must always be an upper case string: You could use the onSet() hook to validate the keys and throw an exception if the key is not uppercase. + diff --git a/pages/api/node-core-library.protectablemap.protectedview.md b/pages/api/node-core-library.protectablemap.protectedview.md new file mode 100644 index 000000000..24bebd52a --- /dev/null +++ b/pages/api/node-core-library.protectablemap.protectedview.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ProtectableMap](./node-core-library.protectablemap.md) > [protectedView](./node-core-library.protectablemap.protectedview.md) + +## ProtectableMap.protectedView property + +The owner of the protectable map should return this object via its public API. + +Signature: + +```typescript +readonly protectedView: Map; +``` diff --git a/pages/api/node-core-library.protectablemap.set.md b/pages/api/node-core-library.protectablemap.set.md new file mode 100644 index 000000000..e59d9d602 --- /dev/null +++ b/pages/api/node-core-library.protectablemap.set.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ProtectableMap](./node-core-library.protectablemap.md) > [set](./node-core-library.protectablemap.set.md) + +## ProtectableMap.set() method + +Sets a value for the specified key. This operation does NOT invoke the ProtectableMap onSet() hook. + +Signature: + +```typescript +set(key: K, value: V): this; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| key | K | | +| value | V | | + +Returns: + +`this` + diff --git a/pages/api/node-core-library.protectablemap.size.md b/pages/api/node-core-library.protectablemap.size.md new file mode 100644 index 000000000..d786ae71a --- /dev/null +++ b/pages/api/node-core-library.protectablemap.size.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [ProtectableMap](./node-core-library.protectablemap.md) > [size](./node-core-library.protectablemap.size.md) + +## ProtectableMap.size property + +Returns the number of (key, value) entries in the map. + +Signature: + +```typescript +readonly size: number; +``` diff --git a/pages/api/node-core-library.sort.comparebyvalue.md b/pages/api/node-core-library.sort.comparebyvalue.md new file mode 100644 index 000000000..e659f3dde --- /dev/null +++ b/pages/api/node-core-library.sort.comparebyvalue.md @@ -0,0 +1,45 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Sort](./node-core-library.sort.md) > [compareByValue](./node-core-library.sort.comparebyvalue.md) + +## Sort.compareByValue() method + +Compares `x` and `y` using the JavaScript `>` and `<` operators. This function is suitable for usage as the callback for `array.sort()`. + +Signature: + +```typescript +static compareByValue(x: any, y: any): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| x | any | | +| y | any | | + +Returns: + +`number` + +-1 if `x` is smaller than `y`, 1 if `x` is greater than `y`, or 0 if the values are equal. + +## Remarks + +The JavaScript ordering is generalized so that `undefined` < `null` < all other values. + +## Example + + +```ts +let array: number[] = [3, 6, 2]; +array.sort(Sort.compareByValue); // [2, 3, 6] + +``` + diff --git a/pages/api/node-core-library.sort.issorted.md b/pages/api/node-core-library.sort.issorted.md new file mode 100644 index 000000000..058254aaf --- /dev/null +++ b/pages/api/node-core-library.sort.issorted.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Sort](./node-core-library.sort.md) > [isSorted](./node-core-library.sort.issorted.md) + +## Sort.isSorted() method + +Returns true if the array is already sorted. + +Signature: + +```typescript +static isSorted(array: T[], comparer?: (x: any, y: any) => number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| array | T[] | | +| comparer | (x: any, y: any) => number | | + +Returns: + +`boolean` + diff --git a/pages/api/node-core-library.sort.issortedby.md b/pages/api/node-core-library.sort.issortedby.md new file mode 100644 index 000000000..b41f90bd2 --- /dev/null +++ b/pages/api/node-core-library.sort.issortedby.md @@ -0,0 +1,40 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Sort](./node-core-library.sort.md) > [isSortedBy](./node-core-library.sort.issortedby.md) + +## Sort.isSortedBy() method + +Returns true if the array is already sorted by the specified key. + +Signature: + +```typescript +static isSortedBy(array: T[], keySelector: (element: T) => any, comparer?: (x: any, y: any) => number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| array | T[] | | +| keySelector | (element: T) => any | | +| comparer | (x: any, y: any) => number | | + +Returns: + +`boolean` + +## Example + + +```ts +let array: string[] = [ 'a', 'bb', 'ccc' ]; +Sort.isSortedBy(array, x => x.length); // true + +``` + diff --git a/pages/api/node-core-library.sort.md b/pages/api/node-core-library.sort.md new file mode 100644 index 000000000..2eb3d6254 --- /dev/null +++ b/pages/api/node-core-library.sort.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Sort](./node-core-library.sort.md) + +## Sort class + +Operations for sorting collections. + +Signature: + +```typescript +export declare class Sort +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [compareByValue(x, y)](./node-core-library.sort.comparebyvalue.md) | static | Compares x and y using the JavaScript > and < operators. This function is suitable for usage as the callback for array.sort(). | +| [isSorted(array, comparer)](./node-core-library.sort.issorted.md) | static | Returns true if the array is already sorted. | +| [isSortedBy(array, keySelector, comparer)](./node-core-library.sort.issortedby.md) | static | Returns true if the array is already sorted by the specified key. | +| [sortBy(array, keySelector, comparer)](./node-core-library.sort.sortby.md) | static | Sorts the array according to a key which is obtained from the array elements. | +| [sortMapKeys(map, keyComparer)](./node-core-library.sort.sortmapkeys.md) | static | Sorts the entries in a Map object according to the keys. | +| [sortSet(set, comparer)](./node-core-library.sort.sortset.md) | static | Sorts the entries in a Set object according to the keys. | +| [sortSetBy(set, keySelector, keyComparer)](./node-core-library.sort.sortsetby.md) | static | Sorts the entries in a Set object according to the keys. | + diff --git a/pages/api/node-core-library.sort.sortby.md b/pages/api/node-core-library.sort.sortby.md new file mode 100644 index 000000000..3fd0f015e --- /dev/null +++ b/pages/api/node-core-library.sort.sortby.md @@ -0,0 +1,40 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Sort](./node-core-library.sort.md) > [sortBy](./node-core-library.sort.sortby.md) + +## Sort.sortBy() method + +Sorts the array according to a key which is obtained from the array elements. + +Signature: + +```typescript +static sortBy(array: T[], keySelector: (element: T) => any, comparer?: (x: any, y: any) => number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| array | T[] | | +| keySelector | (element: T) => any | | +| comparer | (x: any, y: any) => number | | + +Returns: + +`void` + +## Example + + +```ts +let array: string[] = [ 'aaa', 'bb', 'c' ]; +Sort.sortBy(array, x => x.length); // [ 'c', 'bb', 'aaa' ] + +``` + diff --git a/pages/api/node-core-library.sort.sortmapkeys.md b/pages/api/node-core-library.sort.sortmapkeys.md new file mode 100644 index 000000000..ee9689305 --- /dev/null +++ b/pages/api/node-core-library.sort.sortmapkeys.md @@ -0,0 +1,43 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Sort](./node-core-library.sort.md) > [sortMapKeys](./node-core-library.sort.sortmapkeys.md) + +## Sort.sortMapKeys() method + +Sorts the entries in a Map object according to the keys. + +Signature: + +```typescript +static sortMapKeys(map: Map, keyComparer?: (x: K, y: K) => number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| map | Map<K, V> | | +| keyComparer | (x: K, y: K) => number | | + +Returns: + +`void` + +## Example + + +```ts +let map: Map = new Map(); +map.set('zebra', 1); +map.set('goose', 2); +map.set('aardvark', 3); +Sort.sortMapKeys(map); +console.log(JSON.stringify(Array.from(map.keys()))); // ["aardvark","goose","zebra"] + +``` + diff --git a/pages/api/node-core-library.sort.sortset.md b/pages/api/node-core-library.sort.sortset.md new file mode 100644 index 000000000..17f26a604 --- /dev/null +++ b/pages/api/node-core-library.sort.sortset.md @@ -0,0 +1,43 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Sort](./node-core-library.sort.md) > [sortSet](./node-core-library.sort.sortset.md) + +## Sort.sortSet() method + +Sorts the entries in a Set object according to the keys. + +Signature: + +```typescript +static sortSet(set: Set, comparer?: (x: T, y: T) => number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| set | Set<T> | | +| comparer | (x: T, y: T) => number | | + +Returns: + +`void` + +## Example + + +```ts +let set: Set = new Set(); +set.add('zebra'); +set.add('goose'); +set.add('aardvark'); +Sort.sortSet(set); +console.log(Array.from(set)); // ['aardvark', 'goose', 'zebra'] + +``` + diff --git a/pages/api/node-core-library.sort.sortsetby.md b/pages/api/node-core-library.sort.sortsetby.md new file mode 100644 index 000000000..c1ce09fae --- /dev/null +++ b/pages/api/node-core-library.sort.sortsetby.md @@ -0,0 +1,44 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Sort](./node-core-library.sort.md) > [sortSetBy](./node-core-library.sort.sortsetby.md) + +## Sort.sortSetBy() method + +Sorts the entries in a Set object according to the keys. + +Signature: + +```typescript +static sortSetBy(set: Set, keySelector: (element: T) => any, keyComparer?: (x: T, y: T) => number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| set | Set<T> | | +| keySelector | (element: T) => any | | +| keyComparer | (x: T, y: T) => number | | + +Returns: + +`void` + +## Example + + +```ts +let set: Set = new Set(); +set.add('aaa'); +set.add('bb'); +set.add('c'); +Sort.sortSetBy(set, x => x.length); +console.log(Array.from(set)); // ['c', 'bb', 'aaa'] + +``` + diff --git a/pages/api/node-core-library.stringbufferterminalprovider._constructor_.md b/pages/api/node-core-library.stringbufferterminalprovider._constructor_.md new file mode 100644 index 000000000..2415b242b --- /dev/null +++ b/pages/api/node-core-library.stringbufferterminalprovider._constructor_.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [StringBufferTerminalProvider](./node-core-library.stringbufferterminalprovider.md) > [(constructor)](./node-core-library.stringbufferterminalprovider._constructor_.md) + +## StringBufferTerminalProvider.(constructor) + +> 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. +> + +Constructs a new instance of the `StringBufferTerminalProvider` class + +Signature: + +```typescript +constructor(supportsColor?: boolean); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| supportsColor | boolean | | + diff --git a/pages/api/node-core-library.stringbufferterminalprovider.eolcharacter.md b/pages/api/node-core-library.stringbufferterminalprovider.eolcharacter.md new file mode 100644 index 000000000..5dcc1dfed --- /dev/null +++ b/pages/api/node-core-library.stringbufferterminalprovider.eolcharacter.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [StringBufferTerminalProvider](./node-core-library.stringbufferterminalprovider.md) > [eolCharacter](./node-core-library.stringbufferterminalprovider.eolcharacter.md) + +## StringBufferTerminalProvider.eolCharacter property + +> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> + +This property should return the newline character the terminal provider expects. + +Signature: + +```typescript +readonly eolCharacter: string; +``` diff --git a/pages/api/node-core-library.stringbufferterminalprovider.geterroroutput.md b/pages/api/node-core-library.stringbufferterminalprovider.geterroroutput.md new file mode 100644 index 000000000..63308224d --- /dev/null +++ b/pages/api/node-core-library.stringbufferterminalprovider.geterroroutput.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [StringBufferTerminalProvider](./node-core-library.stringbufferterminalprovider.md) > [getErrorOutput](./node-core-library.stringbufferterminalprovider.geterroroutput.md) + +## StringBufferTerminalProvider.getErrorOutput() method + +> 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. +> + +Get everything that has been written at error-level severity. + +Signature: + +```typescript +getErrorOutput(): string; +``` +Returns: + +`string` + diff --git a/pages/api/node-core-library.stringbufferterminalprovider.getoutput.md b/pages/api/node-core-library.stringbufferterminalprovider.getoutput.md new file mode 100644 index 000000000..303f16abd --- /dev/null +++ b/pages/api/node-core-library.stringbufferterminalprovider.getoutput.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [StringBufferTerminalProvider](./node-core-library.stringbufferterminalprovider.md) > [getOutput](./node-core-library.stringbufferterminalprovider.getoutput.md) + +## StringBufferTerminalProvider.getOutput() method + +> 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. +> + +Get everything that has been written at log-level severity. + +Signature: + +```typescript +getOutput(): string; +``` +Returns: + +`string` + diff --git a/pages/api/node-core-library.stringbufferterminalprovider.getverbose.md b/pages/api/node-core-library.stringbufferterminalprovider.getverbose.md new file mode 100644 index 000000000..fa62617b4 --- /dev/null +++ b/pages/api/node-core-library.stringbufferterminalprovider.getverbose.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [StringBufferTerminalProvider](./node-core-library.stringbufferterminalprovider.md) > [getVerbose](./node-core-library.stringbufferterminalprovider.getverbose.md) + +## StringBufferTerminalProvider.getVerbose() method + +> 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. +> + +Get everything that has been written at verbose-level severity. + +Signature: + +```typescript +getVerbose(): string; +``` +Returns: + +`string` + diff --git a/pages/api/node-core-library.stringbufferterminalprovider.getwarningoutput.md b/pages/api/node-core-library.stringbufferterminalprovider.getwarningoutput.md new file mode 100644 index 000000000..fd2ba5bd7 --- /dev/null +++ b/pages/api/node-core-library.stringbufferterminalprovider.getwarningoutput.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [StringBufferTerminalProvider](./node-core-library.stringbufferterminalprovider.md) > [getWarningOutput](./node-core-library.stringbufferterminalprovider.getwarningoutput.md) + +## StringBufferTerminalProvider.getWarningOutput() method + +> 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. +> + +Get everything that has been written at warning-level severity. + +Signature: + +```typescript +getWarningOutput(): string; +``` +Returns: + +`string` + diff --git a/pages/api/node-core-library.stringbufferterminalprovider.md b/pages/api/node-core-library.stringbufferterminalprovider.md new file mode 100644 index 000000000..558d26a58 --- /dev/null +++ b/pages/api/node-core-library.stringbufferterminalprovider.md @@ -0,0 +1,45 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [StringBufferTerminalProvider](./node-core-library.stringbufferterminalprovider.md) + +## StringBufferTerminalProvider class + +> 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. +> + +Terminal provider that stores written data in buffers separated by severity. This terminal provider is designed to be used when code that prints to a terminal is being unit tested. + +Signature: + +```typescript +export declare class StringBufferTerminalProvider implements ITerminalProvider +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(supportsColor)](./node-core-library.stringbufferterminalprovider._constructor_.md) | | (BETA) Constructs a new instance of the StringBufferTerminalProvider class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [eolCharacter](./node-core-library.stringbufferterminalprovider.eolcharacter.md) | | string | (BETA) This property should return the newline character the terminal provider expects. | +| [supportsColor](./node-core-library.stringbufferterminalprovider.supportscolor.md) | | boolean | (BETA) This property should return true only if the terminal provider supports rendering console colors. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [getErrorOutput()](./node-core-library.stringbufferterminalprovider.geterroroutput.md) | | (BETA) Get everything that has been written at error-level severity. | +| [getOutput()](./node-core-library.stringbufferterminalprovider.getoutput.md) | | (BETA) Get everything that has been written at log-level severity. | +| [getVerbose()](./node-core-library.stringbufferterminalprovider.getverbose.md) | | (BETA) Get everything that has been written at verbose-level severity. | +| [getWarningOutput()](./node-core-library.stringbufferterminalprovider.getwarningoutput.md) | | (BETA) Get everything that has been written at warning-level severity. | +| [write(data, severity)](./node-core-library.stringbufferterminalprovider.write.md) | | (BETA) This function gets called on every terminal provider upon every message function call on the terminal instance. | + diff --git a/pages/api/node-core-library.stringbufferterminalprovider.supportscolor.md b/pages/api/node-core-library.stringbufferterminalprovider.supportscolor.md new file mode 100644 index 000000000..f0789a005 --- /dev/null +++ b/pages/api/node-core-library.stringbufferterminalprovider.supportscolor.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [StringBufferTerminalProvider](./node-core-library.stringbufferterminalprovider.md) > [supportsColor](./node-core-library.stringbufferterminalprovider.supportscolor.md) + +## StringBufferTerminalProvider.supportsColor property + +> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> + +This property should return true only if the terminal provider supports rendering console colors. + +Signature: + +```typescript +readonly supportsColor: boolean; +``` diff --git a/pages/api/node-core-library.stringbufferterminalprovider.write.md b/pages/api/node-core-library.stringbufferterminalprovider.write.md new file mode 100644 index 000000000..dce5b0fd3 --- /dev/null +++ b/pages/api/node-core-library.stringbufferterminalprovider.write.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [StringBufferTerminalProvider](./node-core-library.stringbufferterminalprovider.md) > [write](./node-core-library.stringbufferterminalprovider.write.md) + +## StringBufferTerminalProvider.write() method + +> 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 gets called on every terminal provider upon every message function call on the terminal instance. + +Signature: + +```typescript +write(data: string, severity: TerminalProviderSeverity): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| data | string | The terminal message. | +| severity | TerminalProviderSeverity | The message severity. Terminal providers can route different kinds of messages to different streams and may choose to ignore verbose messages. | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.stringbuilder._constructor_.md b/pages/api/node-core-library.stringbuilder._constructor_.md new file mode 100644 index 000000000..83e83e596 --- /dev/null +++ b/pages/api/node-core-library.stringbuilder._constructor_.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [StringBuilder](./node-core-library.stringbuilder.md) > [(constructor)](./node-core-library.stringbuilder._constructor_.md) + +## StringBuilder.(constructor) + +Constructs a new instance of the `StringBuilder` class + +Signature: + +```typescript +constructor(); +``` diff --git a/pages/api/node-core-library.stringbuilder.append.md b/pages/api/node-core-library.stringbuilder.append.md new file mode 100644 index 000000000..d5701c75c --- /dev/null +++ b/pages/api/node-core-library.stringbuilder.append.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [StringBuilder](./node-core-library.stringbuilder.md) > [append](./node-core-library.stringbuilder.append.md) + +## StringBuilder.append() method + +Append the specified text to the buffer. + +Signature: + +```typescript +append(text: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| text | string | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.stringbuilder.md b/pages/api/node-core-library.stringbuilder.md new file mode 100644 index 000000000..0e59cca29 --- /dev/null +++ b/pages/api/node-core-library.stringbuilder.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [StringBuilder](./node-core-library.stringbuilder.md) + +## StringBuilder class + +This class allows a large text string to be constructed incrementally by appending small chunks. The final string can be obtained by calling StringBuilder.toString(). + +Signature: + +```typescript +export declare class StringBuilder implements IStringBuilder +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)()](./node-core-library.stringbuilder._constructor_.md) | | Constructs a new instance of the StringBuilder class | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [append(text)](./node-core-library.stringbuilder.append.md) | | Append the specified text to the buffer. | +| [toString()](./node-core-library.stringbuilder.tostring.md) | | Returns a single string containing all the text that was appended to the buffer so far. | + +## Remarks + +A naive approach might use the `+=` operator to append strings: This would have the downside of copying the entire string each time a chunk is appended, resulting in `O(n^2)` bytes of memory being allocated (and later freed by the garbage collector), and many of the allocations could be very large objects. StringBuilder avoids this overhead by accumulating the chunks in an array, and efficiently joining them when `getText()` is finally called. + diff --git a/pages/api/node-core-library.stringbuilder.tostring.md b/pages/api/node-core-library.stringbuilder.tostring.md new file mode 100644 index 000000000..83f05819d --- /dev/null +++ b/pages/api/node-core-library.stringbuilder.tostring.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [StringBuilder](./node-core-library.stringbuilder.md) > [toString](./node-core-library.stringbuilder.tostring.md) + +## StringBuilder.toString() method + +Returns a single string containing all the text that was appended to the buffer so far. + +Signature: + +```typescript +toString(): string; +``` +Returns: + +`string` + +## Remarks + +This is a potentially expensive operation. + diff --git a/pages/api/node-core-library.terminal._constructor_.md b/pages/api/node-core-library.terminal._constructor_.md new file mode 100644 index 000000000..ebfcc182e --- /dev/null +++ b/pages/api/node-core-library.terminal._constructor_.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Terminal](./node-core-library.terminal.md) > [(constructor)](./node-core-library.terminal._constructor_.md) + +## Terminal.(constructor) + +> 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. +> + +Constructs a new instance of the `Terminal` class + +Signature: + +```typescript +constructor(provider: ITerminalProvider); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| provider | ITerminalProvider | | + diff --git a/pages/api/node-core-library.terminal.md b/pages/api/node-core-library.terminal.md new file mode 100644 index 000000000..5f11cb833 --- /dev/null +++ b/pages/api/node-core-library.terminal.md @@ -0,0 +1,43 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Terminal](./node-core-library.terminal.md) + +## Terminal class + +> 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 class facilitates writing to a console. + +Signature: + +```typescript +export declare class Terminal +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(provider)](./node-core-library.terminal._constructor_.md) | | (BETA) Constructs a new instance of the Terminal class | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [registerProvider(provider)](./node-core-library.terminal.registerprovider.md) | | (BETA) Subscribe a new terminal provider. | +| [unregisterProvider(provider)](./node-core-library.terminal.unregisterprovider.md) | | (BETA) Unsubscribe a terminal provider. If the provider isn't subscribed, this function does nothing. | +| [write(messageParts)](./node-core-library.terminal.write.md) | | (BETA) Write a generic message to the terminal | +| [writeError(messageParts)](./node-core-library.terminal.writeerror.md) | | (BETA) Write an error message to the console with red text. | +| [writeErrorLine(messageParts)](./node-core-library.terminal.writeerrorline.md) | | (BETA) Write an error message to the console with red text, followed by a newline. | +| [writeLine(messageParts)](./node-core-library.terminal.writeline.md) | | (BETA) Write a generic message to the terminal, followed by a newline | +| [writeVerbose(messageParts)](./node-core-library.terminal.writeverbose.md) | | (BETA) Write a verbose-level message. | +| [writeVerboseLine(messageParts)](./node-core-library.terminal.writeverboseline.md) | | (BETA) Write a verbose-level message followed by a newline. | +| [writeWarning(messageParts)](./node-core-library.terminal.writewarning.md) | | (BETA) Write a warning message to the console with yellow text. | +| [writeWarningLine(messageParts)](./node-core-library.terminal.writewarningline.md) | | (BETA) Write a warning message to the console with yellow text, followed by a newline. | + diff --git a/pages/api/node-core-library.terminal.registerprovider.md b/pages/api/node-core-library.terminal.registerprovider.md new file mode 100644 index 000000000..09b50539a --- /dev/null +++ b/pages/api/node-core-library.terminal.registerprovider.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Terminal](./node-core-library.terminal.md) > [registerProvider](./node-core-library.terminal.registerprovider.md) + +## Terminal.registerProvider() method + +> 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. +> + +Subscribe a new terminal provider. + +Signature: + +```typescript +registerProvider(provider: ITerminalProvider): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| provider | ITerminalProvider | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.terminal.unregisterprovider.md b/pages/api/node-core-library.terminal.unregisterprovider.md new file mode 100644 index 000000000..4d851ea81 --- /dev/null +++ b/pages/api/node-core-library.terminal.unregisterprovider.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Terminal](./node-core-library.terminal.md) > [unregisterProvider](./node-core-library.terminal.unregisterprovider.md) + +## Terminal.unregisterProvider() method + +> 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. +> + +Unsubscribe a terminal provider. If the provider isn't subscribed, this function does nothing. + +Signature: + +```typescript +unregisterProvider(provider: ITerminalProvider): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| provider | ITerminalProvider | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.terminal.write.md b/pages/api/node-core-library.terminal.write.md new file mode 100644 index 000000000..e52289ffa --- /dev/null +++ b/pages/api/node-core-library.terminal.write.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Terminal](./node-core-library.terminal.md) > [write](./node-core-library.terminal.write.md) + +## Terminal.write() method + +> 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. +> + +Write a generic message to the terminal + +Signature: + +```typescript +write(...messageParts: (string | IColorableSequence)[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| messageParts | (string | IColorableSequence)[] | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.terminal.writeerror.md b/pages/api/node-core-library.terminal.writeerror.md new file mode 100644 index 000000000..a80b101d6 --- /dev/null +++ b/pages/api/node-core-library.terminal.writeerror.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Terminal](./node-core-library.terminal.md) > [writeError](./node-core-library.terminal.writeerror.md) + +## Terminal.writeError() method + +> 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. +> + +Write an error message to the console with red text. + +Signature: + +```typescript +writeError(...messageParts: (string | IColorableSequence)[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| messageParts | (string | IColorableSequence)[] | | + +Returns: + +`void` + +## Remarks + +The red color takes precedence over any other foreground colors set. + diff --git a/pages/api/node-core-library.terminal.writeerrorline.md b/pages/api/node-core-library.terminal.writeerrorline.md new file mode 100644 index 000000000..9ca70e1b5 --- /dev/null +++ b/pages/api/node-core-library.terminal.writeerrorline.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Terminal](./node-core-library.terminal.md) > [writeErrorLine](./node-core-library.terminal.writeerrorline.md) + +## Terminal.writeErrorLine() method + +> 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. +> + +Write an error message to the console with red text, followed by a newline. + +Signature: + +```typescript +writeErrorLine(...messageParts: (string | IColorableSequence)[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| messageParts | (string | IColorableSequence)[] | | + +Returns: + +`void` + +## Remarks + +The red color takes precedence over any other foreground colors set. + diff --git a/pages/api/node-core-library.terminal.writeline.md b/pages/api/node-core-library.terminal.writeline.md new file mode 100644 index 000000000..dac7520de --- /dev/null +++ b/pages/api/node-core-library.terminal.writeline.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Terminal](./node-core-library.terminal.md) > [writeLine](./node-core-library.terminal.writeline.md) + +## Terminal.writeLine() method + +> 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. +> + +Write a generic message to the terminal, followed by a newline + +Signature: + +```typescript +writeLine(...messageParts: (string | IColorableSequence)[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| messageParts | (string | IColorableSequence)[] | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.terminal.writeverbose.md b/pages/api/node-core-library.terminal.writeverbose.md new file mode 100644 index 000000000..140fff84e --- /dev/null +++ b/pages/api/node-core-library.terminal.writeverbose.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Terminal](./node-core-library.terminal.md) > [writeVerbose](./node-core-library.terminal.writeverbose.md) + +## Terminal.writeVerbose() method + +> 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. +> + +Write a verbose-level message. + +Signature: + +```typescript +writeVerbose(...messageParts: (string | IColorableSequence)[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| messageParts | (string | IColorableSequence)[] | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.terminal.writeverboseline.md b/pages/api/node-core-library.terminal.writeverboseline.md new file mode 100644 index 000000000..bb60f9fbd --- /dev/null +++ b/pages/api/node-core-library.terminal.writeverboseline.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Terminal](./node-core-library.terminal.md) > [writeVerboseLine](./node-core-library.terminal.writeverboseline.md) + +## Terminal.writeVerboseLine() method + +> 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. +> + +Write a verbose-level message followed by a newline. + +Signature: + +```typescript +writeVerboseLine(...messageParts: (string | IColorableSequence)[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| messageParts | (string | IColorableSequence)[] | | + +Returns: + +`void` + diff --git a/pages/api/node-core-library.terminal.writewarning.md b/pages/api/node-core-library.terminal.writewarning.md new file mode 100644 index 000000000..a695ec3ec --- /dev/null +++ b/pages/api/node-core-library.terminal.writewarning.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Terminal](./node-core-library.terminal.md) > [writeWarning](./node-core-library.terminal.writewarning.md) + +## Terminal.writeWarning() method + +> 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. +> + +Write a warning message to the console with yellow text. + +Signature: + +```typescript +writeWarning(...messageParts: (string | IColorableSequence)[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| messageParts | (string | IColorableSequence)[] | | + +Returns: + +`void` + +## Remarks + +The yellow color takes precedence over any other foreground colors set. + diff --git a/pages/api/node-core-library.terminal.writewarningline.md b/pages/api/node-core-library.terminal.writewarningline.md new file mode 100644 index 000000000..df6e5e857 --- /dev/null +++ b/pages/api/node-core-library.terminal.writewarningline.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Terminal](./node-core-library.terminal.md) > [writeWarningLine](./node-core-library.terminal.writewarningline.md) + +## Terminal.writeWarningLine() method + +> 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. +> + +Write a warning message to the console with yellow text, followed by a newline. + +Signature: + +```typescript +writeWarningLine(...messageParts: (string | IColorableSequence)[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| messageParts | (string | IColorableSequence)[] | | + +Returns: + +`void` + +## Remarks + +The yellow color takes precedence over any other foreground colors set. + diff --git a/pages/api/node-core-library.terminalproviderseverity.md b/pages/api/node-core-library.terminalproviderseverity.md new file mode 100644 index 000000000..6e554a5e0 --- /dev/null +++ b/pages/api/node-core-library.terminalproviderseverity.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [TerminalProviderSeverity](./node-core-library.terminalproviderseverity.md) + +## TerminalProviderSeverity enum + +> 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. +> + + +Signature: + +```typescript +export declare enum TerminalProviderSeverity +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| error | 2 | (BETA) | +| log | 0 | (BETA) | +| verbose | 3 | (BETA) | +| warning | 1 | (BETA) | + diff --git a/pages/api/node-core-library.text.converttocrlf.md b/pages/api/node-core-library.text.converttocrlf.md new file mode 100644 index 000000000..3ff4b6800 --- /dev/null +++ b/pages/api/node-core-library.text.converttocrlf.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Text](./node-core-library.text.md) > [convertToCrLf](./node-core-library.text.converttocrlf.md) + +## Text.convertToCrLf() method + +Converts all newlines in the provided string to use Windows-style CRLF end of line characters. + +Signature: + +```typescript +static convertToCrLf(input: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| input | string | | + +Returns: + +`string` + diff --git a/pages/api/node-core-library.text.converttolf.md b/pages/api/node-core-library.text.converttolf.md new file mode 100644 index 000000000..8dfc67672 --- /dev/null +++ b/pages/api/node-core-library.text.converttolf.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Text](./node-core-library.text.md) > [convertToLf](./node-core-library.text.converttolf.md) + +## Text.convertToLf() method + +Converts all newlines in the provided string to use POSIX-style LF end of line characters. + +POSIX is a registered trademark of the Institute of Electrical and Electronic Engineers, Inc. + +Signature: + +```typescript +static convertToLf(input: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| input | string | | + +Returns: + +`string` + diff --git a/pages/api/node-core-library.text.ensuretrailingnewline.md b/pages/api/node-core-library.text.ensuretrailingnewline.md new file mode 100644 index 000000000..e27ddc3af --- /dev/null +++ b/pages/api/node-core-library.text.ensuretrailingnewline.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Text](./node-core-library.text.md) > [ensureTrailingNewline](./node-core-library.text.ensuretrailingnewline.md) + +## Text.ensureTrailingNewline() method + +Returns the input string with a trailing `\n` character appended, if not already present. + +Signature: + +```typescript +static ensureTrailingNewline(s: string, newlineKind?: NewlineKind): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| s | string | | +| newlineKind | NewlineKind | | + +Returns: + +`string` + diff --git a/pages/api/node-core-library.text.md b/pages/api/node-core-library.text.md new file mode 100644 index 000000000..e0bc6cfbd --- /dev/null +++ b/pages/api/node-core-library.text.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Text](./node-core-library.text.md) + +## Text class + +Operations for working with strings that contain text. + +Signature: + +```typescript +export declare class Text +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [convertToCrLf(input)](./node-core-library.text.converttocrlf.md) | static | Converts all newlines in the provided string to use Windows-style CRLF end of line characters. | +| [convertToLf(input)](./node-core-library.text.converttolf.md) | static | Converts all newlines in the provided string to use POSIX-style LF end of line characters.POSIX is a registered trademark of the Institute of Electrical and Electronic Engineers, Inc. | +| [ensureTrailingNewline(s, newlineKind)](./node-core-library.text.ensuretrailingnewline.md) | static | Returns the input string with a trailing \n character appended, if not already present. | +| [padEnd(s, minimumLength, paddingCharacter)](./node-core-library.text.padend.md) | static | Append characters to the end of a string to ensure the result has a minimum length. | +| [padStart(s, minimumLength, paddingCharacter)](./node-core-library.text.padstart.md) | static | Append characters to the start of a string to ensure the result has a minimum length. | +| [replaceAll(input, searchValue, replaceValue)](./node-core-library.text.replaceall.md) | static | Returns the same thing as targetString.replace(searchValue, replaceValue), except that all matches are replaced, rather than just the first match. | +| [truncateWithEllipsis(s, maximumLength)](./node-core-library.text.truncatewithellipsis.md) | static | If the string is longer than maximumLength characters, truncate it to that length using "..." to indicate the truncation. | + +## Remarks + +The utilities provided by this class are intended to be simple, small, and very broadly applicable. + diff --git a/pages/api/node-core-library.text.padend.md b/pages/api/node-core-library.text.padend.md new file mode 100644 index 000000000..46f3d4a15 --- /dev/null +++ b/pages/api/node-core-library.text.padend.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Text](./node-core-library.text.md) > [padEnd](./node-core-library.text.padend.md) + +## Text.padEnd() method + +Append characters to the end of a string to ensure the result has a minimum length. + +Signature: + +```typescript +static padEnd(s: string, minimumLength: number, paddingCharacter?: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| s | string | | +| minimumLength | number | | +| paddingCharacter | string | | + +Returns: + +`string` + +## Remarks + +If the string length already exceeds the minimum length, then the string is unchanged. The string is not truncated. + diff --git a/pages/api/node-core-library.text.padstart.md b/pages/api/node-core-library.text.padstart.md new file mode 100644 index 000000000..876364461 --- /dev/null +++ b/pages/api/node-core-library.text.padstart.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Text](./node-core-library.text.md) > [padStart](./node-core-library.text.padstart.md) + +## Text.padStart() method + +Append characters to the start of a string to ensure the result has a minimum length. + +Signature: + +```typescript +static padStart(s: string, minimumLength: number, paddingCharacter?: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| s | string | | +| minimumLength | number | | +| paddingCharacter | string | | + +Returns: + +`string` + +## Remarks + +If the string length already exceeds the minimum length, then the string is unchanged. The string is not truncated. + diff --git a/pages/api/node-core-library.text.replaceall.md b/pages/api/node-core-library.text.replaceall.md new file mode 100644 index 000000000..858dd4be3 --- /dev/null +++ b/pages/api/node-core-library.text.replaceall.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Text](./node-core-library.text.md) > [replaceAll](./node-core-library.text.replaceall.md) + +## Text.replaceAll() method + +Returns the same thing as targetString.replace(searchValue, replaceValue), except that all matches are replaced, rather than just the first match. + +Signature: + +```typescript +static replaceAll(input: string, searchValue: string, replaceValue: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| input | string | The string to be modified | +| searchValue | string | The value to search for | +| replaceValue | string | The replacement text | + +Returns: + +`string` + diff --git a/pages/api/node-core-library.text.truncatewithellipsis.md b/pages/api/node-core-library.text.truncatewithellipsis.md new file mode 100644 index 000000000..a9a47e047 --- /dev/null +++ b/pages/api/node-core-library.text.truncatewithellipsis.md @@ -0,0 +1,34 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [Text](./node-core-library.text.md) > [truncateWithEllipsis](./node-core-library.text.truncatewithellipsis.md) + +## Text.truncateWithEllipsis() method + +If the string is longer than maximumLength characters, truncate it to that length using "..." to indicate the truncation. + +Signature: + +```typescript +static truncateWithEllipsis(s: string, maximumLength: number): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| s | string | | +| maximumLength | number | | + +Returns: + +`string` + +## Remarks + +For example truncateWithEllipsis('1234578', 5) would produce '12...'. + diff --git a/pages/api/node-core-library.textattribute.md b/pages/api/node-core-library.textattribute.md new file mode 100644 index 000000000..2d8b7441d --- /dev/null +++ b/pages/api/node-core-library.textattribute.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/node-core-library](./node-core-library.md) > [TextAttribute](./node-core-library.textattribute.md) + +## TextAttribute enum + +> 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. +> + +Text styles used with [IColorableSequence](./node-core-library.icolorablesequence.md). + +Signature: + +```typescript +export declare enum TextAttribute +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Blink | 3 | (BETA) | +| Bold | 0 | (BETA) | +| Dim | 1 | (BETA) | +| Hidden | 5 | (BETA) | +| InvertColor | 4 | (BETA) | +| Underline | 2 | (BETA) | + diff --git a/pages/api/package-deps-hash.getpackagedeps.md b/pages/api/package-deps-hash.getpackagedeps.md new file mode 100644 index 000000000..20a582e94 --- /dev/null +++ b/pages/api/package-deps-hash.getpackagedeps.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/package-deps-hash](./package-deps-hash.md) > [getPackageDeps](./package-deps-hash.getpackagedeps.md) + +## getPackageDeps() function + +Collects the current git filehashes for a directory + +Signature: + +```typescript +export declare function getPackageDeps(packagePath?: string, excludedPaths?: string[]): IPackageDeps; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| packagePath | string | | +| excludedPaths | string[] | | + +Returns: + +`IPackageDeps` + diff --git a/pages/api/package-deps-hash.ipackagedeps.files.md b/pages/api/package-deps-hash.ipackagedeps.files.md new file mode 100644 index 000000000..24d03568f --- /dev/null +++ b/pages/api/package-deps-hash.ipackagedeps.files.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/package-deps-hash](./package-deps-hash.md) > [IPackageDeps](./package-deps-hash.ipackagedeps.md) > [files](./package-deps-hash.ipackagedeps.files.md) + +## IPackageDeps.files property + +Signature: + +```typescript +files: { + [key: string]: string; + }; +``` diff --git a/pages/api/package-deps-hash.ipackagedeps.md b/pages/api/package-deps-hash.ipackagedeps.md new file mode 100644 index 000000000..d8153ab3b --- /dev/null +++ b/pages/api/package-deps-hash.ipackagedeps.md @@ -0,0 +1,24 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/package-deps-hash](./package-deps-hash.md) > [IPackageDeps](./package-deps-hash.ipackagedeps.md) + +## IPackageDeps interface + + +Signature: + +```typescript +export interface IPackageDeps +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [files](./package-deps-hash.ipackagedeps.files.md) | {
[key: string]: string;
} | | + diff --git a/pages/api/package-deps-hash.md b/pages/api/package-deps-hash.md new file mode 100644 index 000000000..0267b81a7 --- /dev/null +++ b/pages/api/package-deps-hash.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/package-deps-hash](./package-deps-hash.md) + +## package-deps-hash package + +## Functions + +| Function | Description | +| --- | --- | +| [getPackageDeps(packagePath, excludedPaths)](./package-deps-hash.getpackagedeps.md) | Collects the current git filehashes for a directory | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [IPackageDeps](./package-deps-hash.ipackagedeps.md) | | + diff --git a/pages/api/rush-lib.approvedpackagesconfiguration._constructor_.md b/pages/api/rush-lib.approvedpackagesconfiguration._constructor_.md new file mode 100644 index 000000000..908d58cdb --- /dev/null +++ b/pages/api/rush-lib.approvedpackagesconfiguration._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesConfiguration](./rush-lib.approvedpackagesconfiguration.md) > [(constructor)](./rush-lib.approvedpackagesconfiguration._constructor_.md) + +## ApprovedPackagesConfiguration.(constructor) + +Constructs a new instance of the `ApprovedPackagesConfiguration` class + +Signature: + +```typescript +constructor(jsonFilename: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonFilename | string | | + diff --git a/pages/api/rush-lib.approvedpackagesconfiguration.addorupdatepackage.md b/pages/api/rush-lib.approvedpackagesconfiguration.addorupdatepackage.md new file mode 100644 index 000000000..567449123 --- /dev/null +++ b/pages/api/rush-lib.approvedpackagesconfiguration.addorupdatepackage.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesConfiguration](./rush-lib.approvedpackagesconfiguration.md) > [addOrUpdatePackage](./rush-lib.approvedpackagesconfiguration.addorupdatepackage.md) + +## ApprovedPackagesConfiguration.addOrUpdatePackage() method + +Signature: + +```typescript +addOrUpdatePackage(packageName: string, reviewCategory: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| packageName | string | | +| reviewCategory | string | | + +Returns: + +`void` + diff --git a/pages/api/rush-lib.approvedpackagesconfiguration.clear.md b/pages/api/rush-lib.approvedpackagesconfiguration.clear.md new file mode 100644 index 000000000..f6a13de07 --- /dev/null +++ b/pages/api/rush-lib.approvedpackagesconfiguration.clear.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesConfiguration](./rush-lib.approvedpackagesconfiguration.md) > [clear](./rush-lib.approvedpackagesconfiguration.clear.md) + +## ApprovedPackagesConfiguration.clear() method + +Clears all the settings, returning to an empty state. + +Signature: + +```typescript +clear(): void; +``` +Returns: + +`void` + diff --git a/pages/api/rush-lib.approvedpackagesconfiguration.getitembyname.md b/pages/api/rush-lib.approvedpackagesconfiguration.getitembyname.md new file mode 100644 index 000000000..e1b6c9c83 --- /dev/null +++ b/pages/api/rush-lib.approvedpackagesconfiguration.getitembyname.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesConfiguration](./rush-lib.approvedpackagesconfiguration.md) > [getItemByName](./rush-lib.approvedpackagesconfiguration.getitembyname.md) + +## ApprovedPackagesConfiguration.getItemByName() method + +Signature: + +```typescript +getItemByName(packageName: string): ApprovedPackagesItem | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| packageName | string | | + +Returns: + +`ApprovedPackagesItem | undefined` + diff --git a/pages/api/rush-lib.approvedpackagesconfiguration.items.md b/pages/api/rush-lib.approvedpackagesconfiguration.items.md new file mode 100644 index 000000000..26dc14d9a --- /dev/null +++ b/pages/api/rush-lib.approvedpackagesconfiguration.items.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesConfiguration](./rush-lib.approvedpackagesconfiguration.md) > [items](./rush-lib.approvedpackagesconfiguration.items.md) + +## ApprovedPackagesConfiguration.items property + +Signature: + +```typescript +items: ApprovedPackagesItem[]; +``` diff --git a/pages/api/rush-lib.approvedpackagesconfiguration.loadfromfile.md b/pages/api/rush-lib.approvedpackagesconfiguration.loadfromfile.md new file mode 100644 index 000000000..e91f72388 --- /dev/null +++ b/pages/api/rush-lib.approvedpackagesconfiguration.loadfromfile.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesConfiguration](./rush-lib.approvedpackagesconfiguration.md) > [loadFromFile](./rush-lib.approvedpackagesconfiguration.loadfromfile.md) + +## ApprovedPackagesConfiguration.loadFromFile() method + +Loads the configuration data from the filename that was passed to the constructor. + +Signature: + +```typescript +loadFromFile(): void; +``` +Returns: + +`void` + diff --git a/pages/api/rush-lib.approvedpackagesconfiguration.md b/pages/api/rush-lib.approvedpackagesconfiguration.md new file mode 100644 index 000000000..448da82f7 --- /dev/null +++ b/pages/api/rush-lib.approvedpackagesconfiguration.md @@ -0,0 +1,42 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesConfiguration](./rush-lib.approvedpackagesconfiguration.md) + +## ApprovedPackagesConfiguration class + +This represents the JSON file specified via the "approvedPackagesFile" option in rush.json. + +Signature: + +```typescript +export declare class ApprovedPackagesConfiguration +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(jsonFilename)](./rush-lib.approvedpackagesconfiguration._constructor_.md) | | Constructs a new instance of the ApprovedPackagesConfiguration class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [items](./rush-lib.approvedpackagesconfiguration.items.md) | | ApprovedPackagesItem[] | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [addOrUpdatePackage(packageName, reviewCategory)](./rush-lib.approvedpackagesconfiguration.addorupdatepackage.md) | | | +| [clear()](./rush-lib.approvedpackagesconfiguration.clear.md) | | Clears all the settings, returning to an empty state. | +| [getItemByName(packageName)](./rush-lib.approvedpackagesconfiguration.getitembyname.md) | | | +| [loadFromFile()](./rush-lib.approvedpackagesconfiguration.loadfromfile.md) | | Loads the configuration data from the filename that was passed to the constructor. | +| [saveToFile()](./rush-lib.approvedpackagesconfiguration.savetofile.md) | | Loads the configuration data to the filename that was passed to the constructor. | +| [tryLoadFromFile(approvedPackagesPolicyEnabled)](./rush-lib.approvedpackagesconfiguration.tryloadfromfile.md) | | If the file exists, calls loadFromFile(). | + diff --git a/pages/api/rush-lib.approvedpackagesconfiguration.savetofile.md b/pages/api/rush-lib.approvedpackagesconfiguration.savetofile.md new file mode 100644 index 000000000..e4bef67bd --- /dev/null +++ b/pages/api/rush-lib.approvedpackagesconfiguration.savetofile.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesConfiguration](./rush-lib.approvedpackagesconfiguration.md) > [saveToFile](./rush-lib.approvedpackagesconfiguration.savetofile.md) + +## ApprovedPackagesConfiguration.saveToFile() method + +Loads the configuration data to the filename that was passed to the constructor. + +Signature: + +```typescript +saveToFile(): void; +``` +Returns: + +`void` + diff --git a/pages/api/rush-lib.approvedpackagesconfiguration.tryloadfromfile.md b/pages/api/rush-lib.approvedpackagesconfiguration.tryloadfromfile.md new file mode 100644 index 000000000..15f41bdf6 --- /dev/null +++ b/pages/api/rush-lib.approvedpackagesconfiguration.tryloadfromfile.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesConfiguration](./rush-lib.approvedpackagesconfiguration.md) > [tryLoadFromFile](./rush-lib.approvedpackagesconfiguration.tryloadfromfile.md) + +## ApprovedPackagesConfiguration.tryLoadFromFile() method + +If the file exists, calls loadFromFile(). + +Signature: + +```typescript +tryLoadFromFile(approvedPackagesPolicyEnabled: boolean): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| approvedPackagesPolicyEnabled | boolean | | + +Returns: + +`boolean` + diff --git a/pages/api/rush-lib.approvedpackagesitem.allowedcategories.md b/pages/api/rush-lib.approvedpackagesitem.allowedcategories.md new file mode 100644 index 000000000..e6c868559 --- /dev/null +++ b/pages/api/rush-lib.approvedpackagesitem.allowedcategories.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesItem](./rush-lib.approvedpackagesitem.md) > [allowedCategories](./rush-lib.approvedpackagesitem.allowedcategories.md) + +## ApprovedPackagesItem.allowedCategories property + +The project categories that are allowed to use this package. + +Signature: + +```typescript +allowedCategories: Set; +``` diff --git a/pages/api/rush-lib.approvedpackagesitem.md b/pages/api/rush-lib.approvedpackagesitem.md new file mode 100644 index 000000000..bd97bb4ba --- /dev/null +++ b/pages/api/rush-lib.approvedpackagesitem.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesItem](./rush-lib.approvedpackagesitem.md) + +## ApprovedPackagesItem class + +An item returned by ApprovedPackagesConfiguration + +Signature: + +```typescript +export declare class ApprovedPackagesItem +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [allowedCategories](./rush-lib.approvedpackagesitem.allowedcategories.md) | | Set<string> | The project categories that are allowed to use this package. | +| [packageName](./rush-lib.approvedpackagesitem.packagename.md) | | string | The NPM package name | + diff --git a/pages/api/rush-lib.approvedpackagesitem.packagename.md b/pages/api/rush-lib.approvedpackagesitem.packagename.md new file mode 100644 index 000000000..f3e8178c3 --- /dev/null +++ b/pages/api/rush-lib.approvedpackagesitem.packagename.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesItem](./rush-lib.approvedpackagesitem.md) > [packageName](./rush-lib.approvedpackagesitem.packagename.md) + +## ApprovedPackagesItem.packageName property + +The NPM package name + +Signature: + +```typescript +packageName: string; +``` diff --git a/pages/api/rush-lib.approvedpackagespolicy.browserapprovedpackages.md b/pages/api/rush-lib.approvedpackagespolicy.browserapprovedpackages.md new file mode 100644 index 000000000..95810ba53 --- /dev/null +++ b/pages/api/rush-lib.approvedpackagespolicy.browserapprovedpackages.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesPolicy](./rush-lib.approvedpackagespolicy.md) > [browserApprovedPackages](./rush-lib.approvedpackagespolicy.browserapprovedpackages.md) + +## ApprovedPackagesPolicy.browserApprovedPackages property + +Packages approved for usage in a web browser. This is the stricter of the two types, so by default all new packages are added to this file. + +Signature: + +```typescript +readonly browserApprovedPackages: ApprovedPackagesConfiguration; +``` + +## Remarks + +This is part of an optional approval workflow, whose purpose is to review any new dependencies that are introduced (e.g. maybe a legal review is required, or maybe we are trying to minimize bloat). When Rush discovers a new dependency has been added to package.json, it will update the file. The intent is that the file will be stored in Git and tracked by a branch policy that notifies reviewers when a PR attempts to modify the file. + +Example filename: `C:\MyRepo\common\config\rush\browser-approved-packages.json` + diff --git a/pages/api/rush-lib.approvedpackagespolicy.enabled.md b/pages/api/rush-lib.approvedpackagespolicy.enabled.md new file mode 100644 index 000000000..ed7e04d75 --- /dev/null +++ b/pages/api/rush-lib.approvedpackagespolicy.enabled.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesPolicy](./rush-lib.approvedpackagespolicy.md) > [enabled](./rush-lib.approvedpackagespolicy.enabled.md) + +## ApprovedPackagesPolicy.enabled property + +Whether the feature is enabled. The feature is enabled if the "approvedPackagesPolicy" field is assigned in rush.json. + +Signature: + +```typescript +readonly enabled: boolean; +``` diff --git a/pages/api/rush-lib.approvedpackagespolicy.ignorednpmscopes.md b/pages/api/rush-lib.approvedpackagespolicy.ignorednpmscopes.md new file mode 100644 index 000000000..56c4865b5 --- /dev/null +++ b/pages/api/rush-lib.approvedpackagespolicy.ignorednpmscopes.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesPolicy](./rush-lib.approvedpackagespolicy.md) > [ignoredNpmScopes](./rush-lib.approvedpackagespolicy.ignorednpmscopes.md) + +## ApprovedPackagesPolicy.ignoredNpmScopes property + +A list of NPM package scopes that will be excluded from review (e.g. `@types`) + +Signature: + +```typescript +readonly ignoredNpmScopes: Set; +``` diff --git a/pages/api/rush-lib.approvedpackagespolicy.md b/pages/api/rush-lib.approvedpackagespolicy.md new file mode 100644 index 000000000..e8ee5b34f --- /dev/null +++ b/pages/api/rush-lib.approvedpackagespolicy.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesPolicy](./rush-lib.approvedpackagespolicy.md) + +## ApprovedPackagesPolicy class + +This is a helper object for RushConfiguration. It exposes the "approvedPackagesPolicy" feature from rush.json. + +Signature: + +```typescript +export declare class ApprovedPackagesPolicy +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [browserApprovedPackages](./rush-lib.approvedpackagespolicy.browserapprovedpackages.md) | | ApprovedPackagesConfiguration | Packages approved for usage in a web browser. This is the stricter of the two types, so by default all new packages are added to this file. | +| [enabled](./rush-lib.approvedpackagespolicy.enabled.md) | | boolean | Whether the feature is enabled. The feature is enabled if the "approvedPackagesPolicy" field is assigned in rush.json. | +| [ignoredNpmScopes](./rush-lib.approvedpackagespolicy.ignorednpmscopes.md) | | Set<string> | A list of NPM package scopes that will be excluded from review (e.g. @types) | +| [nonbrowserApprovedPackages](./rush-lib.approvedpackagespolicy.nonbrowserapprovedpackages.md) | | ApprovedPackagesConfiguration | Packages approved for usage everywhere \*except\* in a web browser. | +| [reviewCategories](./rush-lib.approvedpackagespolicy.reviewcategories.md) | | Set<string> | A list of category names that are valid for usage as the RushConfigurationProject.reviewCategory field. This array will never be undefined. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ApprovedPackagesPolicy` class. + diff --git a/pages/api/rush-lib.approvedpackagespolicy.nonbrowserapprovedpackages.md b/pages/api/rush-lib.approvedpackagespolicy.nonbrowserapprovedpackages.md new file mode 100644 index 000000000..88b06a737 --- /dev/null +++ b/pages/api/rush-lib.approvedpackagespolicy.nonbrowserapprovedpackages.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesPolicy](./rush-lib.approvedpackagespolicy.md) > [nonbrowserApprovedPackages](./rush-lib.approvedpackagespolicy.nonbrowserapprovedpackages.md) + +## ApprovedPackagesPolicy.nonbrowserApprovedPackages property + +Packages approved for usage everywhere \*except\* in a web browser. + +Signature: + +```typescript +readonly nonbrowserApprovedPackages: ApprovedPackagesConfiguration; +``` + +## Remarks + +This is part of an optional approval workflow, whose purpose is to review any new dependencies that are introduced (e.g. maybe a legal review is required, or maybe we are trying to minimize bloat). The intent is that the file will be stored in Git and tracked by a branch policy that notifies reviewers when a PR attempts to modify the file. + +Example filename: `C:\MyRepo\common\config\rush\browser-approved-packages.json` + diff --git a/pages/api/rush-lib.approvedpackagespolicy.reviewcategories.md b/pages/api/rush-lib.approvedpackagespolicy.reviewcategories.md new file mode 100644 index 000000000..f773b0899 --- /dev/null +++ b/pages/api/rush-lib.approvedpackagespolicy.reviewcategories.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ApprovedPackagesPolicy](./rush-lib.approvedpackagespolicy.md) > [reviewCategories](./rush-lib.approvedpackagespolicy.reviewcategories.md) + +## ApprovedPackagesPolicy.reviewCategories property + +A list of category names that are valid for usage as the RushConfigurationProject.reviewCategory field. This array will never be undefined. + +Signature: + +```typescript +readonly reviewCategories: Set; +``` diff --git a/pages/api/rush-lib.bumptype.md b/pages/api/rush-lib.bumptype.md new file mode 100644 index 000000000..2e1755d29 --- /dev/null +++ b/pages/api/rush-lib.bumptype.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [BumpType](./rush-lib.bumptype.md) + +## BumpType enum + +> 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. +> + +Type of version bumps + +Signature: + +```typescript +export declare enum BumpType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| major | 5 | (BETA) | +| minor | 4 | (BETA) | +| none | 0 | (BETA) | +| patch | 2 | (BETA) | +| preminor | 3 | (BETA) | +| prerelease | 1 | (BETA) | + diff --git a/pages/api/rush-lib.changemanager.createemptychangefiles.md b/pages/api/rush-lib.changemanager.createemptychangefiles.md new file mode 100644 index 000000000..8c381de76 --- /dev/null +++ b/pages/api/rush-lib.changemanager.createemptychangefiles.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ChangeManager](./rush-lib.changemanager.md) > [createEmptyChangeFiles](./rush-lib.changemanager.createemptychangefiles.md) + +## ChangeManager.createEmptyChangeFiles() method + +Creates a change file that has a 'none' type. + +Signature: + +```typescript +static createEmptyChangeFiles(rushConfiguration: RushConfiguration, projectName: string, emailAddress: string): string | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| rushConfiguration | RushConfiguration | The rush configuration we are working with | +| projectName | string | The name of the project for which to create a change file | +| emailAddress | string | The email address which should be associated with this change | + +Returns: + +`string | undefined` + +the path to the file that was created, or undefined if no file was written + diff --git a/pages/api/rush-lib.changemanager.md b/pages/api/rush-lib.changemanager.md new file mode 100644 index 000000000..f4cd384ca --- /dev/null +++ b/pages/api/rush-lib.changemanager.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ChangeManager](./rush-lib.changemanager.md) + +## ChangeManager class + +A class that helps with programatically interacting with Rush's change files. + +Signature: + +```typescript +export declare class ChangeManager +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [createEmptyChangeFiles(rushConfiguration, projectName, emailAddress)](./rush-lib.changemanager.createemptychangefiles.md) | static | Creates a change file that has a 'none' type. | + diff --git a/pages/api/rush-lib.commonversionsconfiguration.allowedalternativeversions.md b/pages/api/rush-lib.commonversionsconfiguration.allowedalternativeversions.md new file mode 100644 index 000000000..2c3c0117b --- /dev/null +++ b/pages/api/rush-lib.commonversionsconfiguration.allowedalternativeversions.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [CommonVersionsConfiguration](./rush-lib.commonversionsconfiguration.md) > [allowedAlternativeVersions](./rush-lib.commonversionsconfiguration.allowedalternativeversions.md) + +## CommonVersionsConfiguration.allowedAlternativeVersions property + +A table that stores, for a given dependency, a list of SemVer ranges that will be accepted by "rush check" in addition to the normal version range. + +Signature: + +```typescript +readonly allowedAlternativeVersions: Map>; +``` + +## Remarks + +The "rush check" command can be used to enforce that every project in the repo must specify the same SemVer range for a given dependency. However, sometimes exceptions are needed. The allowedAlternativeVersions table allows you to list other SemVer ranges that will be accepted by "rush check" for a given dependency. Note that the normal version range (as inferred by looking at all projects in the repo) should NOT be included in this list. + diff --git a/pages/api/rush-lib.commonversionsconfiguration.filepath.md b/pages/api/rush-lib.commonversionsconfiguration.filepath.md new file mode 100644 index 000000000..9abfc3470 --- /dev/null +++ b/pages/api/rush-lib.commonversionsconfiguration.filepath.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [CommonVersionsConfiguration](./rush-lib.commonversionsconfiguration.md) > [filePath](./rush-lib.commonversionsconfiguration.filepath.md) + +## CommonVersionsConfiguration.filePath property + +Get the absolute file path of the common-versions.json file. + +Signature: + +```typescript +readonly filePath: string; +``` diff --git a/pages/api/rush-lib.commonversionsconfiguration.getallpreferredversions.md b/pages/api/rush-lib.commonversionsconfiguration.getallpreferredversions.md new file mode 100644 index 000000000..7a1584574 --- /dev/null +++ b/pages/api/rush-lib.commonversionsconfiguration.getallpreferredversions.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [CommonVersionsConfiguration](./rush-lib.commonversionsconfiguration.md) > [getAllPreferredVersions](./rush-lib.commonversionsconfiguration.getallpreferredversions.md) + +## CommonVersionsConfiguration.getAllPreferredVersions() method + +Returns the union of preferredVersions and xstitchPreferredVersions. + +Signature: + +```typescript +getAllPreferredVersions(): Map; +``` +Returns: + +`Map` + diff --git a/pages/api/rush-lib.commonversionsconfiguration.loadfromfile.md b/pages/api/rush-lib.commonversionsconfiguration.loadfromfile.md new file mode 100644 index 000000000..016df69a7 --- /dev/null +++ b/pages/api/rush-lib.commonversionsconfiguration.loadfromfile.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [CommonVersionsConfiguration](./rush-lib.commonversionsconfiguration.md) > [loadFromFile](./rush-lib.commonversionsconfiguration.loadfromfile.md) + +## CommonVersionsConfiguration.loadFromFile() method + +Loads the common-versions.json data from the specified file path. If the file has not been created yet, then an empty object is returned. + +Signature: + +```typescript +static loadFromFile(jsonFilename: string): CommonVersionsConfiguration; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonFilename | string | | + +Returns: + +`CommonVersionsConfiguration` + diff --git a/pages/api/rush-lib.commonversionsconfiguration.md b/pages/api/rush-lib.commonversionsconfiguration.md new file mode 100644 index 000000000..b8ec6007b --- /dev/null +++ b/pages/api/rush-lib.commonversionsconfiguration.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [CommonVersionsConfiguration](./rush-lib.commonversionsconfiguration.md) + +## CommonVersionsConfiguration class + +Use this class to load and save the "common/config/rush/common-versions.json" config file. This config file stores dependency version information that affects all projects in the repo. + +Signature: + +```typescript +export declare class CommonVersionsConfiguration +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [allowedAlternativeVersions](./rush-lib.commonversionsconfiguration.allowedalternativeversions.md) | | Map<string, ReadonlyArray<string>> | A table that stores, for a given dependency, a list of SemVer ranges that will be accepted by "rush check" in addition to the normal version range. | +| [filePath](./rush-lib.commonversionsconfiguration.filepath.md) | | string | Get the absolute file path of the common-versions.json file. | +| [preferredVersions](./rush-lib.commonversionsconfiguration.preferredversions.md) | | Map<string, string> | A table that specifies a "preferred version" for a dependency package. | +| [xstitchPreferredVersions](./rush-lib.commonversionsconfiguration.xstitchpreferredversions.md) | | Map<string, string> | A table of specifies preferred versions maintained by the XStitch tool. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [getAllPreferredVersions()](./rush-lib.commonversionsconfiguration.getallpreferredversions.md) | | Returns the union of preferredVersions and xstitchPreferredVersions. | +| [loadFromFile(jsonFilename)](./rush-lib.commonversionsconfiguration.loadfromfile.md) | static | Loads the common-versions.json data from the specified file path. If the file has not been created yet, then an empty object is returned. | +| [save()](./rush-lib.commonversionsconfiguration.save.md) | | Writes the "common-versions.json" file to disk, using the filename that was passed to loadFromFile(). | + diff --git a/pages/api/rush-lib.commonversionsconfiguration.preferredversions.md b/pages/api/rush-lib.commonversionsconfiguration.preferredversions.md new file mode 100644 index 000000000..d373ffae2 --- /dev/null +++ b/pages/api/rush-lib.commonversionsconfiguration.preferredversions.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [CommonVersionsConfiguration](./rush-lib.commonversionsconfiguration.md) > [preferredVersions](./rush-lib.commonversionsconfiguration.preferredversions.md) + +## CommonVersionsConfiguration.preferredVersions property + +A table that specifies a "preferred version" for a dependency package. + +Signature: + +```typescript +readonly preferredVersions: Map; +``` + +## Remarks + +The "preferred version" is typically used to hold an indirect dependency back to a specific version, however generally it can be any SemVer range specifier (e.g. "\~1.2.3"), and it will narrow any (compatible) SemVer range specifier. + +For example, suppose local project `A` depends on an external package `B`, and `B` asks for `C@^1.0.0`, which normally would select `C@1.5.0`. If we specify `C@~1.2.3` as our preferred version, and it selects `C@1.2.9`, then that will be installed for B instead of `C@1.5.0`. Whereas if the preferred version was `C@~2.0.0` then it would have no effect, because this is incompatible with `C@^1.0.0`. A compatible parent dependency will take precedence over the preferred version; for example if `A` had a direct dependency on `C@1.2.2`, then `B` would get `C@1.2.2` regardless of the preferred version. + +Rush's implementation relies on the package manager's heuristic for avoiding duplicates by trying to reuse dependencies requested by a parent in the graph: The preferred versions are simply injected into the fake common/temp/package.json file that acts as the root for all local projects in the Rush repo. + diff --git a/pages/api/rush-lib.commonversionsconfiguration.save.md b/pages/api/rush-lib.commonversionsconfiguration.save.md new file mode 100644 index 000000000..90f80eb0a --- /dev/null +++ b/pages/api/rush-lib.commonversionsconfiguration.save.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [CommonVersionsConfiguration](./rush-lib.commonversionsconfiguration.md) > [save](./rush-lib.commonversionsconfiguration.save.md) + +## CommonVersionsConfiguration.save() method + +Writes the "common-versions.json" file to disk, using the filename that was passed to loadFromFile(). + +Signature: + +```typescript +save(): boolean; +``` +Returns: + +`boolean` + diff --git a/pages/api/rush-lib.commonversionsconfiguration.xstitchpreferredversions.md b/pages/api/rush-lib.commonversionsconfiguration.xstitchpreferredversions.md new file mode 100644 index 000000000..4847f2efb --- /dev/null +++ b/pages/api/rush-lib.commonversionsconfiguration.xstitchpreferredversions.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [CommonVersionsConfiguration](./rush-lib.commonversionsconfiguration.md) > [xstitchPreferredVersions](./rush-lib.commonversionsconfiguration.xstitchpreferredversions.md) + +## CommonVersionsConfiguration.xstitchPreferredVersions property + +A table of specifies preferred versions maintained by the XStitch tool. + +Signature: + +```typescript +readonly xstitchPreferredVersions: Map; +``` + +## Remarks + +This property has the same behavior as the "preferredVersions" property, except these entries are automatically managed by the XStitch tool. It is an error for the same dependency name to appear in both tables. + diff --git a/pages/api/rush-lib.dependencytype.md b/pages/api/rush-lib.dependencytype.md new file mode 100644 index 000000000..521cdb2f7 --- /dev/null +++ b/pages/api/rush-lib.dependencytype.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [DependencyType](./rush-lib.dependencytype.md) + +## DependencyType enum + +> 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. +> + + +Signature: + +```typescript +export declare const enum DependencyType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Dev | "devDependencies" | (BETA) | +| Optional | "optionalDependencies" | (BETA) | +| Peer | "peerDependencies" | (BETA) | +| Regular | "dependencies" | (BETA) | + diff --git a/pages/api/rush-lib.environmentvariablenames.md b/pages/api/rush-lib.environmentvariablenames.md new file mode 100644 index 000000000..63ea742f3 --- /dev/null +++ b/pages/api/rush-lib.environmentvariablenames.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [EnvironmentVariableNames](./rush-lib.environmentvariablenames.md) + +## EnvironmentVariableNames enum + +Names of environment variables used by Rush. + +Signature: + +```typescript +export declare const enum EnvironmentVariableNames +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| RUSH\_ABSOLUTE\_SYMLINKS | "RUSH_ABSOLUTE_SYMLINKS" | 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 | "RUSH_ALLOW_UNSUPPORTED_NODEJS" | 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\_PREVIEW\_VERSION | "RUSH_PREVIEW_VERSION" | 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. | +| RUSH\_TEMP\_FOLDER | "RUSH_TEMP_FOLDER" | This variable overrides the temporary folder used by Rush. The default value is "common/temp" under the repository root. | +| RUSH\_VARIANT | "RUSH_VARIANT" | This variable selects a specific installation variant for Rush to use when installing and linking package dependencies. For more information, see this article: https://rushjs.io/pages/advanced/installation\_variants/ | + diff --git a/pages/api/rush-lib.event.md b/pages/api/rush-lib.event.md new file mode 100644 index 000000000..39ced61c7 --- /dev/null +++ b/pages/api/rush-lib.event.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [Event](./rush-lib.event.md) + +## Event enum + +> 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. +> + +Events happen during Rush runs. + +Signature: + +```typescript +export declare enum Event +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| postRushBuild | 4 | (BETA) Post Rush build event | +| postRushInstall | 2 | (BETA) Post Rush install event | +| preRushBuild | 3 | (BETA) Pre Rush build event | +| preRushInstall | 1 | (BETA) Pre Rush install event | + diff --git a/pages/api/rush-lib.eventhooks.get.md b/pages/api/rush-lib.eventhooks.get.md new file mode 100644 index 000000000..a75fa9e3e --- /dev/null +++ b/pages/api/rush-lib.eventhooks.get.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [EventHooks](./rush-lib.eventhooks.md) > [get](./rush-lib.eventhooks.get.md) + +## EventHooks.get() method + +> 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. +> + +Return all the scripts associated with the specified event. + +Signature: + +```typescript +get(event: Event): string[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| event | Event | Rush event | + +Returns: + +`string[]` + diff --git a/pages/api/rush-lib.eventhooks.md b/pages/api/rush-lib.eventhooks.md new file mode 100644 index 000000000..957530596 --- /dev/null +++ b/pages/api/rush-lib.eventhooks.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [EventHooks](./rush-lib.eventhooks.md) + +## EventHooks class + +> 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 class represents Rush event hooks configured for this repo. Hooks are customized script actions that Rush executes when specific events occur. The actions are expressed as a command-line that is executed using the operating system shell. + +Signature: + +```typescript +export declare class EventHooks +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [get(event)](./rush-lib.eventhooks.get.md) | | (BETA) Return all the scripts associated with the specified event. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `EventHooks` class. + diff --git a/pages/api/rush-lib.ilaunchoptions.alreadyreportednodetoonewerror.md b/pages/api/rush-lib.ilaunchoptions.alreadyreportednodetoonewerror.md new file mode 100644 index 000000000..6e3d95cd0 --- /dev/null +++ b/pages/api/rush-lib.ilaunchoptions.alreadyreportednodetoonewerror.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ILaunchOptions](./rush-lib.ilaunchoptions.md) > [alreadyReportedNodeTooNewError](./rush-lib.ilaunchoptions.alreadyreportednodetoonewerror.md) + +## ILaunchOptions.alreadyReportedNodeTooNewError property + +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. + +Signature: + +```typescript +alreadyReportedNodeTooNewError?: boolean; +``` diff --git a/pages/api/rush-lib.ilaunchoptions.ismanaged.md b/pages/api/rush-lib.ilaunchoptions.ismanaged.md new file mode 100644 index 000000000..3326a0bf1 --- /dev/null +++ b/pages/api/rush-lib.ilaunchoptions.ismanaged.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ILaunchOptions](./rush-lib.ilaunchoptions.md) > [isManaged](./rush-lib.ilaunchoptions.ismanaged.md) + +## ILaunchOptions.isManaged property + +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. + +Signature: + +```typescript +isManaged: boolean; +``` diff --git a/pages/api/rush-lib.ilaunchoptions.md b/pages/api/rush-lib.ilaunchoptions.md new file mode 100644 index 000000000..adfe3658f --- /dev/null +++ b/pages/api/rush-lib.ilaunchoptions.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ILaunchOptions](./rush-lib.ilaunchoptions.md) + +## ILaunchOptions interface + +Options to pass to the rush "launch" functions. + +Signature: + +```typescript +export interface ILaunchOptions +``` + +## Properties + +| 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. | +| [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. | + diff --git a/pages/api/rush-lib.individualversionpolicy.bump.md b/pages/api/rush-lib.individualversionpolicy.bump.md new file mode 100644 index 000000000..27fefc6c5 --- /dev/null +++ b/pages/api/rush-lib.individualversionpolicy.bump.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [IndividualVersionPolicy](./rush-lib.individualversionpolicy.md) > [bump](./rush-lib.individualversionpolicy.bump.md) + +## IndividualVersionPolicy.bump() method + +> 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. +> + +Bumps version. Individual version policy lets change files drive version bump. This method currently does not do anything. + +Signature: + +```typescript +bump(bumpType?: BumpType, identifier?: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| bumpType | BumpType | bump type | +| identifier | string | prerelease id | + +Returns: + +`void` + diff --git a/pages/api/rush-lib.individualversionpolicy.ensure.md b/pages/api/rush-lib.individualversionpolicy.ensure.md new file mode 100644 index 000000000..730fcd866 --- /dev/null +++ b/pages/api/rush-lib.individualversionpolicy.ensure.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [IndividualVersionPolicy](./rush-lib.individualversionpolicy.md) > [ensure](./rush-lib.individualversionpolicy.ensure.md) + +## IndividualVersionPolicy.ensure() method + +> 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. +> + +Returns an updated package json that satisfies the version policy. + +Signature: + +```typescript +ensure(project: IPackageJson, force?: boolean): IPackageJson | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| project | IPackageJson | input package json | +| force | boolean | force update even when the project version is higher than the policy version. | + +Returns: + +`IPackageJson | undefined` + diff --git a/pages/api/rush-lib.individualversionpolicy.lockedmajor.md b/pages/api/rush-lib.individualversionpolicy.lockedmajor.md new file mode 100644 index 000000000..e3540db0b --- /dev/null +++ b/pages/api/rush-lib.individualversionpolicy.lockedmajor.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [IndividualVersionPolicy](./rush-lib.individualversionpolicy.md) > [lockedMajor](./rush-lib.individualversionpolicy.lockedmajor.md) + +## IndividualVersionPolicy.lockedMajor 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. +> + +The major version that has been locked + +Signature: + +```typescript +readonly lockedMajor: number | undefined; +``` diff --git a/pages/api/rush-lib.individualversionpolicy.md b/pages/api/rush-lib.individualversionpolicy.md new file mode 100644 index 000000000..333687a7e --- /dev/null +++ b/pages/api/rush-lib.individualversionpolicy.md @@ -0,0 +1,40 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [IndividualVersionPolicy](./rush-lib.individualversionpolicy.md) + +## IndividualVersionPolicy class + +> 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 policy indicates all related projects get version bump driven by their own changes. + +Signature: + +```typescript +export declare class IndividualVersionPolicy extends VersionPolicy +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [lockedMajor](./rush-lib.individualversionpolicy.lockedmajor.md) | | number | undefined | (BETA) The major version that has been locked | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [bump(bumpType, identifier)](./rush-lib.individualversionpolicy.bump.md) | | (BETA) Bumps version. Individual version policy lets change files drive version bump. This method currently does not do anything. | +| [ensure(project, force)](./rush-lib.individualversionpolicy.ensure.md) | | (BETA) Returns an updated package json that satisfies the version policy. | +| [validate(versionString, packageName)](./rush-lib.individualversionpolicy.validate.md) | | (BETA) Validates the specified version and throws if the version does not satisfy the policy. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `IndividualVersionPolicy` class. + diff --git a/pages/api/rush-lib.individualversionpolicy.validate.md b/pages/api/rush-lib.individualversionpolicy.validate.md new file mode 100644 index 000000000..22d0a28e4 --- /dev/null +++ b/pages/api/rush-lib.individualversionpolicy.validate.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [IndividualVersionPolicy](./rush-lib.individualversionpolicy.md) > [validate](./rush-lib.individualversionpolicy.validate.md) + +## IndividualVersionPolicy.validate() method + +> 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. +> + +Validates the specified version and throws if the version does not satisfy the policy. + +Signature: + +```typescript +validate(versionString: string, packageName: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| versionString | string | version string | +| packageName | string | package name | + +Returns: + +`void` + diff --git a/pages/api/rush-lib.itryfindrushjsonlocationoptions.md b/pages/api/rush-lib.itryfindrushjsonlocationoptions.md new file mode 100644 index 000000000..ccc6df95f --- /dev/null +++ b/pages/api/rush-lib.itryfindrushjsonlocationoptions.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ITryFindRushJsonLocationOptions](./rush-lib.itryfindrushjsonlocationoptions.md) + +## ITryFindRushJsonLocationOptions interface + +Options for `RushConfiguration.tryFindRushJsonLocation`. + +Signature: + +```typescript +export interface ITryFindRushJsonLocationOptions +``` + +## Properties + +| 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. | + diff --git a/pages/api/rush-lib.itryfindrushjsonlocationoptions.showverbose.md b/pages/api/rush-lib.itryfindrushjsonlocationoptions.showverbose.md new file mode 100644 index 000000000..f8755c5c4 --- /dev/null +++ b/pages/api/rush-lib.itryfindrushjsonlocationoptions.showverbose.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ITryFindRushJsonLocationOptions](./rush-lib.itryfindrushjsonlocationoptions.md) > [showVerbose](./rush-lib.itryfindrushjsonlocationoptions.showverbose.md) + +## ITryFindRushJsonLocationOptions.showVerbose property + +Whether to show verbose console messages. Defaults to false. + +Signature: + +```typescript +showVerbose?: boolean; +``` diff --git a/pages/api/rush-lib.itryfindrushjsonlocationoptions.startingfolder.md b/pages/api/rush-lib.itryfindrushjsonlocationoptions.startingfolder.md new file mode 100644 index 000000000..b47b0af57 --- /dev/null +++ b/pages/api/rush-lib.itryfindrushjsonlocationoptions.startingfolder.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [ITryFindRushJsonLocationOptions](./rush-lib.itryfindrushjsonlocationoptions.md) > [startingFolder](./rush-lib.itryfindrushjsonlocationoptions.startingfolder.md) + +## ITryFindRushJsonLocationOptions.startingFolder property + +The folder path where the search will start. Defaults tot he current working directory. + +Signature: + +```typescript +startingFolder?: string; +``` diff --git a/pages/api/rush-lib.lockstepversionpolicy.bump.md b/pages/api/rush-lib.lockstepversionpolicy.bump.md new file mode 100644 index 000000000..452e7a7cb --- /dev/null +++ b/pages/api/rush-lib.lockstepversionpolicy.bump.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [LockStepVersionPolicy](./rush-lib.lockstepversionpolicy.md) > [bump](./rush-lib.lockstepversionpolicy.bump.md) + +## LockStepVersionPolicy.bump() method + +> 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. +> + +Bumps the version of the lockstep policy + +Signature: + +```typescript +bump(bumpType?: BumpType, identifier?: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| bumpType | BumpType | Overwrite bump type in version-policy.json with the provided value. | +| identifier | string | Prerelease identifier if bump type is prerelease. | + +Returns: + +`void` + diff --git a/pages/api/rush-lib.lockstepversionpolicy.ensure.md b/pages/api/rush-lib.lockstepversionpolicy.ensure.md new file mode 100644 index 000000000..524bde9b1 --- /dev/null +++ b/pages/api/rush-lib.lockstepversionpolicy.ensure.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [LockStepVersionPolicy](./rush-lib.lockstepversionpolicy.md) > [ensure](./rush-lib.lockstepversionpolicy.ensure.md) + +## LockStepVersionPolicy.ensure() method + +> 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. +> + +Returns an updated package json that satisfies the version policy. + +Signature: + +```typescript +ensure(project: IPackageJson, force?: boolean): IPackageJson | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| project | IPackageJson | input package json | +| force | boolean | force update even when the project version is higher than the policy version. | + +Returns: + +`IPackageJson | undefined` + diff --git a/pages/api/rush-lib.lockstepversionpolicy.mainproject.md b/pages/api/rush-lib.lockstepversionpolicy.mainproject.md new file mode 100644 index 000000000..2f8ba717f --- /dev/null +++ b/pages/api/rush-lib.lockstepversionpolicy.mainproject.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [LockStepVersionPolicy](./rush-lib.lockstepversionpolicy.md) > [mainProject](./rush-lib.lockstepversionpolicy.mainproject.md) + +## LockStepVersionPolicy.mainProject 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. +> + +The main project for the version policy. + +If the value is provided, change logs will only be generated in that project. If the value is not provided, change logs will be hosted in each project associated with the policy. + +Signature: + +```typescript +readonly mainProject: string | undefined; +``` diff --git a/pages/api/rush-lib.lockstepversionpolicy.md b/pages/api/rush-lib.lockstepversionpolicy.md new file mode 100644 index 000000000..fc0f6d48c --- /dev/null +++ b/pages/api/rush-lib.lockstepversionpolicy.md @@ -0,0 +1,43 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [LockStepVersionPolicy](./rush-lib.lockstepversionpolicy.md) + +## LockStepVersionPolicy class + +> 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 policy indicates all related projects should use the same version. + +Signature: + +```typescript +export declare class LockStepVersionPolicy extends VersionPolicy +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [mainProject](./rush-lib.lockstepversionpolicy.mainproject.md) | | string | undefined | (BETA) The main project for the version policy.If the value is provided, change logs will only be generated in that project. If the value is not provided, change logs will be hosted in each project associated with the policy. | +| [nextBump](./rush-lib.lockstepversionpolicy.nextbump.md) | | BumpType | (BETA) The type of bump for next bump. | +| [version](./rush-lib.lockstepversionpolicy.version.md) | | string | (BETA) The value of the lockstep version | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [bump(bumpType, identifier)](./rush-lib.lockstepversionpolicy.bump.md) | | (BETA) Bumps the version of the lockstep policy | +| [ensure(project, force)](./rush-lib.lockstepversionpolicy.ensure.md) | | (BETA) Returns an updated package json that satisfies the version policy. | +| [update(newVersionString)](./rush-lib.lockstepversionpolicy.update.md) | | (BETA) Updates the version of the policy directly with a new value | +| [validate(versionString, packageName)](./rush-lib.lockstepversionpolicy.validate.md) | | (BETA) Validates the specified version and throws if the version does not satisfy lockstep version. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `LockStepVersionPolicy` class. + diff --git a/pages/api/rush-lib.lockstepversionpolicy.nextbump.md b/pages/api/rush-lib.lockstepversionpolicy.nextbump.md new file mode 100644 index 000000000..6f0ee13c7 --- /dev/null +++ b/pages/api/rush-lib.lockstepversionpolicy.nextbump.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [LockStepVersionPolicy](./rush-lib.lockstepversionpolicy.md) > [nextBump](./rush-lib.lockstepversionpolicy.nextbump.md) + +## LockStepVersionPolicy.nextBump 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. +> + +The type of bump for next bump. + +Signature: + +```typescript +readonly nextBump: BumpType; +``` diff --git a/pages/api/rush-lib.lockstepversionpolicy.update.md b/pages/api/rush-lib.lockstepversionpolicy.update.md new file mode 100644 index 000000000..3523c925c --- /dev/null +++ b/pages/api/rush-lib.lockstepversionpolicy.update.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [LockStepVersionPolicy](./rush-lib.lockstepversionpolicy.md) > [update](./rush-lib.lockstepversionpolicy.update.md) + +## LockStepVersionPolicy.update() method + +> 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. +> + +Updates the version of the policy directly with a new value + +Signature: + +```typescript +update(newVersionString: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| newVersionString | string | New version | + +Returns: + +`boolean` + diff --git a/pages/api/rush-lib.lockstepversionpolicy.validate.md b/pages/api/rush-lib.lockstepversionpolicy.validate.md new file mode 100644 index 000000000..a95bf533c --- /dev/null +++ b/pages/api/rush-lib.lockstepversionpolicy.validate.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [LockStepVersionPolicy](./rush-lib.lockstepversionpolicy.md) > [validate](./rush-lib.lockstepversionpolicy.validate.md) + +## LockStepVersionPolicy.validate() method + +> 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. +> + +Validates the specified version and throws if the version does not satisfy lockstep version. + +Signature: + +```typescript +validate(versionString: string, packageName: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| versionString | string | version string | +| packageName | string | package name | + +Returns: + +`void` + diff --git a/pages/api/rush-lib.lockstepversionpolicy.version.md b/pages/api/rush-lib.lockstepversionpolicy.version.md new file mode 100644 index 000000000..c661a0623 --- /dev/null +++ b/pages/api/rush-lib.lockstepversionpolicy.version.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [LockStepVersionPolicy](./rush-lib.lockstepversionpolicy.md) > [version](./rush-lib.lockstepversionpolicy.version.md) + +## LockStepVersionPolicy.version 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. +> + +The value of the lockstep version + +Signature: + +```typescript +readonly version: string; +``` diff --git a/pages/api/rush-lib.md b/pages/api/rush-lib.md new file mode 100644 index 000000000..85983fcbf --- /dev/null +++ b/pages/api/rush-lib.md @@ -0,0 +1,60 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) + +## rush-lib package + +A library for writing scripts that interact with the Rush tool. + +## Classes + +| Class | Description | +| --- | --- | +| [ApprovedPackagesConfiguration](./rush-lib.approvedpackagesconfiguration.md) | This represents the JSON file specified via the "approvedPackagesFile" option in rush.json. | +| [ApprovedPackagesItem](./rush-lib.approvedpackagesitem.md) | An item returned by ApprovedPackagesConfiguration | +| [ApprovedPackagesPolicy](./rush-lib.approvedpackagespolicy.md) | This is a helper object for RushConfiguration. It exposes the "approvedPackagesPolicy" feature from rush.json. | +| [ChangeManager](./rush-lib.changemanager.md) | A class that helps with programatically interacting with Rush's change files. | +| [CommonVersionsConfiguration](./rush-lib.commonversionsconfiguration.md) | Use this class to load and save the "common/config/rush/common-versions.json" config file. This config file stores dependency version information that affects all projects in the repo. | +| [EventHooks](./rush-lib.eventhooks.md) | (BETA) This class represents Rush event hooks configured for this repo. Hooks are customized script actions that Rush executes when specific events occur. The actions are expressed as a command-line that is executed using the operating system shell. | +| [IndividualVersionPolicy](./rush-lib.individualversionpolicy.md) | (BETA) This policy indicates all related projects get version bump driven by their own changes. | +| [LockStepVersionPolicy](./rush-lib.lockstepversionpolicy.md) | (BETA) This policy indicates all related projects should use the same version. | +| [PackageJsonDependency](./rush-lib.packagejsondependency.md) | (BETA) | +| [PackageJsonEditor](./rush-lib.packagejsoneditor.md) | (BETA) | +| [PackageManager](./rush-lib.packagemanager.md) | (BETA) An abstraction for controlling the supported package managers: PNPM, NPM, and Yarn. | +| [PnpmOptionsConfiguration](./rush-lib.pnpmoptionsconfiguration.md) | Options that are only used when the PNPM package manager is selected. | +| [Rush](./rush-lib.rush.md) | General operations for the Rush engine. | +| [RushConfiguration](./rush-lib.rushconfiguration.md) | This represents the Rush configuration for a repository, based on the "rush.json" configuration file. | +| [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) | This represents the configuration of a project that is built by Rush, based on the Rush.json configuration file. | +| [VersionPolicy](./rush-lib.versionpolicy.md) | (BETA) This is the base class for version policy which controls how versions get bumped. | +| [VersionPolicyConfiguration](./rush-lib.versionpolicyconfiguration.md) | (BETA) Use this class to load and save the "common/config/rush/version-policies.json" config file. This config file configures how different groups of projects will be published by Rush, and how their version numbers will be determined. | +| [YarnOptionsConfiguration](./rush-lib.yarnoptionsconfiguration.md) | Options that are only used when the yarn package manager is selected. | + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [BumpType](./rush-lib.bumptype.md) | (BETA) Type of version bumps | +| [DependencyType](./rush-lib.dependencytype.md) | (BETA) | +| [EnvironmentVariableNames](./rush-lib.environmentvariablenames.md) | Names of environment variables used by Rush. | +| [Event](./rush-lib.event.md) | (BETA) Events happen during Rush runs. | +| [VersionPolicyDefinitionName](./rush-lib.versionpolicydefinitionname.md) | (BETA) Version policy base type names | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [ILaunchOptions](./rush-lib.ilaunchoptions.md) | Options to pass to the rush "launch" functions. | +| [ITryFindRushJsonLocationOptions](./rush-lib.itryfindrushjsonlocationoptions.md) | Options for RushConfiguration.tryFindRushJsonLocation. | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [PackageManagerName](./rush-lib.packagemanagername.md) | This represents the available Package Manager tools as a string | +| [ResolutionStrategy](./rush-lib.resolutionstrategy.md) | This represents the available PNPM resolution strategies as a string | + diff --git a/pages/api/rush-lib.packagejsondependency._constructor_.md b/pages/api/rush-lib.packagejsondependency._constructor_.md new file mode 100644 index 000000000..e1c112ffe --- /dev/null +++ b/pages/api/rush-lib.packagejsondependency._constructor_.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonDependency](./rush-lib.packagejsondependency.md) > [(constructor)](./rush-lib.packagejsondependency._constructor_.md) + +## PackageJsonDependency.(constructor) + +> 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. +> + +Constructs a new instance of the `PackageJsonDependency` class + +Signature: + +```typescript +constructor(name: string, version: string, type: DependencyType, onChange: () => void); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| version | string | | +| type | DependencyType | | +| onChange | () => void | | + diff --git a/pages/api/rush-lib.packagejsondependency.dependencytype.md b/pages/api/rush-lib.packagejsondependency.dependencytype.md new file mode 100644 index 000000000..dca526d5b --- /dev/null +++ b/pages/api/rush-lib.packagejsondependency.dependencytype.md @@ -0,0 +1,19 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonDependency](./rush-lib.packagejsondependency.md) > [dependencyType](./rush-lib.packagejsondependency.dependencytype.md) + +## PackageJsonDependency.dependencyType 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. +> + +Signature: + +```typescript +readonly dependencyType: DependencyType; +``` diff --git a/pages/api/rush-lib.packagejsondependency.md b/pages/api/rush-lib.packagejsondependency.md new file mode 100644 index 000000000..7af2a540a --- /dev/null +++ b/pages/api/rush-lib.packagejsondependency.md @@ -0,0 +1,41 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonDependency](./rush-lib.packagejsondependency.md) + +## PackageJsonDependency class + +> 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. +> + + +Signature: + +```typescript +export declare class PackageJsonDependency +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(name, version, type, onChange)](./rush-lib.packagejsondependency._constructor_.md) | | (BETA) Constructs a new instance of the PackageJsonDependency class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [dependencyType](./rush-lib.packagejsondependency.dependencytype.md) | | DependencyType | (BETA) | +| [name](./rush-lib.packagejsondependency.name.md) | | string | (BETA) | +| [version](./rush-lib.packagejsondependency.version.md) | | string | (BETA) | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [setVersion(newVersion)](./rush-lib.packagejsondependency.setversion.md) | | (BETA) | + diff --git a/pages/api/rush-lib.packagejsondependency.name.md b/pages/api/rush-lib.packagejsondependency.name.md new file mode 100644 index 000000000..8e1eac2a3 --- /dev/null +++ b/pages/api/rush-lib.packagejsondependency.name.md @@ -0,0 +1,19 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonDependency](./rush-lib.packagejsondependency.md) > [name](./rush-lib.packagejsondependency.name.md) + +## PackageJsonDependency.name 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. +> + +Signature: + +```typescript +readonly name: string; +``` diff --git a/pages/api/rush-lib.packagejsondependency.setversion.md b/pages/api/rush-lib.packagejsondependency.setversion.md new file mode 100644 index 000000000..7fd2feae2 --- /dev/null +++ b/pages/api/rush-lib.packagejsondependency.setversion.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonDependency](./rush-lib.packagejsondependency.md) > [setVersion](./rush-lib.packagejsondependency.setversion.md) + +## PackageJsonDependency.setVersion() method + +> 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. +> + +Signature: + +```typescript +setVersion(newVersion: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| newVersion | string | | + +Returns: + +`void` + diff --git a/pages/api/rush-lib.packagejsondependency.version.md b/pages/api/rush-lib.packagejsondependency.version.md new file mode 100644 index 000000000..da1750992 --- /dev/null +++ b/pages/api/rush-lib.packagejsondependency.version.md @@ -0,0 +1,19 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonDependency](./rush-lib.packagejsondependency.md) > [version](./rush-lib.packagejsondependency.version.md) + +## PackageJsonDependency.version 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. +> + +Signature: + +```typescript +readonly version: string; +``` diff --git a/pages/api/rush-lib.packagejsoneditor.addorupdatedependency.md b/pages/api/rush-lib.packagejsoneditor.addorupdatedependency.md new file mode 100644 index 000000000..55e2a3bd5 --- /dev/null +++ b/pages/api/rush-lib.packagejsoneditor.addorupdatedependency.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonEditor](./rush-lib.packagejsoneditor.md) > [addOrUpdateDependency](./rush-lib.packagejsoneditor.addorupdatedependency.md) + +## PackageJsonEditor.addOrUpdateDependency() method + +> 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. +> + +Signature: + +```typescript +addOrUpdateDependency(packageName: string, newVersion: string, dependencyType: DependencyType): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| packageName | string | | +| newVersion | string | | +| dependencyType | DependencyType | | + +Returns: + +`void` + diff --git a/pages/api/rush-lib.packagejsoneditor.dependencylist.md b/pages/api/rush-lib.packagejsoneditor.dependencylist.md new file mode 100644 index 000000000..7a640c703 --- /dev/null +++ b/pages/api/rush-lib.packagejsoneditor.dependencylist.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonEditor](./rush-lib.packagejsoneditor.md) > [dependencyList](./rush-lib.packagejsoneditor.dependencylist.md) + +## PackageJsonEditor.dependencyList 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. +> + +The list of dependencies of type DependencyType.Regular, DependencyType.Optional, or DependencyType.Peer. + +Signature: + +```typescript +readonly dependencyList: ReadonlyArray; +``` diff --git a/pages/api/rush-lib.packagejsoneditor.devdependencylist.md b/pages/api/rush-lib.packagejsoneditor.devdependencylist.md new file mode 100644 index 000000000..ce5d57f4d --- /dev/null +++ b/pages/api/rush-lib.packagejsoneditor.devdependencylist.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonEditor](./rush-lib.packagejsoneditor.md) > [devDependencyList](./rush-lib.packagejsoneditor.devdependencylist.md) + +## PackageJsonEditor.devDependencyList 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. +> + +The list of dependencies of type DependencyType.Dev. + +Signature: + +```typescript +readonly devDependencyList: ReadonlyArray; +``` diff --git a/pages/api/rush-lib.packagejsoneditor.filepath.md b/pages/api/rush-lib.packagejsoneditor.filepath.md new file mode 100644 index 000000000..c04027872 --- /dev/null +++ b/pages/api/rush-lib.packagejsoneditor.filepath.md @@ -0,0 +1,19 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonEditor](./rush-lib.packagejsoneditor.md) > [filePath](./rush-lib.packagejsoneditor.filepath.md) + +## PackageJsonEditor.filePath 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. +> + +Signature: + +```typescript +readonly filePath: string; +``` diff --git a/pages/api/rush-lib.packagejsoneditor.fromobject.md b/pages/api/rush-lib.packagejsoneditor.fromobject.md new file mode 100644 index 000000000..bfa5ed296 --- /dev/null +++ b/pages/api/rush-lib.packagejsoneditor.fromobject.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonEditor](./rush-lib.packagejsoneditor.md) > [fromObject](./rush-lib.packagejsoneditor.fromobject.md) + +## PackageJsonEditor.fromObject() method + +> 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. +> + +Signature: + +```typescript +static fromObject(object: IPackageJson, filename: string): PackageJsonEditor; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| object | IPackageJson | | +| filename | string | | + +Returns: + +`PackageJsonEditor` + diff --git a/pages/api/rush-lib.packagejsoneditor.load.md b/pages/api/rush-lib.packagejsoneditor.load.md new file mode 100644 index 000000000..9ea6e66ec --- /dev/null +++ b/pages/api/rush-lib.packagejsoneditor.load.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonEditor](./rush-lib.packagejsoneditor.md) > [load](./rush-lib.packagejsoneditor.load.md) + +## PackageJsonEditor.load() method + +> 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. +> + +Signature: + +```typescript +static load(filePath: string): PackageJsonEditor; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filePath | string | | + +Returns: + +`PackageJsonEditor` + diff --git a/pages/api/rush-lib.packagejsoneditor.md b/pages/api/rush-lib.packagejsoneditor.md new file mode 100644 index 000000000..57e7ded03 --- /dev/null +++ b/pages/api/rush-lib.packagejsoneditor.md @@ -0,0 +1,42 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonEditor](./rush-lib.packagejsoneditor.md) + +## PackageJsonEditor class + +> 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. +> + + +Signature: + +```typescript +export declare class PackageJsonEditor +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [dependencyList](./rush-lib.packagejsoneditor.dependencylist.md) | | ReadonlyArray<PackageJsonDependency> | (BETA) The list of dependencies of type DependencyType.Regular, DependencyType.Optional, or DependencyType.Peer. | +| [devDependencyList](./rush-lib.packagejsoneditor.devdependencylist.md) | | ReadonlyArray<PackageJsonDependency> | (BETA) The list of dependencies of type DependencyType.Dev. | +| [filePath](./rush-lib.packagejsoneditor.filepath.md) | | string | (BETA) | +| [name](./rush-lib.packagejsoneditor.name.md) | | string | (BETA) | +| [version](./rush-lib.packagejsoneditor.version.md) | | string | (BETA) | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [addOrUpdateDependency(packageName, newVersion, dependencyType)](./rush-lib.packagejsoneditor.addorupdatedependency.md) | | (BETA) | +| [fromObject(object, filename)](./rush-lib.packagejsoneditor.fromobject.md) | static | (BETA) | +| [load(filePath)](./rush-lib.packagejsoneditor.load.md) | static | (BETA) | +| [saveIfModified()](./rush-lib.packagejsoneditor.saveifmodified.md) | | (BETA) | +| [tryGetDependency(packageName)](./rush-lib.packagejsoneditor.trygetdependency.md) | | (BETA) | +| [tryGetDevDependency(packageName)](./rush-lib.packagejsoneditor.trygetdevdependency.md) | | (BETA) | + diff --git a/pages/api/rush-lib.packagejsoneditor.name.md b/pages/api/rush-lib.packagejsoneditor.name.md new file mode 100644 index 000000000..a5ab54138 --- /dev/null +++ b/pages/api/rush-lib.packagejsoneditor.name.md @@ -0,0 +1,19 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonEditor](./rush-lib.packagejsoneditor.md) > [name](./rush-lib.packagejsoneditor.name.md) + +## PackageJsonEditor.name 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. +> + +Signature: + +```typescript +readonly name: string; +``` diff --git a/pages/api/rush-lib.packagejsoneditor.saveifmodified.md b/pages/api/rush-lib.packagejsoneditor.saveifmodified.md new file mode 100644 index 000000000..adda6961a --- /dev/null +++ b/pages/api/rush-lib.packagejsoneditor.saveifmodified.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonEditor](./rush-lib.packagejsoneditor.md) > [saveIfModified](./rush-lib.packagejsoneditor.saveifmodified.md) + +## PackageJsonEditor.saveIfModified() method + +> 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. +> + +Signature: + +```typescript +saveIfModified(): boolean; +``` +Returns: + +`boolean` + diff --git a/pages/api/rush-lib.packagejsoneditor.trygetdependency.md b/pages/api/rush-lib.packagejsoneditor.trygetdependency.md new file mode 100644 index 000000000..257a1ee2b --- /dev/null +++ b/pages/api/rush-lib.packagejsoneditor.trygetdependency.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonEditor](./rush-lib.packagejsoneditor.md) > [tryGetDependency](./rush-lib.packagejsoneditor.trygetdependency.md) + +## PackageJsonEditor.tryGetDependency() method + +> 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. +> + +Signature: + +```typescript +tryGetDependency(packageName: string): PackageJsonDependency | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| packageName | string | | + +Returns: + +`PackageJsonDependency | undefined` + diff --git a/pages/api/rush-lib.packagejsoneditor.trygetdevdependency.md b/pages/api/rush-lib.packagejsoneditor.trygetdevdependency.md new file mode 100644 index 000000000..dc673cdf3 --- /dev/null +++ b/pages/api/rush-lib.packagejsoneditor.trygetdevdependency.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonEditor](./rush-lib.packagejsoneditor.md) > [tryGetDevDependency](./rush-lib.packagejsoneditor.trygetdevdependency.md) + +## PackageJsonEditor.tryGetDevDependency() method + +> 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. +> + +Signature: + +```typescript +tryGetDevDependency(packageName: string): PackageJsonDependency | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| packageName | string | | + +Returns: + +`PackageJsonDependency | undefined` + diff --git a/pages/api/rush-lib.packagejsoneditor.version.md b/pages/api/rush-lib.packagejsoneditor.version.md new file mode 100644 index 000000000..a75957915 --- /dev/null +++ b/pages/api/rush-lib.packagejsoneditor.version.md @@ -0,0 +1,19 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageJsonEditor](./rush-lib.packagejsoneditor.md) > [version](./rush-lib.packagejsoneditor.version.md) + +## PackageJsonEditor.version 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. +> + +Signature: + +```typescript +readonly version: string; +``` diff --git a/pages/api/rush-lib.packagemanager._shrinkwrapfilename.md b/pages/api/rush-lib.packagemanager._shrinkwrapfilename.md new file mode 100644 index 000000000..7f2b55dc3 --- /dev/null +++ b/pages/api/rush-lib.packagemanager._shrinkwrapfilename.md @@ -0,0 +1,19 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageManager](./rush-lib.packagemanager.md) > [\_shrinkwrapFilename](./rush-lib.packagemanager._shrinkwrapfilename.md) + +## PackageManager.\_shrinkwrapFilename 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. +> + +Signature: + +```typescript +protected _shrinkwrapFilename: string; +``` diff --git a/pages/api/rush-lib.packagemanager.md b/pages/api/rush-lib.packagemanager.md new file mode 100644 index 000000000..35f7e06a3 --- /dev/null +++ b/pages/api/rush-lib.packagemanager.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageManager](./rush-lib.packagemanager.md) + +## PackageManager class + +> 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. +> + +An abstraction for controlling the supported package managers: PNPM, NPM, and Yarn. + +Signature: + +```typescript +export declare abstract class PackageManager +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_shrinkwrapFilename](./rush-lib.packagemanager._shrinkwrapfilename.md) | | string | (BETA) | +| [packageManager](./rush-lib.packagemanager.packagemanager.md) | | PackageManagerName | (BETA) The package manager. | +| [shrinkwrapFilename](./rush-lib.packagemanager.shrinkwrapfilename.md) | | string | (BETA) The filename of the shrinkwrap file that is used by the package manager. | +| [version](./rush-lib.packagemanager.version.md) | | string | (BETA) The SemVer version of the package manager. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PackageManager` class. + diff --git a/pages/api/rush-lib.packagemanager.packagemanager.md b/pages/api/rush-lib.packagemanager.packagemanager.md new file mode 100644 index 000000000..e00570606 --- /dev/null +++ b/pages/api/rush-lib.packagemanager.packagemanager.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageManager](./rush-lib.packagemanager.md) > [packageManager](./rush-lib.packagemanager.packagemanager.md) + +## PackageManager.packageManager 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. +> + +The package manager. + +Signature: + +```typescript +readonly packageManager: PackageManagerName; +``` diff --git a/pages/api/rush-lib.packagemanager.shrinkwrapfilename.md b/pages/api/rush-lib.packagemanager.shrinkwrapfilename.md new file mode 100644 index 000000000..07c47e4f0 --- /dev/null +++ b/pages/api/rush-lib.packagemanager.shrinkwrapfilename.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageManager](./rush-lib.packagemanager.md) > [shrinkwrapFilename](./rush-lib.packagemanager.shrinkwrapfilename.md) + +## PackageManager.shrinkwrapFilename 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. +> + +The filename of the shrinkwrap file that is used by the package manager. + +Signature: + +```typescript +readonly shrinkwrapFilename: string; +``` + +## Remarks + +Example: `npm-shrinkwrap.json` or `pnpm-lock.yaml` + diff --git a/pages/api/rush-lib.packagemanager.version.md b/pages/api/rush-lib.packagemanager.version.md new file mode 100644 index 000000000..a33b6be63 --- /dev/null +++ b/pages/api/rush-lib.packagemanager.version.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageManager](./rush-lib.packagemanager.md) > [version](./rush-lib.packagemanager.version.md) + +## PackageManager.version 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. +> + +The SemVer version of the package manager. + +Signature: + +```typescript +readonly version: string; +``` diff --git a/pages/api/rush-lib.packagemanagername.md b/pages/api/rush-lib.packagemanagername.md new file mode 100644 index 000000000..0538fdcc4 --- /dev/null +++ b/pages/api/rush-lib.packagemanagername.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PackageManagerName](./rush-lib.packagemanagername.md) + +## PackageManagerName type + +This represents the available Package Manager tools as a string + +Signature: + +```typescript +export declare type PackageManagerName = 'pnpm' | 'npm' | 'yarn'; +``` diff --git a/pages/api/rush-lib.pnpmoptionsconfiguration.md b/pages/api/rush-lib.pnpmoptionsconfiguration.md new file mode 100644 index 000000000..be8e31a1b --- /dev/null +++ b/pages/api/rush-lib.pnpmoptionsconfiguration.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PnpmOptionsConfiguration](./rush-lib.pnpmoptionsconfiguration.md) + +## PnpmOptionsConfiguration class + +Options that are only used when the PNPM package manager is selected. + +Signature: + +```typescript +export declare class PnpmOptionsConfiguration +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [resolutionStrategy](./rush-lib.pnpmoptionsconfiguration.resolutionstrategy.md) | | ResolutionStrategy | 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. | + +## Remarks + +It is valid to define these options in rush.json even if the PNPM package manager is not being used. + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PnpmOptionsConfiguration` class. + diff --git a/pages/api/rush-lib.pnpmoptionsconfiguration.resolutionstrategy.md b/pages/api/rush-lib.pnpmoptionsconfiguration.resolutionstrategy.md new file mode 100644 index 000000000..662dc5983 --- /dev/null +++ b/pages/api/rush-lib.pnpmoptionsconfiguration.resolutionstrategy.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[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. + +Signature: + +```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) + diff --git a/pages/api/rush-lib.pnpmoptionsconfiguration.strictpeerdependencies.md b/pages/api/rush-lib.pnpmoptionsconfiguration.strictpeerdependencies.md new file mode 100644 index 000000000..da0accde1 --- /dev/null +++ b/pages/api/rush-lib.pnpmoptionsconfiguration.strictpeerdependencies.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [PnpmOptionsConfiguration](./rush-lib.pnpmoptionsconfiguration.md) > [strictPeerDependencies](./rush-lib.pnpmoptionsconfiguration.strictpeerdependencies.md) + +## PnpmOptionsConfiguration.strictPeerDependencies property + +If true, then Rush will add the "--strict-peer-dependencies" option when invoking PNPM. + +Signature: + +```typescript +readonly strictPeerDependencies: boolean; +``` + +## Remarks + +This causes "rush install" to fail if there are unsatisfied peer dependencies, which is an invalid state that can cause build failures or incompatible dependency versions. (For historical reasons, JavaScript package managers generally do not treat this invalid state as an error.) + +The default value is false. (For now.) + diff --git a/pages/api/rush-lib.resolutionstrategy.md b/pages/api/rush-lib.resolutionstrategy.md new file mode 100644 index 000000000..81a9b8f54 --- /dev/null +++ b/pages/api/rush-lib.resolutionstrategy.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[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 + +Signature: + +```typescript +export declare type ResolutionStrategy = 'fewer-dependencies' | 'fast'; +``` diff --git a/pages/api/rush-lib.rush.launch.md b/pages/api/rush-lib.rush.launch.md new file mode 100644 index 000000000..ed1e35fa6 --- /dev/null +++ b/pages/api/rush-lib.rush.launch.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [Rush](./rush-lib.rush.md) > [launch](./rush-lib.rush.launch.md) + +## Rush.launch() method + +This API is used by the `@microsoft/rush` front end to launch the "rush" command-line. Third-party tools should not use this API. Instead, they should execute the "rush" binary and start a new Node.js process. + +Signature: + +```typescript +static launch(launcherVersion: string, arg: ILaunchOptions): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| launcherVersion | string | The version of the @microsoft/rush wrapper used to call invoke the CLI. | +| arg | ILaunchOptions | | + +Returns: + +`void` + +## Remarks + +Earlier versions of the rush frontend used a different API contract. In the old contract, the second argument was the `isManaged` value of the object. + +Even though this API isn't documented, it is still supported for legacy compatibility. + diff --git a/pages/api/rush-lib.rush.launchrushx.md b/pages/api/rush-lib.rush.launchrushx.md new file mode 100644 index 000000000..a9ba71077 --- /dev/null +++ b/pages/api/rush-lib.rush.launchrushx.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [Rush](./rush-lib.rush.md) > [launchRushX](./rush-lib.rush.launchrushx.md) + +## Rush.launchRushX() method + +This API is used by the `@microsoft/rush` front end to launch the "rushx" command-line. Third-party tools should not use this API. Instead, they should execute the "rushx" binary and start a new Node.js process. + +Signature: + +```typescript +static launchRushX(launcherVersion: string, options: ILaunchOptions): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| launcherVersion | string | The version of the @microsoft/rush wrapper used to call invoke the CLI. | +| options | ILaunchOptions | | + +Returns: + +`void` + diff --git a/pages/api/rush-lib.rush.md b/pages/api/rush-lib.rush.md new file mode 100644 index 000000000..db1120f12 --- /dev/null +++ b/pages/api/rush-lib.rush.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [Rush](./rush-lib.rush.md) + +## Rush class + +General operations for the Rush engine. + +Signature: + +```typescript +export declare class Rush +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [version](./rush-lib.rush.version.md) | static | string | The currently executing version of the "rush-lib" library. This is the same as the Rush tool version for that release. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [launch(launcherVersion, arg)](./rush-lib.rush.launch.md) | static | This API is used by the @microsoft/rush front end to launch the "rush" command-line. Third-party tools should not use this API. Instead, they should execute the "rush" binary and start a new Node.js process. | +| [launchRushX(launcherVersion, options)](./rush-lib.rush.launchrushx.md) | static | This API is used by the @microsoft/rush front end to launch the "rushx" command-line. Third-party tools should not use this API. Instead, they should execute the "rushx" binary and start a new Node.js process. | + diff --git a/pages/api/rush-lib.rush.version.md b/pages/api/rush-lib.rush.version.md new file mode 100644 index 000000000..d8a584e65 --- /dev/null +++ b/pages/api/rush-lib.rush.version.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [Rush](./rush-lib.rush.md) > [version](./rush-lib.rush.version.md) + +## Rush.version property + +The currently executing version of the "rush-lib" library. This is the same as the Rush tool version for that release. + +Signature: + +```typescript +static readonly version: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.approvedpackagespolicy.md b/pages/api/rush-lib.rushconfiguration.approvedpackagespolicy.md new file mode 100644 index 000000000..d050e944e --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.approvedpackagespolicy.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [approvedPackagesPolicy](./rush-lib.rushconfiguration.approvedpackagespolicy.md) + +## RushConfiguration.approvedPackagesPolicy property + +The "approvedPackagesPolicy" settings. + +Signature: + +```typescript +readonly approvedPackagesPolicy: ApprovedPackagesPolicy; +``` diff --git a/pages/api/rush-lib.rushconfiguration.changesfolder.md b/pages/api/rush-lib.rushconfiguration.changesfolder.md new file mode 100644 index 000000000..8738bc917 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.changesfolder.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [changesFolder](./rush-lib.rushconfiguration.changesfolder.md) + +## RushConfiguration.changesFolder property + +The folder that contains all change files. + +Signature: + +```typescript +readonly changesFolder: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.committedshrinkwrapfilename.md b/pages/api/rush-lib.rushconfiguration.committedshrinkwrapfilename.md new file mode 100644 index 000000000..8b32e513c --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.committedshrinkwrapfilename.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [committedShrinkwrapFilename](./rush-lib.rushconfiguration.committedshrinkwrapfilename.md) + +## RushConfiguration.committedShrinkwrapFilename property + +> Warning: This API is now obsolete. +> +> Use `getCommittedShrinkwrapFilename` instead, which gets the correct common shrinkwrap file name for a given active variant. +> + +The full path of the shrinkwrap file that is tracked by Git. (The "rush install" command uses a temporary copy, whose path is tempShrinkwrapFilename.) + +Signature: + +```typescript +readonly committedShrinkwrapFilename: string; +``` + +## Remarks + +This property merely reports the filename; the file itself may not actually exist. Example: `C:\MyRepo\common\npm-shrinkwrap.json` or `C:\MyRepo\common\pnpm-lock.yaml` + diff --git a/pages/api/rush-lib.rushconfiguration.commonfolder.md b/pages/api/rush-lib.rushconfiguration.commonfolder.md new file mode 100644 index 000000000..4fea4d23e --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.commonfolder.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [commonFolder](./rush-lib.rushconfiguration.commonfolder.md) + +## RushConfiguration.commonFolder property + +The fully resolved path for the "common" folder where Rush will store settings that affect all Rush projects. This is always a subfolder of the folder containing "rush.json". Example: `C:\MyRepo\common` + +Signature: + +```typescript +readonly commonFolder: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.commonrushconfigfolder.md b/pages/api/rush-lib.rushconfiguration.commonrushconfigfolder.md new file mode 100644 index 000000000..0ffdd33fc --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.commonrushconfigfolder.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [commonRushConfigFolder](./rush-lib.rushconfiguration.commonrushconfigfolder.md) + +## RushConfiguration.commonRushConfigFolder property + +The folder where Rush's additional config files are stored. This folder is always a subfolder called `config\rush` inside the common folder. (The `common\config` folder is reserved for configuration files used by other tools.) To avoid confusion or mistakes, Rush will report an error if this this folder contains any unrecognized files. + +Example: `C:\MyRepo\common\config\rush` + +Signature: + +```typescript +readonly commonRushConfigFolder: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.commonscriptsfolder.md b/pages/api/rush-lib.rushconfiguration.commonscriptsfolder.md new file mode 100644 index 000000000..209b532f8 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.commonscriptsfolder.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [commonScriptsFolder](./rush-lib.rushconfiguration.commonscriptsfolder.md) + +## RushConfiguration.commonScriptsFolder property + +The folder where automation scripts are stored. This is always a subfolder called "scripts" under the common folder. Example: `C:\MyRepo\common\scripts` + +Signature: + +```typescript +readonly commonScriptsFolder: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.commontempfolder.md b/pages/api/rush-lib.rushconfiguration.commontempfolder.md new file mode 100644 index 000000000..11bdf57a1 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.commontempfolder.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [commonTempFolder](./rush-lib.rushconfiguration.commontempfolder.md) + +## RushConfiguration.commonTempFolder property + +The folder where temporary files will be stored. This is always a subfolder called "temp" under the common folder. Example: `C:\MyRepo\common\temp` + +Signature: + +```typescript +readonly commonTempFolder: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.commonversions.md b/pages/api/rush-lib.rushconfiguration.commonversions.md new file mode 100644 index 000000000..e6d2df5c8 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.commonversions.md @@ -0,0 +1,28 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [commonVersions](./rush-lib.rushconfiguration.commonversions.md) + +## RushConfiguration.commonVersions property + +> Warning: This API is now obsolete. +> +> Use `getCommonVersions` instead, which gets the correct common version data for a given active variant. +> + +Settings from the common-versions.json config file. + +Signature: + +```typescript +readonly commonVersions: CommonVersionsConfiguration; +``` + +## Remarks + +If the common-versions.json file is missing, this property will not be undefined. Instead it will be initialized in an empty state, and calling CommonVersionsConfiguration.save() will create the file. + diff --git a/pages/api/rush-lib.rushconfiguration.currentinstalledvariant.md b/pages/api/rush-lib.rushconfiguration.currentinstalledvariant.md new file mode 100644 index 000000000..9e4a93984 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.currentinstalledvariant.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [currentInstalledVariant](./rush-lib.rushconfiguration.currentinstalledvariant.md) + +## RushConfiguration.currentInstalledVariant property + +Gets the currently-installed variant, if an installation has occurred. For Rush operations which do not take a --variant parameter, this method determines which variant, if any, was last specified when performing "rush install" or "rush update". + +Signature: + +```typescript +readonly currentInstalledVariant: string | undefined; +``` diff --git a/pages/api/rush-lib.rushconfiguration.currentvariantjsonfilename.md b/pages/api/rush-lib.rushconfiguration.currentvariantjsonfilename.md new file mode 100644 index 000000000..619726499 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.currentvariantjsonfilename.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [currentVariantJsonFilename](./rush-lib.rushconfiguration.currentvariantjsonfilename.md) + +## RushConfiguration.currentVariantJsonFilename property + +The filename of the variant dependency data file. By default this is called 'current-variant.json' resides in the Rush common folder. Its data structure is defined by ICurrentVariantJson. + +Example: `C:\MyRepo\common\temp\current-variant.json` + +Signature: + +```typescript +readonly currentVariantJsonFilename: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.ensureconsistentversions.md b/pages/api/rush-lib.rushconfiguration.ensureconsistentversions.md new file mode 100644 index 000000000..d00006551 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.ensureconsistentversions.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [ensureConsistentVersions](./rush-lib.rushconfiguration.ensureconsistentversions.md) + +## RushConfiguration.ensureConsistentVersions property + +If true, then consistent version specifiers for dependencies will be enforced. I.e. "rush check" is run before some commands. + +Signature: + +```typescript +readonly ensureConsistentVersions: boolean; +``` diff --git a/pages/api/rush-lib.rushconfiguration.eventhooks.md b/pages/api/rush-lib.rushconfiguration.eventhooks.md new file mode 100644 index 000000000..1a9705201 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.eventhooks.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [eventHooks](./rush-lib.rushconfiguration.eventhooks.md) + +## RushConfiguration.eventHooks 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. +> + +The rush hooks. It allows customized scripts to run at the specified point. + +Signature: + +```typescript +readonly eventHooks: EventHooks; +``` diff --git a/pages/api/rush-lib.rushconfiguration.findprojectbyshorthandname.md b/pages/api/rush-lib.rushconfiguration.findprojectbyshorthandname.md new file mode 100644 index 000000000..1f8438c4b --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.findprojectbyshorthandname.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [findProjectByShorthandName](./rush-lib.rushconfiguration.findprojectbyshorthandname.md) + +## RushConfiguration.findProjectByShorthandName() method + +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 `@something/example`. If exactly one project matches this heuristic, it is returned. Otherwise, undefined is returned. + +Signature: + +```typescript +findProjectByShorthandName(shorthandProjectName: string): RushConfigurationProject | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| shorthandProjectName | string | | + +Returns: + +`RushConfigurationProject | undefined` + diff --git a/pages/api/rush-lib.rushconfiguration.findprojectbytempname.md b/pages/api/rush-lib.rushconfiguration.findprojectbytempname.md new file mode 100644 index 000000000..38df454c4 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.findprojectbytempname.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [findProjectByTempName](./rush-lib.rushconfiguration.findprojectbytempname.md) + +## RushConfiguration.findProjectByTempName() method + +Looks up a project by its RushConfigurationProject.tempProjectName field. + +Signature: + +```typescript +findProjectByTempName(tempProjectName: string): RushConfigurationProject | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| tempProjectName | string | | + +Returns: + +`RushConfigurationProject | undefined` + +The found project, or undefined if no match was found. + diff --git a/pages/api/rush-lib.rushconfiguration.getcommittedshrinkwrapfilename.md b/pages/api/rush-lib.rushconfiguration.getcommittedshrinkwrapfilename.md new file mode 100644 index 000000000..cc9677147 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.getcommittedshrinkwrapfilename.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [getCommittedShrinkwrapFilename](./rush-lib.rushconfiguration.getcommittedshrinkwrapfilename.md) + +## RushConfiguration.getCommittedShrinkwrapFilename() method + +Gets the committed shrinkwrap file name for a specific variant. + +Signature: + +```typescript +getCommittedShrinkwrapFilename(variant?: string | undefined): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| variant | string | undefined | The name of the current variant in use by the active command. | + +Returns: + +`string` + diff --git a/pages/api/rush-lib.rushconfiguration.getcommonversions.md b/pages/api/rush-lib.rushconfiguration.getcommonversions.md new file mode 100644 index 000000000..78af13b1f --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.getcommonversions.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [getCommonVersions](./rush-lib.rushconfiguration.getcommonversions.md) + +## RushConfiguration.getCommonVersions() method + +Gets the settings from the common-versions.json config file for a specific variant. + +Signature: + +```typescript +getCommonVersions(variant?: string | undefined): CommonVersionsConfiguration; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| variant | string | undefined | The name of the current variant in use by the active command. | + +Returns: + +`CommonVersionsConfiguration` + diff --git a/pages/api/rush-lib.rushconfiguration.getcommonversionsfilepath.md b/pages/api/rush-lib.rushconfiguration.getcommonversionsfilepath.md new file mode 100644 index 000000000..d84b91a69 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.getcommonversionsfilepath.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [getCommonVersionsFilePath](./rush-lib.rushconfiguration.getcommonversionsfilepath.md) + +## RushConfiguration.getCommonVersionsFilePath() method + +Gets the path to the common-versions.json config file for a specific variant. + +Signature: + +```typescript +getCommonVersionsFilePath(variant?: string | undefined): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| variant | string | undefined | The name of the current variant in use by the active command. | + +Returns: + +`string` + diff --git a/pages/api/rush-lib.rushconfiguration.getpnpmfilepath.md b/pages/api/rush-lib.rushconfiguration.getpnpmfilepath.md new file mode 100644 index 000000000..5769cbb95 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.getpnpmfilepath.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [getPnpmfilePath](./rush-lib.rushconfiguration.getpnpmfilepath.md) + +## RushConfiguration.getPnpmfilePath() method + +Gets the absolute path for "pnpmfile.js" for a specific variant. + +Signature: + +```typescript +getPnpmfilePath(variant?: string | undefined): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| variant | string | undefined | The name of the current variant in use by the active command. | + +Returns: + +`string` + +## Remarks + +The file path is returned even if PNPM is not configured as the package manager. + diff --git a/pages/api/rush-lib.rushconfiguration.getprojectbyname.md b/pages/api/rush-lib.rushconfiguration.getprojectbyname.md new file mode 100644 index 000000000..c06b6b979 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.getprojectbyname.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [getProjectByName](./rush-lib.rushconfiguration.getprojectbyname.md) + +## RushConfiguration.getProjectByName() method + +Looks up a project in the projectsByName map. If the project is not found, then undefined is returned. + +Signature: + +```typescript +getProjectByName(projectName: string): RushConfigurationProject | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| projectName | string | | + +Returns: + +`RushConfigurationProject | undefined` + diff --git a/pages/api/rush-lib.rushconfiguration.gitallowedemailregexps.md b/pages/api/rush-lib.rushconfiguration.gitallowedemailregexps.md new file mode 100644 index 000000000..afc2e3410 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.gitallowedemailregexps.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [gitAllowedEmailRegExps](./rush-lib.rushconfiguration.gitallowedemailregexps.md) + +## RushConfiguration.gitAllowedEmailRegExps property + +\[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: `".*@example\.com"` This array will never be undefined. + +Signature: + +```typescript +readonly gitAllowedEmailRegExps: string[]; +``` diff --git a/pages/api/rush-lib.rushconfiguration.gitsampleemail.md b/pages/api/rush-lib.rushconfiguration.gitsampleemail.md new file mode 100644 index 000000000..d6cfc70fb --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.gitsampleemail.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [gitSampleEmail](./rush-lib.rushconfiguration.gitsampleemail.md) + +## RushConfiguration.gitSampleEmail property + +\[Part of the "gitPolicy" feature.\] An example valid email address that conforms to one of the allowedEmailRegExps. Example: `"foxtrot@example\.com"` This will never be undefined, and will always be nonempty if gitAllowedEmailRegExps is used. + +Signature: + +```typescript +readonly gitSampleEmail: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.gitversionbumpcommitmessage.md b/pages/api/rush-lib.rushconfiguration.gitversionbumpcommitmessage.md new file mode 100644 index 000000000..86cb87425 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.gitversionbumpcommitmessage.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [gitVersionBumpCommitMessage](./rush-lib.rushconfiguration.gitversionbumpcommitmessage.md) + +## RushConfiguration.gitVersionBumpCommitMessage property + +\[Part of the "gitPolicy" feature.\] The commit message to use when committing changes during 'rush publish' + +Signature: + +```typescript +readonly gitVersionBumpCommitMessage: string | undefined; +``` diff --git a/pages/api/rush-lib.rushconfiguration.hotfixchangeenabled.md b/pages/api/rush-lib.rushconfiguration.hotfixchangeenabled.md new file mode 100644 index 000000000..d137118fd --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.hotfixchangeenabled.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [hotfixChangeEnabled](./rush-lib.rushconfiguration.hotfixchangeenabled.md) + +## RushConfiguration.hotfixChangeEnabled property + +\[Part of the "hotfixChange" feature.\] Enables creating hotfix changes + +Signature: + +```typescript +readonly hotfixChangeEnabled: boolean; +``` diff --git a/pages/api/rush-lib.rushconfiguration.loadfromconfigurationfile.md b/pages/api/rush-lib.rushconfiguration.loadfromconfigurationfile.md new file mode 100644 index 000000000..28a775ed7 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.loadfromconfigurationfile.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [loadFromConfigurationFile](./rush-lib.rushconfiguration.loadfromconfigurationfile.md) + +## RushConfiguration.loadFromConfigurationFile() method + +Loads the configuration data from an Rush.json configuration file and returns an RushConfiguration object. + +Signature: + +```typescript +static loadFromConfigurationFile(rushJsonFilename: string): RushConfiguration; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| rushJsonFilename | string | | + +Returns: + +`RushConfiguration` + diff --git a/pages/api/rush-lib.rushconfiguration.loadfromdefaultlocation.md b/pages/api/rush-lib.rushconfiguration.loadfromdefaultlocation.md new file mode 100644 index 000000000..e928a73b2 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.loadfromdefaultlocation.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [loadFromDefaultLocation](./rush-lib.rushconfiguration.loadfromdefaultlocation.md) + +## RushConfiguration.loadFromDefaultLocation() method + +Signature: + +```typescript +static loadFromDefaultLocation(options?: ITryFindRushJsonLocationOptions): RushConfiguration; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | ITryFindRushJsonLocationOptions | | + +Returns: + +`RushConfiguration` + diff --git a/pages/api/rush-lib.rushconfiguration.md b/pages/api/rush-lib.rushconfiguration.md new file mode 100644 index 000000000..85044ae8a --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.md @@ -0,0 +1,81 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) + +## RushConfiguration class + +This represents the Rush configuration for a repository, based on the "rush.json" configuration file. + +Signature: + +```typescript +export declare class RushConfiguration +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [approvedPackagesPolicy](./rush-lib.rushconfiguration.approvedpackagespolicy.md) | | ApprovedPackagesPolicy | The "approvedPackagesPolicy" settings. | +| [changesFolder](./rush-lib.rushconfiguration.changesfolder.md) | | string | The folder that contains all change files. | +| [committedShrinkwrapFilename](./rush-lib.rushconfiguration.committedshrinkwrapfilename.md) | | string | The full path of the shrinkwrap file that is tracked by Git. (The "rush install" command uses a temporary copy, whose path is tempShrinkwrapFilename.) | +| [commonFolder](./rush-lib.rushconfiguration.commonfolder.md) | | string | The fully resolved path for the "common" folder where Rush will store settings that affect all Rush projects. This is always a subfolder of the folder containing "rush.json". Example: C:\MyRepo\common | +| [commonRushConfigFolder](./rush-lib.rushconfiguration.commonrushconfigfolder.md) | | string | The folder where Rush's additional config files are stored. This folder is always a subfolder called config\rush inside the common folder. (The common\config folder is reserved for configuration files used by other tools.) To avoid confusion or mistakes, Rush will report an error if this this folder contains any unrecognized files.Example: C:\MyRepo\common\config\rush | +| [commonScriptsFolder](./rush-lib.rushconfiguration.commonscriptsfolder.md) | | string | The folder where automation scripts are stored. This is always a subfolder called "scripts" under the common folder. Example: C:\MyRepo\common\scripts | +| [commonTempFolder](./rush-lib.rushconfiguration.commontempfolder.md) | | string | The folder where temporary files will be stored. This is always a subfolder called "temp" under the common folder. Example: C:\MyRepo\common\temp | +| [commonVersions](./rush-lib.rushconfiguration.commonversions.md) | | CommonVersionsConfiguration | Settings from the common-versions.json config file. | +| [currentInstalledVariant](./rush-lib.rushconfiguration.currentinstalledvariant.md) | | string | undefined | Gets the currently-installed variant, if an installation has occurred. For Rush operations which do not take a --variant parameter, this method determines which variant, if any, was last specified when performing "rush install" or "rush update". | +| [currentVariantJsonFilename](./rush-lib.rushconfiguration.currentvariantjsonfilename.md) | | string | The filename of the variant dependency data file. By default this is called 'current-variant.json' resides in the Rush common folder. Its data structure is defined by ICurrentVariantJson.Example: C:\MyRepo\common\temp\current-variant.json | +| [ensureConsistentVersions](./rush-lib.rushconfiguration.ensureconsistentversions.md) | | boolean | If true, then consistent version specifiers for dependencies will be enforced. I.e. "rush check" is run before some commands. | +| [eventHooks](./rush-lib.rushconfiguration.eventhooks.md) | | EventHooks | (BETA) The rush hooks. It allows customized scripts to run at the specified point. | +| [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: ".*@example\.com" This array will never be undefined. | +| [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: "foxtrot@example\.com" 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 | +| [npmCacheFolder](./rush-lib.rushconfiguration.npmcachefolder.md) | | string | The local folder that will store the NPM package cache. Rush does not rely on the npm's default global cache folder, because npm's caching implementation does not reliably handle multiple processes. (For example, if a build box is running "rush install" simultaneously for two different working folders, it may fail randomly.)Example: C:\MyRepo\common\temp\npm-cache | +| [npmTmpFolder](./rush-lib.rushconfiguration.npmtmpfolder.md) | | string | The local folder where npm's temporary files will be written during installation. Rush does not rely on the global default folder, because it may be on a different hard disk.Example: C:\MyRepo\common\temp\npm-tmp | +| [packageManager](./rush-lib.rushconfiguration.packagemanager.md) | | PackageManagerName | The name of the package manager being used to install dependencies | +| [packageManagerToolFilename](./rush-lib.rushconfiguration.packagemanagertoolfilename.md) | | string | The absolute path to the locally installed NPM tool. If "rush install" has not been run, then this file may not exist yet. Example: C:\MyRepo\common\temp\npm-local\node_modules\.bin\npm | +| [packageManagerToolVersion](./rush-lib.rushconfiguration.packagemanagertoolversion.md) | | string | The version of the locally installed NPM tool. (Example: "1.2.3") | +| [packageManagerWrapper](./rush-lib.rushconfiguration.packagemanagerwrapper.md) | | PackageManager | (BETA) An abstraction for controlling the supported package managers: PNPM, NPM, and Yarn. | +| [pnpmOptions](./rush-lib.rushconfiguration.pnpmoptions.md) | | PnpmOptionsConfiguration | Options that are only used when the PNPM package manager is selected. | +| [pnpmStoreFolder](./rush-lib.rushconfiguration.pnpmstorefolder.md) | | string | The local folder where PNPM stores a global installation for every installed packageExample: C:\MyRepo\common\temp\pnpm-store | +| [projectFolderMaxDepth](./rush-lib.rushconfiguration.projectfoldermaxdepth.md) | | number | The maximum allowable folder depth for the projectFolder field in the rush.json file. This setting provides a way for repository maintainers to discourage nesting of project folders that makes the directory tree more difficult to navigate. The default value is 2, which implements on a standard convention of //package.json. | +| [projectFolderMinDepth](./rush-lib.rushconfiguration.projectfoldermindepth.md) | | number | The minimum allowable folder depth for the projectFolder field in the rush.json file. This setting provides a way for repository maintainers to discourage nesting of project folders that makes the directory tree more difficult to navigate. The default value is 2, which implements a standard 2-level hierarchy of //package.json. | +| [projects](./rush-lib.rushconfiguration.projects.md) | | RushConfigurationProject[] | | +| [projectsByName](./rush-lib.rushconfiguration.projectsbyname.md) | | Map<string, RushConfigurationProject> | | +| [repositoryUrl](./rush-lib.rushconfiguration.repositoryurl.md) | | string | The remote url of the repository. This helps "rush change" find the right remote to compare against. | +| [rushJsonFile](./rush-lib.rushconfiguration.rushjsonfile.md) | | string | The absolute path to the "rush.json" configuration file that was loaded to construct this object. | +| [rushJsonFolder](./rush-lib.rushconfiguration.rushjsonfolder.md) | | string | The absolute path of the folder that contains rush.json for this project. | +| [rushLinkJsonFilename](./rush-lib.rushconfiguration.rushlinkjsonfilename.md) | | string | The filename of the build dependency data file. By default this is called 'rush-link.json' resides in the Rush common folder. Its data structure is defined by IRushLinkJson.Example: C:\MyRepo\common\temp\rush-link.json | +| [shrinkwrapFilename](./rush-lib.rushconfiguration.shrinkwrapfilename.md) | | string | The filename (without any path) of the shrinkwrap file that is used by the package manager. | +| [shrinkwrapFilePhrase](./rush-lib.rushconfiguration.shrinkwrapfilephrase.md) | | string | Returns an English phrase such as "shrinkwrap file" that can be used in logging messages to refer to the shrinkwrap file using appropriate terminology for the currently selected package manager. | +| [suppressNodeLtsWarning](./rush-lib.rushconfiguration.suppressnodeltswarning.md) | | boolean | Odd-numbered major versions of Node.js are experimental. Even-numbered releases spend six months in a stabilization period before the first Long Term Support (LTS) version. For example, 8.9.0 was the first LTS version of Node.js 8. Pre-LTS versions are not recommended for production usage because they frequently have bugs. They may cause Rush itself to malfunction.Rush normally prints a warning if it detects a pre-LTS Node.js version. If you are testing pre-LTS versions in preparation for supporting the first LTS version, you can use this setting to disable Rush's warning. | +| [telemetryEnabled](./rush-lib.rushconfiguration.telemetryenabled.md) | | boolean | (BETA) Indicates whether telemetry collection is enabled for Rush runs. | +| [tempShrinkwrapFilename](./rush-lib.rushconfiguration.tempshrinkwrapfilename.md) | | string | The full path of the temporary shrinkwrap file that is used during "rush install". This file may get rewritten by the package manager during installation. | +| [tempShrinkwrapPreinstallFilename](./rush-lib.rushconfiguration.tempshrinkwrappreinstallfilename.md) | | string | The full path of a backup copy of tempShrinkwrapFilename. This backup copy is made before installation begins, and can be compared to determine how the package manager modified tempShrinkwrapFilename. | +| [versionPolicyConfiguration](./rush-lib.rushconfiguration.versionpolicyconfiguration.md) | | VersionPolicyConfiguration | (BETA) | +| [yarnCacheFolder](./rush-lib.rushconfiguration.yarncachefolder.md) | | string | The local folder that will store the Yarn package cache.Example: C:\MyRepo\common\temp\yarn-cache | +| [yarnOptions](./rush-lib.rushconfiguration.yarnoptions.md) | | YarnOptionsConfiguration | Options that are only used when the yarn package manager is selected. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [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 @something/example. 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. | +| [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. | +| [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. | +| [loadFromConfigurationFile(rushJsonFilename)](./rush-lib.rushconfiguration.loadfromconfigurationfile.md) | static | Loads the configuration data from an Rush.json configuration file and returns an RushConfiguration object. | +| [loadFromDefaultLocation(options)](./rush-lib.rushconfiguration.loadfromdefaultlocation.md) | static | | +| [tryFindRushJsonLocation(options)](./rush-lib.rushconfiguration.tryfindrushjsonlocation.md) | static | Find the rush.json location and return the path, or undefined if a rush.json can't be found. | +| [tryGetProjectForPath(currentFolderPath)](./rush-lib.rushconfiguration.trygetprojectforpath.md) | | Returns the project for which the specified path is underneath that project's folder. If the path is not under any project's folder, returns undefined. | + diff --git a/pages/api/rush-lib.rushconfiguration.npmcachefolder.md b/pages/api/rush-lib.rushconfiguration.npmcachefolder.md new file mode 100644 index 000000000..e023b1550 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.npmcachefolder.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [npmCacheFolder](./rush-lib.rushconfiguration.npmcachefolder.md) + +## RushConfiguration.npmCacheFolder property + +The local folder that will store the NPM package cache. Rush does not rely on the npm's default global cache folder, because npm's caching implementation does not reliably handle multiple processes. (For example, if a build box is running "rush install" simultaneously for two different working folders, it may fail randomly.) + +Example: `C:\MyRepo\common\temp\npm-cache` + +Signature: + +```typescript +readonly npmCacheFolder: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.npmtmpfolder.md b/pages/api/rush-lib.rushconfiguration.npmtmpfolder.md new file mode 100644 index 000000000..fc4c58f2c --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.npmtmpfolder.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [npmTmpFolder](./rush-lib.rushconfiguration.npmtmpfolder.md) + +## RushConfiguration.npmTmpFolder property + +The local folder where npm's temporary files will be written during installation. Rush does not rely on the global default folder, because it may be on a different hard disk. + +Example: `C:\MyRepo\common\temp\npm-tmp` + +Signature: + +```typescript +readonly npmTmpFolder: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.packagemanager.md b/pages/api/rush-lib.rushconfiguration.packagemanager.md new file mode 100644 index 000000000..57d6a760c --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.packagemanager.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [packageManager](./rush-lib.rushconfiguration.packagemanager.md) + +## RushConfiguration.packageManager property + +The name of the package manager being used to install dependencies + +Signature: + +```typescript +readonly packageManager: PackageManagerName; +``` diff --git a/pages/api/rush-lib.rushconfiguration.packagemanagertoolfilename.md b/pages/api/rush-lib.rushconfiguration.packagemanagertoolfilename.md new file mode 100644 index 000000000..f46422707 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.packagemanagertoolfilename.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [packageManagerToolFilename](./rush-lib.rushconfiguration.packagemanagertoolfilename.md) + +## RushConfiguration.packageManagerToolFilename property + +The absolute path to the locally installed NPM tool. If "rush install" has not been run, then this file may not exist yet. Example: `C:\MyRepo\common\temp\npm-local\node_modules\.bin\npm` + +Signature: + +```typescript +readonly packageManagerToolFilename: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.packagemanagertoolversion.md b/pages/api/rush-lib.rushconfiguration.packagemanagertoolversion.md new file mode 100644 index 000000000..2057a1995 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.packagemanagertoolversion.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [packageManagerToolVersion](./rush-lib.rushconfiguration.packagemanagertoolversion.md) + +## RushConfiguration.packageManagerToolVersion property + +The version of the locally installed NPM tool. (Example: "1.2.3") + +Signature: + +```typescript +readonly packageManagerToolVersion: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.packagemanagerwrapper.md b/pages/api/rush-lib.rushconfiguration.packagemanagerwrapper.md new file mode 100644 index 000000000..e7bb1f0ff --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.packagemanagerwrapper.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [packageManagerWrapper](./rush-lib.rushconfiguration.packagemanagerwrapper.md) + +## RushConfiguration.packageManagerWrapper 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. +> + +An abstraction for controlling the supported package managers: PNPM, NPM, and Yarn. + +Signature: + +```typescript +readonly packageManagerWrapper: PackageManager; +``` + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PackageManager` class. + diff --git a/pages/api/rush-lib.rushconfiguration.pnpmoptions.md b/pages/api/rush-lib.rushconfiguration.pnpmoptions.md new file mode 100644 index 000000000..d38b743b3 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.pnpmoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [pnpmOptions](./rush-lib.rushconfiguration.pnpmoptions.md) + +## RushConfiguration.pnpmOptions property + +Options that are only used when the PNPM package manager is selected. + +Signature: + +```typescript +readonly pnpmOptions: PnpmOptionsConfiguration; +``` + +## Remarks + +It is valid to define these options in rush.json even if the PNPM package manager is not being used. + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `PnpmOptionsConfiguration` class. + diff --git a/pages/api/rush-lib.rushconfiguration.pnpmstorefolder.md b/pages/api/rush-lib.rushconfiguration.pnpmstorefolder.md new file mode 100644 index 000000000..ce696c867 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.pnpmstorefolder.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [pnpmStoreFolder](./rush-lib.rushconfiguration.pnpmstorefolder.md) + +## RushConfiguration.pnpmStoreFolder property + +The local folder where PNPM stores a global installation for every installed package + +Example: `C:\MyRepo\common\temp\pnpm-store` + +Signature: + +```typescript +readonly pnpmStoreFolder: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.projectfoldermaxdepth.md b/pages/api/rush-lib.rushconfiguration.projectfoldermaxdepth.md new file mode 100644 index 000000000..d8a454dbb --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.projectfoldermaxdepth.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [projectFolderMaxDepth](./rush-lib.rushconfiguration.projectfoldermaxdepth.md) + +## RushConfiguration.projectFolderMaxDepth property + +The maximum allowable folder depth for the projectFolder field in the rush.json file. This setting provides a way for repository maintainers to discourage nesting of project folders that makes the directory tree more difficult to navigate. The default value is 2, which implements on a standard convention of //package.json. + +Signature: + +```typescript +readonly projectFolderMaxDepth: number; +``` diff --git a/pages/api/rush-lib.rushconfiguration.projectfoldermindepth.md b/pages/api/rush-lib.rushconfiguration.projectfoldermindepth.md new file mode 100644 index 000000000..3e5d069e2 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.projectfoldermindepth.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [projectFolderMinDepth](./rush-lib.rushconfiguration.projectfoldermindepth.md) + +## RushConfiguration.projectFolderMinDepth property + +The minimum allowable folder depth for the projectFolder field in the rush.json file. This setting provides a way for repository maintainers to discourage nesting of project folders that makes the directory tree more difficult to navigate. The default value is 2, which implements a standard 2-level hierarchy of //package.json. + +Signature: + +```typescript +readonly projectFolderMinDepth: number; +``` diff --git a/pages/api/rush-lib.rushconfiguration.projects.md b/pages/api/rush-lib.rushconfiguration.projects.md new file mode 100644 index 000000000..6951690b7 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.projects.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [projects](./rush-lib.rushconfiguration.projects.md) + +## RushConfiguration.projects property + +Signature: + +```typescript +readonly projects: RushConfigurationProject[]; +``` diff --git a/pages/api/rush-lib.rushconfiguration.projectsbyname.md b/pages/api/rush-lib.rushconfiguration.projectsbyname.md new file mode 100644 index 000000000..14e0f8e46 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.projectsbyname.md @@ -0,0 +1,16 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [projectsByName](./rush-lib.rushconfiguration.projectsbyname.md) + +## RushConfiguration.projectsByName property + +Signature: + +```typescript +readonly projectsByName: Map; +``` diff --git a/pages/api/rush-lib.rushconfiguration.repositoryurl.md b/pages/api/rush-lib.rushconfiguration.repositoryurl.md new file mode 100644 index 000000000..4d92b7d3a --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.repositoryurl.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [repositoryUrl](./rush-lib.rushconfiguration.repositoryurl.md) + +## RushConfiguration.repositoryUrl property + +The remote url of the repository. This helps "rush change" find the right remote to compare against. + +Signature: + +```typescript +readonly repositoryUrl: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.rushjsonfile.md b/pages/api/rush-lib.rushconfiguration.rushjsonfile.md new file mode 100644 index 000000000..c17e08014 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.rushjsonfile.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [rushJsonFile](./rush-lib.rushconfiguration.rushjsonfile.md) + +## RushConfiguration.rushJsonFile property + +The absolute path to the "rush.json" configuration file that was loaded to construct this object. + +Signature: + +```typescript +readonly rushJsonFile: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.rushjsonfolder.md b/pages/api/rush-lib.rushconfiguration.rushjsonfolder.md new file mode 100644 index 000000000..1b6e99a2f --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.rushjsonfolder.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [rushJsonFolder](./rush-lib.rushconfiguration.rushjsonfolder.md) + +## RushConfiguration.rushJsonFolder property + +The absolute path of the folder that contains rush.json for this project. + +Signature: + +```typescript +readonly rushJsonFolder: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.rushlinkjsonfilename.md b/pages/api/rush-lib.rushconfiguration.rushlinkjsonfilename.md new file mode 100644 index 000000000..ebb66c1b9 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.rushlinkjsonfilename.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [rushLinkJsonFilename](./rush-lib.rushconfiguration.rushlinkjsonfilename.md) + +## RushConfiguration.rushLinkJsonFilename property + +The filename of the build dependency data file. By default this is called 'rush-link.json' resides in the Rush common folder. Its data structure is defined by IRushLinkJson. + +Example: `C:\MyRepo\common\temp\rush-link.json` + +Signature: + +```typescript +readonly rushLinkJsonFilename: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.shrinkwrapfilename.md b/pages/api/rush-lib.rushconfiguration.shrinkwrapfilename.md new file mode 100644 index 000000000..a4b2a38c0 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.shrinkwrapfilename.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [shrinkwrapFilename](./rush-lib.rushconfiguration.shrinkwrapfilename.md) + +## RushConfiguration.shrinkwrapFilename property + +The filename (without any path) of the shrinkwrap file that is used by the package manager. + +Signature: + +```typescript +readonly shrinkwrapFilename: string; +``` + +## Remarks + +This property merely reports the filename; the file itself may not actually exist. Example: `npm-shrinkwrap.json` or `pnpm-lock.yaml` + diff --git a/pages/api/rush-lib.rushconfiguration.shrinkwrapfilephrase.md b/pages/api/rush-lib.rushconfiguration.shrinkwrapfilephrase.md new file mode 100644 index 000000000..5f4778e1a --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.shrinkwrapfilephrase.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [shrinkwrapFilePhrase](./rush-lib.rushconfiguration.shrinkwrapfilephrase.md) + +## RushConfiguration.shrinkwrapFilePhrase property + +Returns an English phrase such as "shrinkwrap file" that can be used in logging messages to refer to the shrinkwrap file using appropriate terminology for the currently selected package manager. + +Signature: + +```typescript +readonly shrinkwrapFilePhrase: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.suppressnodeltswarning.md b/pages/api/rush-lib.rushconfiguration.suppressnodeltswarning.md new file mode 100644 index 000000000..adaa14ca9 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.suppressnodeltswarning.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [suppressNodeLtsWarning](./rush-lib.rushconfiguration.suppressnodeltswarning.md) + +## RushConfiguration.suppressNodeLtsWarning property + +Odd-numbered major versions of Node.js are experimental. Even-numbered releases spend six months in a stabilization period before the first Long Term Support (LTS) version. For example, 8.9.0 was the first LTS version of Node.js 8. Pre-LTS versions are not recommended for production usage because they frequently have bugs. They may cause Rush itself to malfunction. + +Rush normally prints a warning if it detects a pre-LTS Node.js version. If you are testing pre-LTS versions in preparation for supporting the first LTS version, you can use this setting to disable Rush's warning. + +Signature: + +```typescript +readonly suppressNodeLtsWarning: boolean; +``` diff --git a/pages/api/rush-lib.rushconfiguration.telemetryenabled.md b/pages/api/rush-lib.rushconfiguration.telemetryenabled.md new file mode 100644 index 000000000..13523cc3e --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.telemetryenabled.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [telemetryEnabled](./rush-lib.rushconfiguration.telemetryenabled.md) + +## RushConfiguration.telemetryEnabled 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. +> + +Indicates whether telemetry collection is enabled for Rush runs. + +Signature: + +```typescript +readonly telemetryEnabled: boolean; +``` diff --git a/pages/api/rush-lib.rushconfiguration.tempshrinkwrapfilename.md b/pages/api/rush-lib.rushconfiguration.tempshrinkwrapfilename.md new file mode 100644 index 000000000..4377e7040 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.tempshrinkwrapfilename.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [tempShrinkwrapFilename](./rush-lib.rushconfiguration.tempshrinkwrapfilename.md) + +## RushConfiguration.tempShrinkwrapFilename property + +The full path of the temporary shrinkwrap file that is used during "rush install". This file may get rewritten by the package manager during installation. + +Signature: + +```typescript +readonly tempShrinkwrapFilename: string; +``` + +## Remarks + +This property merely reports the filename; the file itself may not actually exist. Example: `C:\MyRepo\common\temp\npm-shrinkwrap.json` or `C:\MyRepo\common\temp\pnpm-lock.yaml` + diff --git a/pages/api/rush-lib.rushconfiguration.tempshrinkwrappreinstallfilename.md b/pages/api/rush-lib.rushconfiguration.tempshrinkwrappreinstallfilename.md new file mode 100644 index 000000000..ef52caf6e --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.tempshrinkwrappreinstallfilename.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [tempShrinkwrapPreinstallFilename](./rush-lib.rushconfiguration.tempshrinkwrappreinstallfilename.md) + +## RushConfiguration.tempShrinkwrapPreinstallFilename property + +The full path of a backup copy of tempShrinkwrapFilename. This backup copy is made before installation begins, and can be compared to determine how the package manager modified tempShrinkwrapFilename. + +Signature: + +```typescript +readonly tempShrinkwrapPreinstallFilename: string; +``` + +## Remarks + +This property merely reports the filename; the file itself may not actually exist. Example: `C:\MyRepo\common\temp\npm-shrinkwrap-preinstall.json` or `C:\MyRepo\common\temp\pnpm-lock-preinstall.yaml` + diff --git a/pages/api/rush-lib.rushconfiguration.tryfindrushjsonlocation.md b/pages/api/rush-lib.rushconfiguration.tryfindrushjsonlocation.md new file mode 100644 index 000000000..bde94823a --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.tryfindrushjsonlocation.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [tryFindRushJsonLocation](./rush-lib.rushconfiguration.tryfindrushjsonlocation.md) + +## RushConfiguration.tryFindRushJsonLocation() method + +Find the rush.json location and return the path, or undefined if a rush.json can't be found. + +Signature: + +```typescript +static tryFindRushJsonLocation(options?: ITryFindRushJsonLocationOptions): string | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | ITryFindRushJsonLocationOptions | | + +Returns: + +`string | undefined` + diff --git a/pages/api/rush-lib.rushconfiguration.trygetprojectforpath.md b/pages/api/rush-lib.rushconfiguration.trygetprojectforpath.md new file mode 100644 index 000000000..a19da4f1b --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.trygetprojectforpath.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [tryGetProjectForPath](./rush-lib.rushconfiguration.trygetprojectforpath.md) + +## RushConfiguration.tryGetProjectForPath() method + +Returns the project for which the specified path is underneath that project's folder. If the path is not under any project's folder, returns undefined. + +Signature: + +```typescript +tryGetProjectForPath(currentFolderPath: string): RushConfigurationProject | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| currentFolderPath | string | | + +Returns: + +`RushConfigurationProject | undefined` + diff --git a/pages/api/rush-lib.rushconfiguration.versionpolicyconfiguration.md b/pages/api/rush-lib.rushconfiguration.versionpolicyconfiguration.md new file mode 100644 index 000000000..830fd1e25 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.versionpolicyconfiguration.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [versionPolicyConfiguration](./rush-lib.rushconfiguration.versionpolicyconfiguration.md) + +## RushConfiguration.versionPolicyConfiguration 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. +> + + +Signature: + +```typescript +readonly versionPolicyConfiguration: VersionPolicyConfiguration; +``` diff --git a/pages/api/rush-lib.rushconfiguration.yarncachefolder.md b/pages/api/rush-lib.rushconfiguration.yarncachefolder.md new file mode 100644 index 000000000..4abbb94b1 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.yarncachefolder.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [yarnCacheFolder](./rush-lib.rushconfiguration.yarncachefolder.md) + +## RushConfiguration.yarnCacheFolder property + +The local folder that will store the Yarn package cache. + +Example: `C:\MyRepo\common\temp\yarn-cache` + +Signature: + +```typescript +readonly yarnCacheFolder: string; +``` diff --git a/pages/api/rush-lib.rushconfiguration.yarnoptions.md b/pages/api/rush-lib.rushconfiguration.yarnoptions.md new file mode 100644 index 000000000..0370ea332 --- /dev/null +++ b/pages/api/rush-lib.rushconfiguration.yarnoptions.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfiguration](./rush-lib.rushconfiguration.md) > [yarnOptions](./rush-lib.rushconfiguration.yarnoptions.md) + +## RushConfiguration.yarnOptions property + +Options that are only used when the yarn package manager is selected. + +Signature: + +```typescript +readonly yarnOptions: YarnOptionsConfiguration; +``` + +## Remarks + +It is valid to define these options in rush.json even if the yarn package manager is not being used. + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `YarnOptionsConfiguration` class. + diff --git a/pages/api/rush-lib.rushconfigurationproject.cyclicdependencyprojects.md b/pages/api/rush-lib.rushconfigurationproject.cyclicdependencyprojects.md new file mode 100644 index 000000000..c56c08b67 --- /dev/null +++ b/pages/api/rush-lib.rushconfigurationproject.cyclicdependencyprojects.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) > [cyclicDependencyProjects](./rush-lib.rushconfigurationproject.cyclicdependencyprojects.md) + +## RushConfigurationProject.cyclicDependencyProjects property + +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(). + +Signature: + +```typescript +readonly cyclicDependencyProjects: Set; +``` diff --git a/pages/api/rush-lib.rushconfigurationproject.downstreamdependencyprojects.md b/pages/api/rush-lib.rushconfigurationproject.downstreamdependencyprojects.md new file mode 100644 index 000000000..80b060b15 --- /dev/null +++ b/pages/api/rush-lib.rushconfigurationproject.downstreamdependencyprojects.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) > [downstreamDependencyProjects](./rush-lib.rushconfigurationproject.downstreamdependencyprojects.md) + +## RushConfigurationProject.downstreamDependencyProjects property + +A list of projects within the Rush configuration which directly depend on this package. + +Signature: + +```typescript +readonly downstreamDependencyProjects: string[]; +``` diff --git a/pages/api/rush-lib.rushconfigurationproject.ismainproject.md b/pages/api/rush-lib.rushconfigurationproject.ismainproject.md new file mode 100644 index 000000000..6b99ddd1a --- /dev/null +++ b/pages/api/rush-lib.rushconfigurationproject.ismainproject.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) > [isMainProject](./rush-lib.rushconfigurationproject.ismainproject.md) + +## RushConfigurationProject.isMainProject 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. +> + +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. + +Signature: + +```typescript +readonly isMainProject: boolean; +``` diff --git a/pages/api/rush-lib.rushconfigurationproject.md b/pages/api/rush-lib.rushconfigurationproject.md new file mode 100644 index 000000000..a9dfb1b37 --- /dev/null +++ b/pages/api/rush-lib.rushconfigurationproject.md @@ -0,0 +1,43 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) + +## RushConfigurationProject class + +This represents the configuration of a project that is built by Rush, based on the Rush.json configuration file. + +Signature: + +```typescript +export declare class RushConfigurationProject +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [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. | +| [isMainProject](./rush-lib.rushconfigurationproject.ismainproject.md) | | boolean | (BETA) 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. | +| [packageJson](./rush-lib.rushconfigurationproject.packagejson.md) | | IPackageJson | The parsed NPM "package.json" file from projectFolder. | +| [packageJsonEditor](./rush-lib.rushconfigurationproject.packagejsoneditor.md) | | PackageJsonEditor | (BETA) 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: @scope/MyProject | +| [projectFolder](./rush-lib.rushconfigurationproject.projectfolder.md) | | string | The full path of the folder that contains the project to be built by Rush.Example: C:\MyRepo\libraries\my-project | +| [projectRelativeFolder](./rush-lib.rushconfigurationproject.projectrelativefolder.md) | | string | The relative path of the folder that contains the project to be built by Rush.Example: libraries\my-project | +| [reviewCategory](./rush-lib.rushconfigurationproject.reviewcategory.md) | | string | The review category name, or undefined if no category was assigned. This name must be one of the valid choices listed in RushConfiguration.reviewCategories. | +| [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 rush change, and whether or not it should be published during rush publish. | +| [skipRushCheck](./rush-lib.rushconfigurationproject.skiprushcheck.md) | | boolean | If true, then this project will be ignored by the "rush check" command. The default value is false. | +| [tempProjectName](./rush-lib.rushconfigurationproject.tempprojectname.md) | | string | The unique name for the temporary project that will be generated in the Common folder. For example, if the project name is @scope/MyProject, the temporary project name might be @rush-temp/MyProject-2.Example: @rush-temp/MyProject-2 | +| [unscopedTempProjectName](./rush-lib.rushconfigurationproject.unscopedtempprojectname.md) | | string | The unscoped temporary project nameExample: my-project-2 | +| [versionPolicy](./rush-lib.rushconfigurationproject.versionpolicy.md) | | VersionPolicy | undefined | (BETA) Version policy of the project | +| [versionPolicyName](./rush-lib.rushconfigurationproject.versionpolicyname.md) | | string | undefined | (BETA) Name of the version policy used by this project. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `RushConfigurationProject` class. + diff --git a/pages/api/rush-lib.rushconfigurationproject.packagejson.md b/pages/api/rush-lib.rushconfigurationproject.packagejson.md new file mode 100644 index 000000000..54cf92917 --- /dev/null +++ b/pages/api/rush-lib.rushconfigurationproject.packagejson.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) > [packageJson](./rush-lib.rushconfigurationproject.packagejson.md) + +## RushConfigurationProject.packageJson property + +> Warning: This API is now obsolete. +> +> Use packageJsonEditor instead +> + +The parsed NPM "package.json" file from projectFolder. + +Signature: + +```typescript +readonly packageJson: IPackageJson; +``` diff --git a/pages/api/rush-lib.rushconfigurationproject.packagejsoneditor.md b/pages/api/rush-lib.rushconfigurationproject.packagejsoneditor.md new file mode 100644 index 000000000..eeb9eba17 --- /dev/null +++ b/pages/api/rush-lib.rushconfigurationproject.packagejsoneditor.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) > [packageJsonEditor](./rush-lib.rushconfigurationproject.packagejsoneditor.md) + +## RushConfigurationProject.packageJsonEditor 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. +> + +A useful wrapper around the package.json file for making modifications + +Signature: + +```typescript +readonly packageJsonEditor: PackageJsonEditor; +``` diff --git a/pages/api/rush-lib.rushconfigurationproject.packagename.md b/pages/api/rush-lib.rushconfigurationproject.packagename.md new file mode 100644 index 000000000..a2c5e47e4 --- /dev/null +++ b/pages/api/rush-lib.rushconfigurationproject.packagename.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) > [packageName](./rush-lib.rushconfigurationproject.packagename.md) + +## RushConfigurationProject.packageName property + +The name of the NPM package. An error is reported if this name is not identical to packageJson.name. + +Example: `@scope/MyProject` + +Signature: + +```typescript +readonly packageName: string; +``` diff --git a/pages/api/rush-lib.rushconfigurationproject.projectfolder.md b/pages/api/rush-lib.rushconfigurationproject.projectfolder.md new file mode 100644 index 000000000..bb918fe68 --- /dev/null +++ b/pages/api/rush-lib.rushconfigurationproject.projectfolder.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) > [projectFolder](./rush-lib.rushconfigurationproject.projectfolder.md) + +## RushConfigurationProject.projectFolder property + +The full path of the folder that contains the project to be built by Rush. + +Example: `C:\MyRepo\libraries\my-project` + +Signature: + +```typescript +readonly projectFolder: string; +``` diff --git a/pages/api/rush-lib.rushconfigurationproject.projectrelativefolder.md b/pages/api/rush-lib.rushconfigurationproject.projectrelativefolder.md new file mode 100644 index 000000000..549be0542 --- /dev/null +++ b/pages/api/rush-lib.rushconfigurationproject.projectrelativefolder.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) > [projectRelativeFolder](./rush-lib.rushconfigurationproject.projectrelativefolder.md) + +## RushConfigurationProject.projectRelativeFolder property + +The relative path of the folder that contains the project to be built by Rush. + +Example: `libraries\my-project` + +Signature: + +```typescript +readonly projectRelativeFolder: string; +``` diff --git a/pages/api/rush-lib.rushconfigurationproject.reviewcategory.md b/pages/api/rush-lib.rushconfigurationproject.reviewcategory.md new file mode 100644 index 000000000..ee4bea015 --- /dev/null +++ b/pages/api/rush-lib.rushconfigurationproject.reviewcategory.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) > [reviewCategory](./rush-lib.rushconfigurationproject.reviewcategory.md) + +## RushConfigurationProject.reviewCategory property + +The review category name, or undefined if no category was assigned. This name must be one of the valid choices listed in RushConfiguration.reviewCategories. + +Signature: + +```typescript +readonly reviewCategory: string; +``` diff --git a/pages/api/rush-lib.rushconfigurationproject.shouldpublish.md b/pages/api/rush-lib.rushconfigurationproject.shouldpublish.md new file mode 100644 index 000000000..f8dde0625 --- /dev/null +++ b/pages/api/rush-lib.rushconfigurationproject.shouldpublish.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) > [shouldPublish](./rush-lib.rushconfigurationproject.shouldpublish.md) + +## RushConfigurationProject.shouldPublish property + +A flag which indicates whether changes to this project should be published. This controls whether or not the project would show up when running `rush change`, and whether or not it should be published during `rush publish`. + +Signature: + +```typescript +readonly shouldPublish: boolean; +``` diff --git a/pages/api/rush-lib.rushconfigurationproject.skiprushcheck.md b/pages/api/rush-lib.rushconfigurationproject.skiprushcheck.md new file mode 100644 index 000000000..dcc42398b --- /dev/null +++ b/pages/api/rush-lib.rushconfigurationproject.skiprushcheck.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) > [skipRushCheck](./rush-lib.rushconfigurationproject.skiprushcheck.md) + +## RushConfigurationProject.skipRushCheck property + +If true, then this project will be ignored by the "rush check" command. The default value is false. + +Signature: + +```typescript +readonly skipRushCheck: boolean; +``` diff --git a/pages/api/rush-lib.rushconfigurationproject.tempprojectname.md b/pages/api/rush-lib.rushconfigurationproject.tempprojectname.md new file mode 100644 index 000000000..5ffa02285 --- /dev/null +++ b/pages/api/rush-lib.rushconfigurationproject.tempprojectname.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) > [tempProjectName](./rush-lib.rushconfigurationproject.tempprojectname.md) + +## RushConfigurationProject.tempProjectName property + +The unique name for the temporary project that will be generated in the Common folder. For example, if the project name is `@scope/MyProject`, the temporary project name might be `@rush-temp/MyProject-2`. + +Example: `@rush-temp/MyProject-2` + +Signature: + +```typescript +readonly tempProjectName: string; +``` diff --git a/pages/api/rush-lib.rushconfigurationproject.unscopedtempprojectname.md b/pages/api/rush-lib.rushconfigurationproject.unscopedtempprojectname.md new file mode 100644 index 000000000..89773f071 --- /dev/null +++ b/pages/api/rush-lib.rushconfigurationproject.unscopedtempprojectname.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) > [unscopedTempProjectName](./rush-lib.rushconfigurationproject.unscopedtempprojectname.md) + +## RushConfigurationProject.unscopedTempProjectName property + +The unscoped temporary project name + +Example: `my-project-2` + +Signature: + +```typescript +readonly unscopedTempProjectName: string; +``` diff --git a/pages/api/rush-lib.rushconfigurationproject.versionpolicy.md b/pages/api/rush-lib.rushconfigurationproject.versionpolicy.md new file mode 100644 index 000000000..3c68273b7 --- /dev/null +++ b/pages/api/rush-lib.rushconfigurationproject.versionpolicy.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) > [versionPolicy](./rush-lib.rushconfigurationproject.versionpolicy.md) + +## RushConfigurationProject.versionPolicy 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. +> + +Version policy of the project + +Signature: + +```typescript +readonly versionPolicy: VersionPolicy | undefined; +``` diff --git a/pages/api/rush-lib.rushconfigurationproject.versionpolicyname.md b/pages/api/rush-lib.rushconfigurationproject.versionpolicyname.md new file mode 100644 index 000000000..39f869e48 --- /dev/null +++ b/pages/api/rush-lib.rushconfigurationproject.versionpolicyname.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [RushConfigurationProject](./rush-lib.rushconfigurationproject.md) > [versionPolicyName](./rush-lib.rushconfigurationproject.versionpolicyname.md) + +## RushConfigurationProject.versionPolicyName 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. +> + +Name of the version policy used by this project. + +Signature: + +```typescript +readonly versionPolicyName: string | undefined; +``` diff --git a/pages/api/rush-lib.versionpolicy.bump.md b/pages/api/rush-lib.versionpolicy.bump.md new file mode 100644 index 000000000..d200cca88 --- /dev/null +++ b/pages/api/rush-lib.versionpolicy.bump.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicy](./rush-lib.versionpolicy.md) > [bump](./rush-lib.versionpolicy.bump.md) + +## VersionPolicy.bump() method + +> 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. +> + +Bumps version based on the policy + +Signature: + +```typescript +abstract bump(bumpType?: BumpType, identifier?: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| bumpType | BumpType | (optional) override bump type | +| identifier | string | (optional) override prerelease Id | + +Returns: + +`void` + diff --git a/pages/api/rush-lib.versionpolicy.definitionname.md b/pages/api/rush-lib.versionpolicy.definitionname.md new file mode 100644 index 000000000..861386b34 --- /dev/null +++ b/pages/api/rush-lib.versionpolicy.definitionname.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicy](./rush-lib.versionpolicy.md) > [definitionName](./rush-lib.versionpolicy.definitionname.md) + +## VersionPolicy.definitionName 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. +> + +Version policy definition name + +Signature: + +```typescript +readonly definitionName: VersionPolicyDefinitionName; +``` diff --git a/pages/api/rush-lib.versionpolicy.ensure.md b/pages/api/rush-lib.versionpolicy.ensure.md new file mode 100644 index 000000000..79ee1d897 --- /dev/null +++ b/pages/api/rush-lib.versionpolicy.ensure.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicy](./rush-lib.versionpolicy.md) > [ensure](./rush-lib.versionpolicy.ensure.md) + +## VersionPolicy.ensure() method + +> 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. +> + +Returns an updated package json that satisfies the policy. + +Signature: + +```typescript +abstract ensure(project: IPackageJson, force?: boolean): IPackageJson | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| project | IPackageJson | package json | +| force | boolean | force update even when the project version is higher than the policy version. | + +Returns: + +`IPackageJson | undefined` + diff --git a/pages/api/rush-lib.versionpolicy.exemptfromrushchange.md b/pages/api/rush-lib.versionpolicy.exemptfromrushchange.md new file mode 100644 index 000000000..5684c7c32 --- /dev/null +++ b/pages/api/rush-lib.versionpolicy.exemptfromrushchange.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicy](./rush-lib.versionpolicy.md) > [exemptFromRushChange](./rush-lib.versionpolicy.exemptfromrushchange.md) + +## VersionPolicy.exemptFromRushChange 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. +> + +Determines if a version policy wants to opt out of changelog files. + +Signature: + +```typescript +readonly exemptFromRushChange: boolean; +``` diff --git a/pages/api/rush-lib.versionpolicy.islockstepped.md b/pages/api/rush-lib.versionpolicy.islockstepped.md new file mode 100644 index 000000000..912b06e72 --- /dev/null +++ b/pages/api/rush-lib.versionpolicy.islockstepped.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicy](./rush-lib.versionpolicy.md) > [isLockstepped](./rush-lib.versionpolicy.islockstepped.md) + +## VersionPolicy.isLockstepped 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. +> + +Whether it is a lockstepped version policy + +Signature: + +```typescript +readonly isLockstepped: boolean; +``` diff --git a/pages/api/rush-lib.versionpolicy.md b/pages/api/rush-lib.versionpolicy.md new file mode 100644 index 000000000..4f78967bc --- /dev/null +++ b/pages/api/rush-lib.versionpolicy.md @@ -0,0 +1,45 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicy](./rush-lib.versionpolicy.md) + +## VersionPolicy class + +> 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 is the base class for version policy which controls how versions get bumped. + +Signature: + +```typescript +export declare abstract class VersionPolicy +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [definitionName](./rush-lib.versionpolicy.definitionname.md) | | VersionPolicyDefinitionName | (BETA) Version policy definition name | +| [exemptFromRushChange](./rush-lib.versionpolicy.exemptfromrushchange.md) | | boolean | (BETA) Determines if a version policy wants to opt out of changelog files. | +| [isLockstepped](./rush-lib.versionpolicy.islockstepped.md) | | boolean | (BETA) Whether it is a lockstepped version policy | +| [policyName](./rush-lib.versionpolicy.policyname.md) | | string | (BETA) Version policy name | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [bump(bumpType, identifier)](./rush-lib.versionpolicy.bump.md) | | (BETA) Bumps version based on the policy | +| [ensure(project, force)](./rush-lib.versionpolicy.ensure.md) | | (BETA) Returns an updated package json that satisfies the policy. | +| [setDependenciesBeforeCommit(packageName, configuration)](./rush-lib.versionpolicy.setdependenciesbeforecommit.md) | | (BETA) Tells the version policy to modify any dependencies in the target package to values used for checked-in source. | +| [setDependenciesBeforePublish(packageName, configuration)](./rush-lib.versionpolicy.setdependenciesbeforepublish.md) | | (BETA) Tells the version policy to modify any dependencies in the target package to values used for publishing. | +| [validate(versionString, packageName)](./rush-lib.versionpolicy.validate.md) | | (BETA) Validates the specified version and throws if the version does not satisfy the policy. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `VersionPolicy` class. + diff --git a/pages/api/rush-lib.versionpolicy.policyname.md b/pages/api/rush-lib.versionpolicy.policyname.md new file mode 100644 index 000000000..def3f173f --- /dev/null +++ b/pages/api/rush-lib.versionpolicy.policyname.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicy](./rush-lib.versionpolicy.md) > [policyName](./rush-lib.versionpolicy.policyname.md) + +## VersionPolicy.policyName 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. +> + +Version policy name + +Signature: + +```typescript +readonly policyName: string; +``` diff --git a/pages/api/rush-lib.versionpolicy.setdependenciesbeforecommit.md b/pages/api/rush-lib.versionpolicy.setdependenciesbeforecommit.md new file mode 100644 index 000000000..7d4d1553b --- /dev/null +++ b/pages/api/rush-lib.versionpolicy.setdependenciesbeforecommit.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicy](./rush-lib.versionpolicy.md) > [setDependenciesBeforeCommit](./rush-lib.versionpolicy.setdependenciesbeforecommit.md) + +## VersionPolicy.setDependenciesBeforeCommit() method + +> 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. +> + +Tells the version policy to modify any dependencies in the target package to values used for checked-in source. + +Signature: + +```typescript +setDependenciesBeforeCommit(packageName: string, configuration: RushConfiguration): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| packageName | string | | +| configuration | RushConfiguration | | + +Returns: + +`void` + diff --git a/pages/api/rush-lib.versionpolicy.setdependenciesbeforepublish.md b/pages/api/rush-lib.versionpolicy.setdependenciesbeforepublish.md new file mode 100644 index 000000000..0cdd8ed7c --- /dev/null +++ b/pages/api/rush-lib.versionpolicy.setdependenciesbeforepublish.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicy](./rush-lib.versionpolicy.md) > [setDependenciesBeforePublish](./rush-lib.versionpolicy.setdependenciesbeforepublish.md) + +## VersionPolicy.setDependenciesBeforePublish() method + +> 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. +> + +Tells the version policy to modify any dependencies in the target package to values used for publishing. + +Signature: + +```typescript +setDependenciesBeforePublish(packageName: string, configuration: RushConfiguration): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| packageName | string | | +| configuration | RushConfiguration | | + +Returns: + +`void` + diff --git a/pages/api/rush-lib.versionpolicy.validate.md b/pages/api/rush-lib.versionpolicy.validate.md new file mode 100644 index 000000000..58fcf9c9c --- /dev/null +++ b/pages/api/rush-lib.versionpolicy.validate.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicy](./rush-lib.versionpolicy.md) > [validate](./rush-lib.versionpolicy.validate.md) + +## VersionPolicy.validate() method + +> 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. +> + +Validates the specified version and throws if the version does not satisfy the policy. + +Signature: + +```typescript +abstract validate(versionString: string, packageName: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| versionString | string | version string | +| packageName | string | package name | + +Returns: + +`void` + diff --git a/pages/api/rush-lib.versionpolicyconfiguration.bump.md b/pages/api/rush-lib.versionpolicyconfiguration.bump.md new file mode 100644 index 000000000..7627f005f --- /dev/null +++ b/pages/api/rush-lib.versionpolicyconfiguration.bump.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicyConfiguration](./rush-lib.versionpolicyconfiguration.md) > [bump](./rush-lib.versionpolicyconfiguration.bump.md) + +## VersionPolicyConfiguration.bump() method + +> 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. +> + +Bumps up versions for the specified version policy or all version policies + +Signature: + +```typescript +bump(versionPolicyName?: string, bumpType?: BumpType, identifier?: string, shouldCommit?: boolean): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| versionPolicyName | string | version policy name | +| bumpType | BumpType | bump type to override what policy has defined. | +| identifier | string | prerelease identifier to override what policy has defined. | +| shouldCommit | boolean | should save to disk | + +Returns: + +`void` + diff --git a/pages/api/rush-lib.versionpolicyconfiguration.getversionpolicy.md b/pages/api/rush-lib.versionpolicyconfiguration.getversionpolicy.md new file mode 100644 index 000000000..b58db9e50 --- /dev/null +++ b/pages/api/rush-lib.versionpolicyconfiguration.getversionpolicy.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicyConfiguration](./rush-lib.versionpolicyconfiguration.md) > [getVersionPolicy](./rush-lib.versionpolicyconfiguration.getversionpolicy.md) + +## VersionPolicyConfiguration.getVersionPolicy() method + +> 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. +> + +Gets the version policy by its name. Throws error if the version policy is not found. + +Signature: + +```typescript +getVersionPolicy(policyName: string): VersionPolicy; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| policyName | string | Name of the version policy | + +Returns: + +`VersionPolicy` + diff --git a/pages/api/rush-lib.versionpolicyconfiguration.md b/pages/api/rush-lib.versionpolicyconfiguration.md new file mode 100644 index 000000000..728fe00c7 --- /dev/null +++ b/pages/api/rush-lib.versionpolicyconfiguration.md @@ -0,0 +1,41 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicyConfiguration](./rush-lib.versionpolicyconfiguration.md) + +## VersionPolicyConfiguration class + +> 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. +> + +Use this class to load and save the "common/config/rush/version-policies.json" config file. This config file configures how different groups of projects will be published by Rush, and how their version numbers will be determined. + +Signature: + +```typescript +export declare class VersionPolicyConfiguration +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [versionPolicies](./rush-lib.versionpolicyconfiguration.versionpolicies.md) | | Map<string, VersionPolicy> | (BETA) Gets all the version policies | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [bump(versionPolicyName, bumpType, identifier, shouldCommit)](./rush-lib.versionpolicyconfiguration.bump.md) | | (BETA) Bumps up versions for the specified version policy or all version policies | +| [getVersionPolicy(policyName)](./rush-lib.versionpolicyconfiguration.getversionpolicy.md) | | (BETA) Gets the version policy by its name. Throws error if the version policy is not found. | +| [update(versionPolicyName, newVersion)](./rush-lib.versionpolicyconfiguration.update.md) | | (BETA) Updates the version directly for the specified version policy | +| [validate(projectsByName)](./rush-lib.versionpolicyconfiguration.validate.md) | | (BETA) Validate the version policy configuration against the rush config | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `VersionPolicyConfiguration` class. + diff --git a/pages/api/rush-lib.versionpolicyconfiguration.update.md b/pages/api/rush-lib.versionpolicyconfiguration.update.md new file mode 100644 index 000000000..a7d6c1467 --- /dev/null +++ b/pages/api/rush-lib.versionpolicyconfiguration.update.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicyConfiguration](./rush-lib.versionpolicyconfiguration.md) > [update](./rush-lib.versionpolicyconfiguration.update.md) + +## VersionPolicyConfiguration.update() method + +> 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. +> + +Updates the version directly for the specified version policy + +Signature: + +```typescript +update(versionPolicyName: string, newVersion: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| versionPolicyName | string | version policy name | +| newVersion | string | new version | + +Returns: + +`void` + diff --git a/pages/api/rush-lib.versionpolicyconfiguration.validate.md b/pages/api/rush-lib.versionpolicyconfiguration.validate.md new file mode 100644 index 000000000..9464c39f5 --- /dev/null +++ b/pages/api/rush-lib.versionpolicyconfiguration.validate.md @@ -0,0 +1,32 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicyConfiguration](./rush-lib.versionpolicyconfiguration.md) > [validate](./rush-lib.versionpolicyconfiguration.validate.md) + +## VersionPolicyConfiguration.validate() method + +> 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. +> + +Validate the version policy configuration against the rush config + +Signature: + +```typescript +validate(projectsByName: Map): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| projectsByName | Map<string, RushConfigurationProject> | | + +Returns: + +`void` + diff --git a/pages/api/rush-lib.versionpolicyconfiguration.versionpolicies.md b/pages/api/rush-lib.versionpolicyconfiguration.versionpolicies.md new file mode 100644 index 000000000..d153ccd55 --- /dev/null +++ b/pages/api/rush-lib.versionpolicyconfiguration.versionpolicies.md @@ -0,0 +1,21 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicyConfiguration](./rush-lib.versionpolicyconfiguration.md) > [versionPolicies](./rush-lib.versionpolicyconfiguration.versionpolicies.md) + +## VersionPolicyConfiguration.versionPolicies 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. +> + +Gets all the version policies + +Signature: + +```typescript +readonly versionPolicies: Map; +``` diff --git a/pages/api/rush-lib.versionpolicydefinitionname.md b/pages/api/rush-lib.versionpolicydefinitionname.md new file mode 100644 index 000000000..0ec51d883 --- /dev/null +++ b/pages/api/rush-lib.versionpolicydefinitionname.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [VersionPolicyDefinitionName](./rush-lib.versionpolicydefinitionname.md) + +## VersionPolicyDefinitionName enum + +> 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. +> + +Version policy base type names + +Signature: + +```typescript +export declare enum VersionPolicyDefinitionName +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| individualVersion | 1 | (BETA) | +| lockStepVersion | 0 | (BETA) | + diff --git a/pages/api/rush-lib.yarnoptionsconfiguration.ignoreengines.md b/pages/api/rush-lib.yarnoptionsconfiguration.ignoreengines.md new file mode 100644 index 000000000..35baceb27 --- /dev/null +++ b/pages/api/rush-lib.yarnoptionsconfiguration.ignoreengines.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [YarnOptionsConfiguration](./rush-lib.yarnoptionsconfiguration.md) > [ignoreEngines](./rush-lib.yarnoptionsconfiguration.ignoreengines.md) + +## YarnOptionsConfiguration.ignoreEngines property + +If true, then Rush will add the "--ignore-engines" option when invoking Yarn. This allows "rush install" to succeed if there are dependencies with engines defined in package.json which do not match the current environment. + +The default value is false. + +Signature: + +```typescript +readonly ignoreEngines: boolean; +``` diff --git a/pages/api/rush-lib.yarnoptionsconfiguration.md b/pages/api/rush-lib.yarnoptionsconfiguration.md new file mode 100644 index 000000000..4f3f3df70 --- /dev/null +++ b/pages/api/rush-lib.yarnoptionsconfiguration.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/rush-lib](./rush-lib.md) > [YarnOptionsConfiguration](./rush-lib.yarnoptionsconfiguration.md) + +## YarnOptionsConfiguration class + +Options that are only used when the yarn package manager is selected. + +Signature: + +```typescript +export declare class YarnOptionsConfiguration +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [ignoreEngines](./rush-lib.yarnoptionsconfiguration.ignoreengines.md) | | boolean | If true, then Rush will add the "--ignore-engines" option when invoking Yarn. This allows "rush install" to succeed if there are dependencies with engines defined in package.json which do not match the current environment.The default value is false. | + +## Remarks + +It is valid to define these options in rush.json even if the yarn package manager is not being used. + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `YarnOptionsConfiguration` class. + diff --git a/pages/api/stream-collator.interleaver.md b/pages/api/stream-collator.interleaver.md new file mode 100644 index 000000000..ec4c5b23c --- /dev/null +++ b/pages/api/stream-collator.interleaver.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/stream-collator](./stream-collator.md) > [Interleaver](./stream-collator.interleaver.md) + +## Interleaver class + +A static class which manages the output of multiple threads. + +Signature: + +```typescript +export declare class Interleaver +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [registerTask(taskName, quietMode)](./stream-collator.interleaver.registertask.md) | static | Registers a task into the list of active buffers and returns a ITaskWriter for the calling process to use to manage output. | +| [reset()](./stream-collator.interleaver.reset.md) | static | Removes information about all running tasks | +| [setStdOut(stdout)](./stream-collator.interleaver.setstdout.md) | static | Resets the default output stream | + diff --git a/pages/api/stream-collator.interleaver.registertask.md b/pages/api/stream-collator.interleaver.registertask.md new file mode 100644 index 000000000..bded5d275 --- /dev/null +++ b/pages/api/stream-collator.interleaver.registertask.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/stream-collator](./stream-collator.md) > [Interleaver](./stream-collator.interleaver.md) > [registerTask](./stream-collator.interleaver.registertask.md) + +## Interleaver.registerTask() method + +Registers a task into the list of active buffers and returns a ITaskWriter for the calling process to use to manage output. + +Signature: + +```typescript +static registerTask(taskName: string, quietMode?: boolean): ITaskWriter; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| taskName | string | | +| quietMode | boolean | | + +Returns: + +`ITaskWriter` + diff --git a/pages/api/stream-collator.interleaver.reset.md b/pages/api/stream-collator.interleaver.reset.md new file mode 100644 index 000000000..315257183 --- /dev/null +++ b/pages/api/stream-collator.interleaver.reset.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/stream-collator](./stream-collator.md) > [Interleaver](./stream-collator.interleaver.md) > [reset](./stream-collator.interleaver.reset.md) + +## Interleaver.reset() method + +Removes information about all running tasks + +Signature: + +```typescript +static reset(): void; +``` +Returns: + +`void` + diff --git a/pages/api/stream-collator.interleaver.setstdout.md b/pages/api/stream-collator.interleaver.setstdout.md new file mode 100644 index 000000000..58acd0327 --- /dev/null +++ b/pages/api/stream-collator.interleaver.setstdout.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/stream-collator](./stream-collator.md) > [Interleaver](./stream-collator.interleaver.md) > [setStdOut](./stream-collator.interleaver.setstdout.md) + +## Interleaver.setStdOut() method + +Resets the default output stream + +Signature: + +```typescript +static setStdOut(stdout: { + write: (text: string) => void; + }): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| stdout | {
write: (text: string) => void;
} | | + +Returns: + +`void` + diff --git a/pages/api/stream-collator.itaskwriter.close.md b/pages/api/stream-collator.itaskwriter.close.md new file mode 100644 index 000000000..9326b26c8 --- /dev/null +++ b/pages/api/stream-collator.itaskwriter.close.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/stream-collator](./stream-collator.md) > [ITaskWriter](./stream-collator.itaskwriter.md) > [close](./stream-collator.itaskwriter.close.md) + +## ITaskWriter.close() method + +Signature: + +```typescript +close(): void; +``` +Returns: + +`void` + diff --git a/pages/api/stream-collator.itaskwriter.getstderror.md b/pages/api/stream-collator.itaskwriter.getstderror.md new file mode 100644 index 000000000..36a414b88 --- /dev/null +++ b/pages/api/stream-collator.itaskwriter.getstderror.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/stream-collator](./stream-collator.md) > [ITaskWriter](./stream-collator.itaskwriter.md) > [getStdError](./stream-collator.itaskwriter.getstderror.md) + +## ITaskWriter.getStdError() method + +Signature: + +```typescript +getStdError(): string; +``` +Returns: + +`string` + diff --git a/pages/api/stream-collator.itaskwriter.getstdoutput.md b/pages/api/stream-collator.itaskwriter.getstdoutput.md new file mode 100644 index 000000000..9725afb84 --- /dev/null +++ b/pages/api/stream-collator.itaskwriter.getstdoutput.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/stream-collator](./stream-collator.md) > [ITaskWriter](./stream-collator.itaskwriter.md) > [getStdOutput](./stream-collator.itaskwriter.getstdoutput.md) + +## ITaskWriter.getStdOutput() method + +Signature: + +```typescript +getStdOutput(): string; +``` +Returns: + +`string` + diff --git a/pages/api/stream-collator.itaskwriter.md b/pages/api/stream-collator.itaskwriter.md new file mode 100644 index 000000000..5c0e17897 --- /dev/null +++ b/pages/api/stream-collator.itaskwriter.md @@ -0,0 +1,30 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/stream-collator](./stream-collator.md) > [ITaskWriter](./stream-collator.itaskwriter.md) + +## ITaskWriter interface + +An writable interface for managing output of simultaneous processes. + +Signature: + +```typescript +export interface ITaskWriter +``` + +## Methods + +| Method | Description | +| --- | --- | +| [close()](./stream-collator.itaskwriter.close.md) | | +| [getStdError()](./stream-collator.itaskwriter.getstderror.md) | | +| [getStdOutput()](./stream-collator.itaskwriter.getstdoutput.md) | | +| [write(data)](./stream-collator.itaskwriter.write.md) | | +| [writeError(data)](./stream-collator.itaskwriter.writeerror.md) | | +| [writeLine(data)](./stream-collator.itaskwriter.writeline.md) | | + diff --git a/pages/api/stream-collator.itaskwriter.write.md b/pages/api/stream-collator.itaskwriter.write.md new file mode 100644 index 000000000..2045f429f --- /dev/null +++ b/pages/api/stream-collator.itaskwriter.write.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/stream-collator](./stream-collator.md) > [ITaskWriter](./stream-collator.itaskwriter.md) > [write](./stream-collator.itaskwriter.write.md) + +## ITaskWriter.write() method + +Signature: + +```typescript +write(data: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| data | string | | + +Returns: + +`void` + diff --git a/pages/api/stream-collator.itaskwriter.writeerror.md b/pages/api/stream-collator.itaskwriter.writeerror.md new file mode 100644 index 000000000..1b7a98e57 --- /dev/null +++ b/pages/api/stream-collator.itaskwriter.writeerror.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/stream-collator](./stream-collator.md) > [ITaskWriter](./stream-collator.itaskwriter.md) > [writeError](./stream-collator.itaskwriter.writeerror.md) + +## ITaskWriter.writeError() method + +Signature: + +```typescript +writeError(data: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| data | string | | + +Returns: + +`void` + diff --git a/pages/api/stream-collator.itaskwriter.writeline.md b/pages/api/stream-collator.itaskwriter.writeline.md new file mode 100644 index 000000000..af1b9ee62 --- /dev/null +++ b/pages/api/stream-collator.itaskwriter.writeline.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/stream-collator](./stream-collator.md) > [ITaskWriter](./stream-collator.itaskwriter.md) > [writeLine](./stream-collator.itaskwriter.writeline.md) + +## ITaskWriter.writeLine() method + +Signature: + +```typescript +writeLine(data: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| data | string | | + +Returns: + +`void` + diff --git a/pages/api/stream-collator.md b/pages/api/stream-collator.md new file mode 100644 index 000000000..ef18715be --- /dev/null +++ b/pages/api/stream-collator.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/stream-collator](./stream-collator.md) + +## stream-collator package + +## Classes + +| Class | Description | +| --- | --- | +| [Interleaver](./stream-collator.interleaver.md) | A static class which manages the output of multiple threads. | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [ITaskWriter](./stream-collator.itaskwriter.md) | An writable interface for managing output of simultaneous processes. | + diff --git a/pages/api/ts-command-line.commandlineaction._constructor_.md b/pages/api/ts-command-line.commandlineaction._constructor_.md new file mode 100644 index 000000000..6ef73ff3c --- /dev/null +++ b/pages/api/ts-command-line.commandlineaction._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineAction](./ts-command-line.commandlineaction.md) > [(constructor)](./ts-command-line.commandlineaction._constructor_.md) + +## CommandLineAction.(constructor) + +Constructs a new instance of the `CommandLineAction` class + +Signature: + +```typescript +constructor(options: ICommandLineActionOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | ICommandLineActionOptions | | + diff --git a/pages/api/ts-command-line.commandlineaction.actionname.md b/pages/api/ts-command-line.commandlineaction.actionname.md new file mode 100644 index 000000000..97631b224 --- /dev/null +++ b/pages/api/ts-command-line.commandlineaction.actionname.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineAction](./ts-command-line.commandlineaction.md) > [actionName](./ts-command-line.commandlineaction.actionname.md) + +## CommandLineAction.actionName property + +The name of the action. For example, if the tool is called "example", then the "build" action might be invoked as: "example build -q --some-other-option" + +Signature: + +```typescript +readonly actionName: string; +``` diff --git a/pages/api/ts-command-line.commandlineaction.documentation.md b/pages/api/ts-command-line.commandlineaction.documentation.md new file mode 100644 index 000000000..772c4945b --- /dev/null +++ b/pages/api/ts-command-line.commandlineaction.documentation.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineAction](./ts-command-line.commandlineaction.md) > [documentation](./ts-command-line.commandlineaction.documentation.md) + +## CommandLineAction.documentation property + +A detailed description that is shown on the action help page, which is displayed by the command "example build --help", e.g. for actionName="build". + +Signature: + +```typescript +readonly documentation: string; +``` diff --git a/pages/api/ts-command-line.commandlineaction.md b/pages/api/ts-command-line.commandlineaction.md new file mode 100644 index 000000000..56d8817a0 --- /dev/null +++ b/pages/api/ts-command-line.commandlineaction.md @@ -0,0 +1,42 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineAction](./ts-command-line.commandlineaction.md) + +## CommandLineAction class + +Represents a sub-command that is part of the CommandLineParser command line. Applications should create subclasses of CommandLineAction corresponding to each action that they want to expose. + +The action name should be comprised of lower case words separated by hyphens or colons. The name should include an English verb (e.g. "deploy"). Use a hyphen to separate words (e.g. "upload-docs"). A group of related commands can be prefixed with a colon (e.g. "docs:generate", "docs:deploy", "docs:serve", etc). + +Signature: + +```typescript +export declare abstract class CommandLineAction extends CommandLineParameterProvider +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./ts-command-line.commandlineaction._constructor_.md) | | Constructs a new instance of the CommandLineAction class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [actionName](./ts-command-line.commandlineaction.actionname.md) | | string | The name of the action. For example, if the tool is called "example", then the "build" action might be invoked as: "example build -q --some-other-option" | +| [documentation](./ts-command-line.commandlineaction.documentation.md) | | string | A detailed description that is shown on the action help page, which is displayed by the command "example build --help", e.g. for actionName="build". | +| [summary](./ts-command-line.commandlineaction.summary.md) | | string | A quick summary that is shown on the main help page, which is displayed by the command "example --help" | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [onDefineParameters()](./ts-command-line.commandlineaction.ondefineparameters.md) | | The child class should implement this hook to define its command-line parameters, e.g. by calling defineFlagParameter(). | +| [onExecute()](./ts-command-line.commandlineaction.onexecute.md) | | Your subclass should implement this hook to perform the operation. | + diff --git a/pages/api/ts-command-line.commandlineaction.ondefineparameters.md b/pages/api/ts-command-line.commandlineaction.ondefineparameters.md new file mode 100644 index 000000000..ad538481d --- /dev/null +++ b/pages/api/ts-command-line.commandlineaction.ondefineparameters.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineAction](./ts-command-line.commandlineaction.md) > [onDefineParameters](./ts-command-line.commandlineaction.ondefineparameters.md) + +## CommandLineAction.onDefineParameters() method + +The child class should implement this hook to define its command-line parameters, e.g. by calling defineFlagParameter(). + +Signature: + +```typescript +protected abstract onDefineParameters(): void; +``` +Returns: + +`void` + diff --git a/pages/api/ts-command-line.commandlineaction.onexecute.md b/pages/api/ts-command-line.commandlineaction.onexecute.md new file mode 100644 index 000000000..6efcfbf0c --- /dev/null +++ b/pages/api/ts-command-line.commandlineaction.onexecute.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineAction](./ts-command-line.commandlineaction.md) > [onExecute](./ts-command-line.commandlineaction.onexecute.md) + +## CommandLineAction.onExecute() method + +Your subclass should implement this hook to perform the operation. + +Signature: + +```typescript +protected abstract onExecute(): Promise; +``` +Returns: + +`Promise` + diff --git a/pages/api/ts-command-line.commandlineaction.summary.md b/pages/api/ts-command-line.commandlineaction.summary.md new file mode 100644 index 000000000..3c3a1aba2 --- /dev/null +++ b/pages/api/ts-command-line.commandlineaction.summary.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineAction](./ts-command-line.commandlineaction.md) > [summary](./ts-command-line.commandlineaction.summary.md) + +## CommandLineAction.summary property + +A quick summary that is shown on the main help page, which is displayed by the command "example --help" + +Signature: + +```typescript +readonly summary: string; +``` diff --git a/pages/api/ts-command-line.commandlinechoiceparameter.alternatives.md b/pages/api/ts-command-line.commandlinechoiceparameter.alternatives.md new file mode 100644 index 000000000..5be2326be --- /dev/null +++ b/pages/api/ts-command-line.commandlinechoiceparameter.alternatives.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineChoiceParameter](./ts-command-line.commandlinechoiceparameter.md) > [alternatives](./ts-command-line.commandlinechoiceparameter.alternatives.md) + +## CommandLineChoiceParameter.alternatives property + +A list of strings (which contain no spaces), of possible options which can be selected + +Signature: + +```typescript +readonly alternatives: ReadonlyArray; +``` diff --git a/pages/api/ts-command-line.commandlinechoiceparameter.appendtoarglist.md b/pages/api/ts-command-line.commandlinechoiceparameter.appendtoarglist.md new file mode 100644 index 000000000..3d724184a --- /dev/null +++ b/pages/api/ts-command-line.commandlinechoiceparameter.appendtoarglist.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineChoiceParameter](./ts-command-line.commandlinechoiceparameter.md) > [appendToArgList](./ts-command-line.commandlinechoiceparameter.appendtoarglist.md) + +## CommandLineChoiceParameter.appendToArgList() method + +Append the parsed values to the provided string array. + +Signature: + +```typescript +/** @override */ +appendToArgList(argList: string[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| argList | string[] | the parsed strings will be appended to this string array | + +Returns: + +`void` + +## Remarks + +Sometimes a command line parameter is not used directly, but instead gets passed through to another tool that will use it. For example if our parameter comes in as "--max-count 3", then we might want to call `child_process.spawn()` and append \["--max-count", "3"\] to the args array for that tool. appendToArgList() appends zero or more strings to the provided array, based on the input command-line that we parsed. + +If the parameter was omitted from our command-line and has no default value, then nothing will be appended. If the short name was used, the long name will be appended instead. + diff --git a/pages/api/ts-command-line.commandlinechoiceparameter.defaultvalue.md b/pages/api/ts-command-line.commandlinechoiceparameter.defaultvalue.md new file mode 100644 index 000000000..aaa48b4ea --- /dev/null +++ b/pages/api/ts-command-line.commandlinechoiceparameter.defaultvalue.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineChoiceParameter](./ts-command-line.commandlinechoiceparameter.md) > [defaultValue](./ts-command-line.commandlinechoiceparameter.defaultvalue.md) + +## CommandLineChoiceParameter.defaultValue property + +The default value which will be used if the parameter is omitted from the command line. + +Signature: + +```typescript +readonly defaultValue: string | undefined; +``` + +## Remarks + +If a default value is specified, then [IBaseCommandLineDefinition.required](./ts-command-line.ibasecommandlinedefinition.required.md) must not be true. Instead, a custom error message should be used to report cases where a default value was not available. + diff --git a/pages/api/ts-command-line.commandlinechoiceparameter.kind.md b/pages/api/ts-command-line.commandlinechoiceparameter.kind.md new file mode 100644 index 000000000..7d0d3a2ef --- /dev/null +++ b/pages/api/ts-command-line.commandlinechoiceparameter.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineChoiceParameter](./ts-command-line.commandlinechoiceparameter.md) > [kind](./ts-command-line.commandlinechoiceparameter.kind.md) + +## CommandLineChoiceParameter.kind property + +Indicates the type of parameter. + +Signature: + +```typescript +readonly kind: CommandLineParameterKind; +``` diff --git a/pages/api/ts-command-line.commandlinechoiceparameter.md b/pages/api/ts-command-line.commandlinechoiceparameter.md new file mode 100644 index 000000000..b4239f2df --- /dev/null +++ b/pages/api/ts-command-line.commandlinechoiceparameter.md @@ -0,0 +1,38 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineChoiceParameter](./ts-command-line.commandlinechoiceparameter.md) + +## CommandLineChoiceParameter class + +The data type returned by [CommandLineParameterProvider.defineChoiceParameter()](./ts-command-line.commandlineparameterprovider.definechoiceparameter.md). + +Signature: + +```typescript +export declare class CommandLineChoiceParameter extends CommandLineParameter +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [alternatives](./ts-command-line.commandlinechoiceparameter.alternatives.md) | | ReadonlyArray<string> | A list of strings (which contain no spaces), of possible options which can be selected | +| [defaultValue](./ts-command-line.commandlinechoiceparameter.defaultvalue.md) | | string | undefined | The default value which will be used if the parameter is omitted from the command line. | +| [kind](./ts-command-line.commandlinechoiceparameter.kind.md) | | CommandLineParameterKind | Indicates the type of parameter. | +| [value](./ts-command-line.commandlinechoiceparameter.value.md) | | string | undefined | Returns the argument value for a choice parameter that was parsed from the command line. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [appendToArgList(argList)](./ts-command-line.commandlinechoiceparameter.appendtoarglist.md) | | Append the parsed values to the provided string array. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CommandLineChoiceParameter` class. + diff --git a/pages/api/ts-command-line.commandlinechoiceparameter.value.md b/pages/api/ts-command-line.commandlinechoiceparameter.value.md new file mode 100644 index 000000000..892b91888 --- /dev/null +++ b/pages/api/ts-command-line.commandlinechoiceparameter.value.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineChoiceParameter](./ts-command-line.commandlinechoiceparameter.md) > [value](./ts-command-line.commandlinechoiceparameter.value.md) + +## CommandLineChoiceParameter.value property + +Returns the argument value for a choice parameter that was parsed from the command line. + +Signature: + +```typescript +readonly value: string | undefined; +``` + +## Remarks + +The return value will be `undefined` if the command-line has not been parsed yet, or if the parameter was omitted and has no default value. + diff --git a/pages/api/ts-command-line.commandlineflagparameter.appendtoarglist.md b/pages/api/ts-command-line.commandlineflagparameter.appendtoarglist.md new file mode 100644 index 000000000..5185da0ac --- /dev/null +++ b/pages/api/ts-command-line.commandlineflagparameter.appendtoarglist.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineFlagParameter](./ts-command-line.commandlineflagparameter.md) > [appendToArgList](./ts-command-line.commandlineflagparameter.appendtoarglist.md) + +## CommandLineFlagParameter.appendToArgList() method + +Append the parsed values to the provided string array. + +Signature: + +```typescript +/** @override */ +appendToArgList(argList: string[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| argList | string[] | the parsed strings will be appended to this string array | + +Returns: + +`void` + +## Remarks + +Sometimes a command line parameter is not used directly, but instead gets passed through to another tool that will use it. For example if our parameter comes in as "--max-count 3", then we might want to call `child_process.spawn()` and append \["--max-count", "3"\] to the args array for that tool. appendToArgList() appends zero or more strings to the provided array, based on the input command-line that we parsed. + +If the parameter was omitted from our command-line and has no default value, then nothing will be appended. If the short name was used, the long name will be appended instead. + diff --git a/pages/api/ts-command-line.commandlineflagparameter.kind.md b/pages/api/ts-command-line.commandlineflagparameter.kind.md new file mode 100644 index 000000000..233158ad4 --- /dev/null +++ b/pages/api/ts-command-line.commandlineflagparameter.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineFlagParameter](./ts-command-line.commandlineflagparameter.md) > [kind](./ts-command-line.commandlineflagparameter.kind.md) + +## CommandLineFlagParameter.kind property + +Indicates the type of parameter. + +Signature: + +```typescript +readonly kind: CommandLineParameterKind; +``` diff --git a/pages/api/ts-command-line.commandlineflagparameter.md b/pages/api/ts-command-line.commandlineflagparameter.md new file mode 100644 index 000000000..207780cf8 --- /dev/null +++ b/pages/api/ts-command-line.commandlineflagparameter.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineFlagParameter](./ts-command-line.commandlineflagparameter.md) + +## CommandLineFlagParameter class + +The data type returned by [CommandLineParameterProvider.defineFlagParameter()](./ts-command-line.commandlineparameterprovider.defineflagparameter.md). + +Signature: + +```typescript +export declare class CommandLineFlagParameter extends CommandLineParameter +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [kind](./ts-command-line.commandlineflagparameter.kind.md) | | CommandLineParameterKind | Indicates the type of parameter. | +| [value](./ts-command-line.commandlineflagparameter.value.md) | | boolean | Returns a boolean indicating whether the parameter was included in the command line. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [appendToArgList(argList)](./ts-command-line.commandlineflagparameter.appendtoarglist.md) | | Append the parsed values to the provided string array. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CommandLineFlagParameter` class. + diff --git a/pages/api/ts-command-line.commandlineflagparameter.value.md b/pages/api/ts-command-line.commandlineflagparameter.value.md new file mode 100644 index 000000000..861327011 --- /dev/null +++ b/pages/api/ts-command-line.commandlineflagparameter.value.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineFlagParameter](./ts-command-line.commandlineflagparameter.md) > [value](./ts-command-line.commandlineflagparameter.value.md) + +## CommandLineFlagParameter.value property + +Returns a boolean indicating whether the parameter was included in the command line. + +Signature: + +```typescript +readonly value: boolean; +``` + +## Remarks + +The return value will be false if the command-line has not been parsed yet, or if the flag was not used. + diff --git a/pages/api/ts-command-line.commandlineintegerparameter.appendtoarglist.md b/pages/api/ts-command-line.commandlineintegerparameter.appendtoarglist.md new file mode 100644 index 000000000..ac9352d12 --- /dev/null +++ b/pages/api/ts-command-line.commandlineintegerparameter.appendtoarglist.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineIntegerParameter](./ts-command-line.commandlineintegerparameter.md) > [appendToArgList](./ts-command-line.commandlineintegerparameter.appendtoarglist.md) + +## CommandLineIntegerParameter.appendToArgList() method + +Append the parsed values to the provided string array. + +Signature: + +```typescript +/** @override */ +appendToArgList(argList: string[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| argList | string[] | the parsed strings will be appended to this string array | + +Returns: + +`void` + +## Remarks + +Sometimes a command line parameter is not used directly, but instead gets passed through to another tool that will use it. For example if our parameter comes in as "--max-count 3", then we might want to call `child_process.spawn()` and append \["--max-count", "3"\] to the args array for that tool. appendToArgList() appends zero or more strings to the provided array, based on the input command-line that we parsed. + +If the parameter was omitted from our command-line and has no default value, then nothing will be appended. If the short name was used, the long name will be appended instead. + diff --git a/pages/api/ts-command-line.commandlineintegerparameter.defaultvalue.md b/pages/api/ts-command-line.commandlineintegerparameter.defaultvalue.md new file mode 100644 index 000000000..d0bfbef1f --- /dev/null +++ b/pages/api/ts-command-line.commandlineintegerparameter.defaultvalue.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineIntegerParameter](./ts-command-line.commandlineintegerparameter.md) > [defaultValue](./ts-command-line.commandlineintegerparameter.defaultvalue.md) + +## CommandLineIntegerParameter.defaultValue property + +The default value which will be used if the parameter is omitted from the command line. + +Signature: + +```typescript +readonly defaultValue: number | undefined; +``` + +## Remarks + +If a default value is specified, then [IBaseCommandLineDefinition.required](./ts-command-line.ibasecommandlinedefinition.required.md) must not be true. Instead, a custom error message should be used to report cases where a default value was not available. + diff --git a/pages/api/ts-command-line.commandlineintegerparameter.kind.md b/pages/api/ts-command-line.commandlineintegerparameter.kind.md new file mode 100644 index 000000000..3feca7e3e --- /dev/null +++ b/pages/api/ts-command-line.commandlineintegerparameter.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineIntegerParameter](./ts-command-line.commandlineintegerparameter.md) > [kind](./ts-command-line.commandlineintegerparameter.kind.md) + +## CommandLineIntegerParameter.kind property + +Indicates the type of parameter. + +Signature: + +```typescript +readonly kind: CommandLineParameterKind; +``` diff --git a/pages/api/ts-command-line.commandlineintegerparameter.md b/pages/api/ts-command-line.commandlineintegerparameter.md new file mode 100644 index 000000000..26cab2b9f --- /dev/null +++ b/pages/api/ts-command-line.commandlineintegerparameter.md @@ -0,0 +1,37 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineIntegerParameter](./ts-command-line.commandlineintegerparameter.md) + +## CommandLineIntegerParameter class + +The data type returned by [CommandLineParameterProvider.defineIntegerParameter()](./ts-command-line.commandlineparameterprovider.defineintegerparameter.md). + +Signature: + +```typescript +export declare class CommandLineIntegerParameter extends CommandLineParameterWithArgument +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [defaultValue](./ts-command-line.commandlineintegerparameter.defaultvalue.md) | | number | undefined | The default value which will be used if the parameter is omitted from the command line. | +| [kind](./ts-command-line.commandlineintegerparameter.kind.md) | | CommandLineParameterKind | Indicates the type of parameter. | +| [value](./ts-command-line.commandlineintegerparameter.value.md) | | number | undefined | Returns the argument value for an integer parameter that was parsed from the command line. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [appendToArgList(argList)](./ts-command-line.commandlineintegerparameter.appendtoarglist.md) | | Append the parsed values to the provided string array. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CommandLineIntegerParameter` class. + diff --git a/pages/api/ts-command-line.commandlineintegerparameter.value.md b/pages/api/ts-command-line.commandlineintegerparameter.value.md new file mode 100644 index 000000000..b183fb2d2 --- /dev/null +++ b/pages/api/ts-command-line.commandlineintegerparameter.value.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineIntegerParameter](./ts-command-line.commandlineintegerparameter.md) > [value](./ts-command-line.commandlineintegerparameter.value.md) + +## CommandLineIntegerParameter.value property + +Returns the argument value for an integer parameter that was parsed from the command line. + +Signature: + +```typescript +readonly value: number | undefined; +``` + +## Remarks + +The return value will be undefined if the command-line has not been parsed yet, or if the parameter was omitted and has no default value. + diff --git a/pages/api/ts-command-line.commandlineparameter.appendtoarglist.md b/pages/api/ts-command-line.commandlineparameter.appendtoarglist.md new file mode 100644 index 000000000..0a2f3a87a --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameter.appendtoarglist.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameter](./ts-command-line.commandlineparameter.md) > [appendToArgList](./ts-command-line.commandlineparameter.appendtoarglist.md) + +## CommandLineParameter.appendToArgList() method + +Append the parsed values to the provided string array. + +Signature: + +```typescript +abstract appendToArgList(argList: string[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| argList | string[] | the parsed strings will be appended to this string array | + +Returns: + +`void` + +## Remarks + +Sometimes a command line parameter is not used directly, but instead gets passed through to another tool that will use it. For example if our parameter comes in as "--max-count 3", then we might want to call `child_process.spawn()` and append \["--max-count", "3"\] to the args array for that tool. appendToArgList() appends zero or more strings to the provided array, based on the input command-line that we parsed. + +If the parameter was omitted from our command-line and has no default value, then nothing will be appended. If the short name was used, the long name will be appended instead. + diff --git a/pages/api/ts-command-line.commandlineparameter.description.md b/pages/api/ts-command-line.commandlineparameter.description.md new file mode 100644 index 000000000..0990ffede --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameter.description.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameter](./ts-command-line.commandlineparameter.md) > [description](./ts-command-line.commandlineparameter.description.md) + +## CommandLineParameter.description property + +Documentation for the flag, that will be shown when invoking the tool with "--help" + +Signature: + +```typescript +readonly description: string; +``` diff --git a/pages/api/ts-command-line.commandlineparameter.environmentvariable.md b/pages/api/ts-command-line.commandlineparameter.environmentvariable.md new file mode 100644 index 000000000..d29e6ae4e --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameter.environmentvariable.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameter](./ts-command-line.commandlineparameter.md) > [environmentVariable](./ts-command-line.commandlineparameter.environmentvariable.md) + +## CommandLineParameter.environmentVariable property + +The name of an environment variable that the parameter value will be read from, if it was omitted from the command-line. An error will be reported if the environment value cannot be parsed. + +Signature: + +```typescript +readonly environmentVariable: string | undefined; +``` + +## Remarks + +The environment variable name must consist only of upper-case letters, numbers, and underscores. It may not start with a number. + +This feature cannot be used when [IBaseCommandLineDefinition.required](./ts-command-line.ibasecommandlinedefinition.required.md) is true, because in that case the environmentVariable would never be used. + diff --git a/pages/api/ts-command-line.commandlineparameter.kind.md b/pages/api/ts-command-line.commandlineparameter.kind.md new file mode 100644 index 000000000..80916ab89 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameter.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameter](./ts-command-line.commandlineparameter.md) > [kind](./ts-command-line.commandlineparameter.kind.md) + +## CommandLineParameter.kind property + +Indicates the type of parameter. + +Signature: + +```typescript +abstract readonly kind: CommandLineParameterKind; +``` diff --git a/pages/api/ts-command-line.commandlineparameter.longname.md b/pages/api/ts-command-line.commandlineparameter.longname.md new file mode 100644 index 000000000..92c85f8c4 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameter.longname.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameter](./ts-command-line.commandlineparameter.md) > [longName](./ts-command-line.commandlineparameter.longname.md) + +## CommandLineParameter.longName property + +The long name of the flag including double dashes, e.g. "--do-something" + +Signature: + +```typescript +readonly longName: string; +``` diff --git a/pages/api/ts-command-line.commandlineparameter.md b/pages/api/ts-command-line.commandlineparameter.md new file mode 100644 index 000000000..1aa4a0753 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameter.md @@ -0,0 +1,42 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameter](./ts-command-line.commandlineparameter.md) + +## CommandLineParameter class + +The base class for the various command-line parameter types. + +Signature: + +```typescript +export declare abstract class CommandLineParameter +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [description](./ts-command-line.commandlineparameter.description.md) | | string | Documentation for the flag, that will be shown when invoking the tool with "--help" | +| [environmentVariable](./ts-command-line.commandlineparameter.environmentvariable.md) | | string | undefined | The name of an environment variable that the parameter value will be read from, if it was omitted from the command-line. An error will be reported if the environment value cannot be parsed. | +| [kind](./ts-command-line.commandlineparameter.kind.md) | | CommandLineParameterKind | Indicates the type of parameter. | +| [longName](./ts-command-line.commandlineparameter.longname.md) | | string | The long name of the flag including double dashes, e.g. "--do-something" | +| [required](./ts-command-line.commandlineparameter.required.md) | | boolean | If true, then an error occurs if the parameter was not included on the command-line. | +| [shortName](./ts-command-line.commandlineparameter.shortname.md) | | string | undefined | An optional short name for the flag including the dash, e.g. "-d" | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [appendToArgList(argList)](./ts-command-line.commandlineparameter.appendtoarglist.md) | | Append the parsed values to the provided string array. | +| [reportInvalidData(data)](./ts-command-line.commandlineparameter.reportinvaliddata.md) | | Internal usage only. Used to report unexpected output from the argparse library. | +| [validateDefaultValue(hasDefaultValue)](./ts-command-line.commandlineparameter.validatedefaultvalue.md) | | | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CommandLineParameter` class. + diff --git a/pages/api/ts-command-line.commandlineparameter.reportinvaliddata.md b/pages/api/ts-command-line.commandlineparameter.reportinvaliddata.md new file mode 100644 index 000000000..c9ae3b79f --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameter.reportinvaliddata.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameter](./ts-command-line.commandlineparameter.md) > [reportInvalidData](./ts-command-line.commandlineparameter.reportinvaliddata.md) + +## CommandLineParameter.reportInvalidData() method + +Internal usage only. Used to report unexpected output from the argparse library. + +Signature: + +```typescript +protected reportInvalidData(data: any): never; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| data | any | | + +Returns: + +`never` + diff --git a/pages/api/ts-command-line.commandlineparameter.required.md b/pages/api/ts-command-line.commandlineparameter.required.md new file mode 100644 index 000000000..8a18c17e2 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameter.required.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameter](./ts-command-line.commandlineparameter.md) > [required](./ts-command-line.commandlineparameter.required.md) + +## CommandLineParameter.required property + +If true, then an error occurs if the parameter was not included on the command-line. + +Signature: + +```typescript +readonly required: boolean; +``` diff --git a/pages/api/ts-command-line.commandlineparameter.shortname.md b/pages/api/ts-command-line.commandlineparameter.shortname.md new file mode 100644 index 000000000..bf411ed09 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameter.shortname.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameter](./ts-command-line.commandlineparameter.md) > [shortName](./ts-command-line.commandlineparameter.shortname.md) + +## CommandLineParameter.shortName property + +An optional short name for the flag including the dash, e.g. "-d" + +Signature: + +```typescript +readonly shortName: string | undefined; +``` diff --git a/pages/api/ts-command-line.commandlineparameter.validatedefaultvalue.md b/pages/api/ts-command-line.commandlineparameter.validatedefaultvalue.md new file mode 100644 index 000000000..b3993de62 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameter.validatedefaultvalue.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameter](./ts-command-line.commandlineparameter.md) > [validateDefaultValue](./ts-command-line.commandlineparameter.validatedefaultvalue.md) + +## CommandLineParameter.validateDefaultValue() method + +Signature: + +```typescript +protected validateDefaultValue(hasDefaultValue: boolean): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| hasDefaultValue | boolean | | + +Returns: + +`void` + diff --git a/pages/api/ts-command-line.commandlineparameterkind.md b/pages/api/ts-command-line.commandlineparameterkind.md new file mode 100644 index 000000000..875c7ee4b --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterkind.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterKind](./ts-command-line.commandlineparameterkind.md) + +## CommandLineParameterKind enum + +Identifies the kind of a CommandLineParameter. + +Signature: + +```typescript +export declare enum CommandLineParameterKind +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Choice | 0 | Indicates a CommandLineChoiceParameter | +| Flag | 1 | Indicates a CommandLineFlagParameter | +| Integer | 2 | Indicates a CommandLineIntegerParameter | +| String | 3 | Indicates a CommandLineStringParameter | +| StringList | 4 | Indicates a CommandLineStringListParameter | + diff --git a/pages/api/ts-command-line.commandlineparameterprovider.definechoiceparameter.md b/pages/api/ts-command-line.commandlineparameterprovider.definechoiceparameter.md new file mode 100644 index 000000000..50e51cd30 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterprovider.definechoiceparameter.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterProvider](./ts-command-line.commandlineparameterprovider.md) > [defineChoiceParameter](./ts-command-line.commandlineparameterprovider.definechoiceparameter.md) + +## CommandLineParameterProvider.defineChoiceParameter() method + +Defines a command-line parameter whose value must be a string from a fixed set of allowable choices (similar to an enum). + +Signature: + +```typescript +defineChoiceParameter(definition: ICommandLineChoiceDefinition): CommandLineChoiceParameter; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| definition | ICommandLineChoiceDefinition | | + +Returns: + +`CommandLineChoiceParameter` + +## Remarks + +Example: example-tool --log-level warn + diff --git a/pages/api/ts-command-line.commandlineparameterprovider.defineflagparameter.md b/pages/api/ts-command-line.commandlineparameterprovider.defineflagparameter.md new file mode 100644 index 000000000..b3ac78920 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterprovider.defineflagparameter.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterProvider](./ts-command-line.commandlineparameterprovider.md) > [defineFlagParameter](./ts-command-line.commandlineparameterprovider.defineflagparameter.md) + +## CommandLineParameterProvider.defineFlagParameter() method + +Defines a command-line switch whose boolean value is true if the switch is provided, and false otherwise. + +Signature: + +```typescript +defineFlagParameter(definition: ICommandLineFlagDefinition): CommandLineFlagParameter; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| definition | ICommandLineFlagDefinition | | + +Returns: + +`CommandLineFlagParameter` + +## Remarks + +Example: example-tool --debug + diff --git a/pages/api/ts-command-line.commandlineparameterprovider.defineintegerparameter.md b/pages/api/ts-command-line.commandlineparameterprovider.defineintegerparameter.md new file mode 100644 index 000000000..b086ef917 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterprovider.defineintegerparameter.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterProvider](./ts-command-line.commandlineparameterprovider.md) > [defineIntegerParameter](./ts-command-line.commandlineparameterprovider.defineintegerparameter.md) + +## CommandLineParameterProvider.defineIntegerParameter() method + +Defines a command-line parameter whose value is an integer. + +Signature: + +```typescript +defineIntegerParameter(definition: ICommandLineIntegerDefinition): CommandLineIntegerParameter; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| definition | ICommandLineIntegerDefinition | | + +Returns: + +`CommandLineIntegerParameter` + +## Remarks + +Example: example-tool --max-attempts 5 + diff --git a/pages/api/ts-command-line.commandlineparameterprovider.definestringlistparameter.md b/pages/api/ts-command-line.commandlineparameterprovider.definestringlistparameter.md new file mode 100644 index 000000000..8a29b91c0 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterprovider.definestringlistparameter.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterProvider](./ts-command-line.commandlineparameterprovider.md) > [defineStringListParameter](./ts-command-line.commandlineparameterprovider.definestringlistparameter.md) + +## CommandLineParameterProvider.defineStringListParameter() method + +Defines a command-line parameter whose value is one or more text strings. + +Signature: + +```typescript +defineStringListParameter(definition: ICommandLineStringListDefinition): CommandLineStringListParameter; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| definition | ICommandLineStringListDefinition | | + +Returns: + +`CommandLineStringListParameter` + +## Remarks + +Example: example-tool --add file1.txt --add file2.txt --add file3.txt + diff --git a/pages/api/ts-command-line.commandlineparameterprovider.definestringparameter.md b/pages/api/ts-command-line.commandlineparameterprovider.definestringparameter.md new file mode 100644 index 000000000..063dd348a --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterprovider.definestringparameter.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterProvider](./ts-command-line.commandlineparameterprovider.md) > [defineStringParameter](./ts-command-line.commandlineparameterprovider.definestringparameter.md) + +## CommandLineParameterProvider.defineStringParameter() method + +Defines a command-line parameter whose value is a single text string. + +Signature: + +```typescript +defineStringParameter(definition: ICommandLineStringDefinition): CommandLineStringParameter; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| definition | ICommandLineStringDefinition | | + +Returns: + +`CommandLineStringParameter` + +## Remarks + +Example: example-tool --message "Hello, world!" + diff --git a/pages/api/ts-command-line.commandlineparameterprovider.getchoiceparameter.md b/pages/api/ts-command-line.commandlineparameterprovider.getchoiceparameter.md new file mode 100644 index 000000000..fcd1e4552 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterprovider.getchoiceparameter.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterProvider](./ts-command-line.commandlineparameterprovider.md) > [getChoiceParameter](./ts-command-line.commandlineparameterprovider.getchoiceparameter.md) + +## CommandLineParameterProvider.getChoiceParameter() method + +Returns the CommandLineChoiceParameter with the specified long name. + +Signature: + +```typescript +getChoiceParameter(parameterLongName: string): CommandLineChoiceParameter; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| parameterLongName | string | | + +Returns: + +`CommandLineChoiceParameter` + +## Remarks + +This method throws an exception if the parameter is not defined. + diff --git a/pages/api/ts-command-line.commandlineparameterprovider.getflagparameter.md b/pages/api/ts-command-line.commandlineparameterprovider.getflagparameter.md new file mode 100644 index 000000000..df8015093 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterprovider.getflagparameter.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterProvider](./ts-command-line.commandlineparameterprovider.md) > [getFlagParameter](./ts-command-line.commandlineparameterprovider.getflagparameter.md) + +## CommandLineParameterProvider.getFlagParameter() method + +Returns the CommandLineFlagParameter with the specified long name. + +Signature: + +```typescript +getFlagParameter(parameterLongName: string): CommandLineFlagParameter; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| parameterLongName | string | | + +Returns: + +`CommandLineFlagParameter` + +## Remarks + +This method throws an exception if the parameter is not defined. + diff --git a/pages/api/ts-command-line.commandlineparameterprovider.getintegerparameter.md b/pages/api/ts-command-line.commandlineparameterprovider.getintegerparameter.md new file mode 100644 index 000000000..25c8297bd --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterprovider.getintegerparameter.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterProvider](./ts-command-line.commandlineparameterprovider.md) > [getIntegerParameter](./ts-command-line.commandlineparameterprovider.getintegerparameter.md) + +## CommandLineParameterProvider.getIntegerParameter() method + +Returns the CommandLineIntegerParameter with the specified long name. + +Signature: + +```typescript +getIntegerParameter(parameterLongName: string): CommandLineIntegerParameter; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| parameterLongName | string | | + +Returns: + +`CommandLineIntegerParameter` + +## Remarks + +This method throws an exception if the parameter is not defined. + diff --git a/pages/api/ts-command-line.commandlineparameterprovider.getstringlistparameter.md b/pages/api/ts-command-line.commandlineparameterprovider.getstringlistparameter.md new file mode 100644 index 000000000..5224f62e6 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterprovider.getstringlistparameter.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterProvider](./ts-command-line.commandlineparameterprovider.md) > [getStringListParameter](./ts-command-line.commandlineparameterprovider.getstringlistparameter.md) + +## CommandLineParameterProvider.getStringListParameter() method + +Returns the CommandLineStringListParameter with the specified long name. + +Signature: + +```typescript +getStringListParameter(parameterLongName: string): CommandLineStringListParameter; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| parameterLongName | string | | + +Returns: + +`CommandLineStringListParameter` + +## Remarks + +This method throws an exception if the parameter is not defined. + diff --git a/pages/api/ts-command-line.commandlineparameterprovider.getstringparameter.md b/pages/api/ts-command-line.commandlineparameterprovider.getstringparameter.md new file mode 100644 index 000000000..a737bd183 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterprovider.getstringparameter.md @@ -0,0 +1,33 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterProvider](./ts-command-line.commandlineparameterprovider.md) > [getStringParameter](./ts-command-line.commandlineparameterprovider.getstringparameter.md) + +## CommandLineParameterProvider.getStringParameter() method + +Returns the CommandLineStringParameter with the specified long name. + +Signature: + +```typescript +getStringParameter(parameterLongName: string): CommandLineStringParameter; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| parameterLongName | string | | + +Returns: + +`CommandLineStringParameter` + +## Remarks + +This method throws an exception if the parameter is not defined. + diff --git a/pages/api/ts-command-line.commandlineparameterprovider.md b/pages/api/ts-command-line.commandlineparameterprovider.md new file mode 100644 index 000000000..183d2cc8e --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterprovider.md @@ -0,0 +1,46 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterProvider](./ts-command-line.commandlineparameterprovider.md) + +## CommandLineParameterProvider class + +This is the common base class for CommandLineAction and CommandLineParser that provides functionality for defining command-line parameters. + +Signature: + +```typescript +export declare abstract class CommandLineParameterProvider +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [parameters](./ts-command-line.commandlineparameterprovider.parameters.md) | | ReadonlyArray<CommandLineParameter> | Returns a collection of the parameters that were defined for this object. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [defineChoiceParameter(definition)](./ts-command-line.commandlineparameterprovider.definechoiceparameter.md) | | Defines a command-line parameter whose value must be a string from a fixed set of allowable choices (similar to an enum). | +| [defineFlagParameter(definition)](./ts-command-line.commandlineparameterprovider.defineflagparameter.md) | | Defines a command-line switch whose boolean value is true if the switch is provided, and false otherwise. | +| [defineIntegerParameter(definition)](./ts-command-line.commandlineparameterprovider.defineintegerparameter.md) | | Defines a command-line parameter whose value is an integer. | +| [defineStringListParameter(definition)](./ts-command-line.commandlineparameterprovider.definestringlistparameter.md) | | Defines a command-line parameter whose value is one or more text strings. | +| [defineStringParameter(definition)](./ts-command-line.commandlineparameterprovider.definestringparameter.md) | | Defines a command-line parameter whose value is a single text string. | +| [getChoiceParameter(parameterLongName)](./ts-command-line.commandlineparameterprovider.getchoiceparameter.md) | | Returns the CommandLineChoiceParameter with the specified long name. | +| [getFlagParameter(parameterLongName)](./ts-command-line.commandlineparameterprovider.getflagparameter.md) | | Returns the CommandLineFlagParameter with the specified long name. | +| [getIntegerParameter(parameterLongName)](./ts-command-line.commandlineparameterprovider.getintegerparameter.md) | | Returns the CommandLineIntegerParameter with the specified long name. | +| [getStringListParameter(parameterLongName)](./ts-command-line.commandlineparameterprovider.getstringlistparameter.md) | | Returns the CommandLineStringListParameter with the specified long name. | +| [getStringParameter(parameterLongName)](./ts-command-line.commandlineparameterprovider.getstringparameter.md) | | Returns the CommandLineStringParameter with the specified long name. | +| [onDefineParameters()](./ts-command-line.commandlineparameterprovider.ondefineparameters.md) | | The child class should implement this hook to define its command-line parameters, e.g. by calling defineFlagParameter(). | +| [renderHelpText()](./ts-command-line.commandlineparameterprovider.renderhelptext.md) | | Generates the command-line help text. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CommandLineParameterProvider` class. + diff --git a/pages/api/ts-command-line.commandlineparameterprovider.ondefineparameters.md b/pages/api/ts-command-line.commandlineparameterprovider.ondefineparameters.md new file mode 100644 index 000000000..4415b97db --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterprovider.ondefineparameters.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterProvider](./ts-command-line.commandlineparameterprovider.md) > [onDefineParameters](./ts-command-line.commandlineparameterprovider.ondefineparameters.md) + +## CommandLineParameterProvider.onDefineParameters() method + +The child class should implement this hook to define its command-line parameters, e.g. by calling defineFlagParameter(). + +Signature: + +```typescript +protected abstract onDefineParameters(): void; +``` +Returns: + +`void` + diff --git a/pages/api/ts-command-line.commandlineparameterprovider.parameters.md b/pages/api/ts-command-line.commandlineparameterprovider.parameters.md new file mode 100644 index 000000000..f3ef85a02 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterprovider.parameters.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterProvider](./ts-command-line.commandlineparameterprovider.md) > [parameters](./ts-command-line.commandlineparameterprovider.parameters.md) + +## CommandLineParameterProvider.parameters property + +Returns a collection of the parameters that were defined for this object. + +Signature: + +```typescript +readonly parameters: ReadonlyArray; +``` diff --git a/pages/api/ts-command-line.commandlineparameterprovider.renderhelptext.md b/pages/api/ts-command-line.commandlineparameterprovider.renderhelptext.md new file mode 100644 index 000000000..9f6b2baf1 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterprovider.renderhelptext.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterProvider](./ts-command-line.commandlineparameterprovider.md) > [renderHelpText](./ts-command-line.commandlineparameterprovider.renderhelptext.md) + +## CommandLineParameterProvider.renderHelpText() method + +Generates the command-line help text. + +Signature: + +```typescript +renderHelpText(): string; +``` +Returns: + +`string` + diff --git a/pages/api/ts-command-line.commandlineparameterwithargument.argumentname.md b/pages/api/ts-command-line.commandlineparameterwithargument.argumentname.md new file mode 100644 index 000000000..757a0c9ee --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterwithargument.argumentname.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterWithArgument](./ts-command-line.commandlineparameterwithargument.md) > [argumentName](./ts-command-line.commandlineparameterwithargument.argumentname.md) + +## CommandLineParameterWithArgument.argumentName property + +The name of the argument, which will be shown in the command-line help. + +Signature: + +```typescript +readonly argumentName: string; +``` + +## Remarks + +For example, if the parameter name is '--count" and the argument name is "NUMBER", then the command-line help would display "--count NUMBER". The argument name must be comprised of upper-case letters, numbers, and underscores. It should be kept short. + diff --git a/pages/api/ts-command-line.commandlineparameterwithargument.md b/pages/api/ts-command-line.commandlineparameterwithargument.md new file mode 100644 index 000000000..ae59d8cfa --- /dev/null +++ b/pages/api/ts-command-line.commandlineparameterwithargument.md @@ -0,0 +1,31 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParameterWithArgument](./ts-command-line.commandlineparameterwithargument.md) + +## CommandLineParameterWithArgument class + +The common base class for parameters types that receive an argument. + +Signature: + +```typescript +export declare abstract class CommandLineParameterWithArgument extends CommandLineParameter +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [argumentName](./ts-command-line.commandlineparameterwithargument.argumentname.md) | | string | The name of the argument, which will be shown in the command-line help. | + +## Remarks + +An argument is an accompanying command-line token, such as "123" in the example "--max-count 123". + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CommandLineParameterWithArgument` class. + diff --git a/pages/api/ts-command-line.commandlineparser._constructor_.md b/pages/api/ts-command-line.commandlineparser._constructor_.md new file mode 100644 index 000000000..23d8a775a --- /dev/null +++ b/pages/api/ts-command-line.commandlineparser._constructor_.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParser](./ts-command-line.commandlineparser.md) > [(constructor)](./ts-command-line.commandlineparser._constructor_.md) + +## CommandLineParser.(constructor) + +Constructs a new instance of the `CommandLineParser` class + +Signature: + +```typescript +constructor(options: ICommandLineParserOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | ICommandLineParserOptions | | + diff --git a/pages/api/ts-command-line.commandlineparser.actions.md b/pages/api/ts-command-line.commandlineparser.actions.md new file mode 100644 index 000000000..ad186686e --- /dev/null +++ b/pages/api/ts-command-line.commandlineparser.actions.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParser](./ts-command-line.commandlineparser.md) > [actions](./ts-command-line.commandlineparser.actions.md) + +## CommandLineParser.actions property + +Returns the list of actions that were defined for this CommandLineParser object. + +Signature: + +```typescript +readonly actions: ReadonlyArray; +``` diff --git a/pages/api/ts-command-line.commandlineparser.addaction.md b/pages/api/ts-command-line.commandlineparser.addaction.md new file mode 100644 index 000000000..4ca11f006 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparser.addaction.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParser](./ts-command-line.commandlineparser.md) > [addAction](./ts-command-line.commandlineparser.addaction.md) + +## CommandLineParser.addAction() method + +Defines a new action that can be used with the CommandLineParser instance. + +Signature: + +```typescript +addAction(action: CommandLineAction): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| action | CommandLineAction | | + +Returns: + +`void` + diff --git a/pages/api/ts-command-line.commandlineparser.execute.md b/pages/api/ts-command-line.commandlineparser.execute.md new file mode 100644 index 000000000..4865efd9b --- /dev/null +++ b/pages/api/ts-command-line.commandlineparser.execute.md @@ -0,0 +1,35 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParser](./ts-command-line.commandlineparser.md) > [execute](./ts-command-line.commandlineparser.execute.md) + +## CommandLineParser.execute() method + +The program entry point will call this method to begin parsing command-line arguments and executing the corresponding action. + +Signature: + +```typescript +execute(args?: string[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| args | string[] | the command-line arguments to be parsed; if omitted, then the process.argv will be used | + +Returns: + +`Promise` + +## Remarks + +The returned promise will never reject: If an error occurs, it will be printed to stderr, process.exitCode will be set to 1, and the promise will resolve to false. This simplifies the most common usage scenario where the program entry point doesn't want to be involved with the command-line logic, and will discard the promise without a then() or catch() block. + +If your caller wants to trap and handle errors, use [CommandLineParser.executeWithoutErrorHandling()](./ts-command-line.commandlineparser.executewithouterrorhandling.md) instead. + diff --git a/pages/api/ts-command-line.commandlineparser.executewithouterrorhandling.md b/pages/api/ts-command-line.commandlineparser.executewithouterrorhandling.md new file mode 100644 index 000000000..f225574b2 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparser.executewithouterrorhandling.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParser](./ts-command-line.commandlineparser.md) > [executeWithoutErrorHandling](./ts-command-line.commandlineparser.executewithouterrorhandling.md) + +## CommandLineParser.executeWithoutErrorHandling() method + +This is similar to [CommandLineParser.execute()](./ts-command-line.commandlineparser.execute.md), except that execution errors simply cause the promise to reject. It is the caller's responsibility to trap + +Signature: + +```typescript +executeWithoutErrorHandling(args?: string[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| args | string[] | | + +Returns: + +`Promise` + diff --git a/pages/api/ts-command-line.commandlineparser.getaction.md b/pages/api/ts-command-line.commandlineparser.getaction.md new file mode 100644 index 000000000..71adc6e75 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparser.getaction.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParser](./ts-command-line.commandlineparser.md) > [getAction](./ts-command-line.commandlineparser.getaction.md) + +## CommandLineParser.getAction() method + +Retrieves the action with the specified name. If no matching action is found, an exception is thrown. + +Signature: + +```typescript +getAction(actionName: string): CommandLineAction; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| actionName | string | | + +Returns: + +`CommandLineAction` + diff --git a/pages/api/ts-command-line.commandlineparser.md b/pages/api/ts-command-line.commandlineparser.md new file mode 100644 index 000000000..48c46e786 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparser.md @@ -0,0 +1,45 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParser](./ts-command-line.commandlineparser.md) + +## CommandLineParser class + +The "argparse" library is a relatively advanced command-line parser with features such as word-wrapping and intelligible error messages (that are lacking in other similar libraries such as commander, yargs, and nomnom). Unfortunately, its ruby-inspired API is awkward to use. The abstract base classes CommandLineParser and CommandLineAction provide a wrapper for "argparse" that makes defining and consuming arguments quick and simple, and enforces that appropriate documentation is provided for each parameter. + +Signature: + +```typescript +export declare abstract class CommandLineParser extends CommandLineParameterProvider +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./ts-command-line.commandlineparser._constructor_.md) | | Constructs a new instance of the CommandLineParser class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [actions](./ts-command-line.commandlineparser.actions.md) | | ReadonlyArray<CommandLineAction> | Returns the list of actions that were defined for this CommandLineParser object. | +| [selectedAction](./ts-command-line.commandlineparser.selectedaction.md) | | CommandLineAction | undefined | Reports which CommandLineAction was specified on the command line. | +| [toolDescription](./ts-command-line.commandlineparser.tooldescription.md) | | string | General documentation that is included in the "--help" main page | +| [toolFilename](./ts-command-line.commandlineparser.toolfilename.md) | | string | The name of your tool when invoked from the command line | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [addAction(action)](./ts-command-line.commandlineparser.addaction.md) | | Defines a new action that can be used with the CommandLineParser instance. | +| [execute(args)](./ts-command-line.commandlineparser.execute.md) | | The program entry point will call this method to begin parsing command-line arguments and executing the corresponding action. | +| [executeWithoutErrorHandling(args)](./ts-command-line.commandlineparser.executewithouterrorhandling.md) | | This is similar to [CommandLineParser.execute()](./ts-command-line.commandlineparser.execute.md), except that execution errors simply cause the promise to reject. It is the caller's responsibility to trap | +| [getAction(actionName)](./ts-command-line.commandlineparser.getaction.md) | | Retrieves the action with the specified name. If no matching action is found, an exception is thrown. | +| [onExecute()](./ts-command-line.commandlineparser.onexecute.md) | | This hook allows the subclass to perform additional operations before or after the chosen action is executed. | +| [tryGetAction(actionName)](./ts-command-line.commandlineparser.trygetaction.md) | | Retrieves the action with the specified name. If no matching action is found, undefined is returned. | + diff --git a/pages/api/ts-command-line.commandlineparser.onexecute.md b/pages/api/ts-command-line.commandlineparser.onexecute.md new file mode 100644 index 000000000..56edd21ef --- /dev/null +++ b/pages/api/ts-command-line.commandlineparser.onexecute.md @@ -0,0 +1,22 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParser](./ts-command-line.commandlineparser.md) > [onExecute](./ts-command-line.commandlineparser.onexecute.md) + +## CommandLineParser.onExecute() method + +This hook allows the subclass to perform additional operations before or after the chosen action is executed. + +Signature: + +```typescript +protected onExecute(): Promise; +``` +Returns: + +`Promise` + diff --git a/pages/api/ts-command-line.commandlineparser.selectedaction.md b/pages/api/ts-command-line.commandlineparser.selectedaction.md new file mode 100644 index 000000000..5c563d742 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparser.selectedaction.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParser](./ts-command-line.commandlineparser.md) > [selectedAction](./ts-command-line.commandlineparser.selectedaction.md) + +## CommandLineParser.selectedAction property + +Reports which CommandLineAction was specified on the command line. + +Signature: + +```typescript +selectedAction: CommandLineAction | undefined; +``` + +## Remarks + +The value will be assigned before onExecute() is invoked. + diff --git a/pages/api/ts-command-line.commandlineparser.tooldescription.md b/pages/api/ts-command-line.commandlineparser.tooldescription.md new file mode 100644 index 000000000..6177a30d6 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparser.tooldescription.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParser](./ts-command-line.commandlineparser.md) > [toolDescription](./ts-command-line.commandlineparser.tooldescription.md) + +## CommandLineParser.toolDescription property + +General documentation that is included in the "--help" main page + +Signature: + +```typescript +readonly toolDescription: string; +``` diff --git a/pages/api/ts-command-line.commandlineparser.toolfilename.md b/pages/api/ts-command-line.commandlineparser.toolfilename.md new file mode 100644 index 000000000..eb5f62028 --- /dev/null +++ b/pages/api/ts-command-line.commandlineparser.toolfilename.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParser](./ts-command-line.commandlineparser.md) > [toolFilename](./ts-command-line.commandlineparser.toolfilename.md) + +## CommandLineParser.toolFilename property + +The name of your tool when invoked from the command line + +Signature: + +```typescript +readonly toolFilename: string; +``` diff --git a/pages/api/ts-command-line.commandlineparser.trygetaction.md b/pages/api/ts-command-line.commandlineparser.trygetaction.md new file mode 100644 index 000000000..fcc92ab7a --- /dev/null +++ b/pages/api/ts-command-line.commandlineparser.trygetaction.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineParser](./ts-command-line.commandlineparser.md) > [tryGetAction](./ts-command-line.commandlineparser.trygetaction.md) + +## CommandLineParser.tryGetAction() method + +Retrieves the action with the specified name. If no matching action is found, undefined is returned. + +Signature: + +```typescript +tryGetAction(actionName: string): CommandLineAction | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| actionName | string | | + +Returns: + +`CommandLineAction | undefined` + diff --git a/pages/api/ts-command-line.commandlinestringlistparameter.appendtoarglist.md b/pages/api/ts-command-line.commandlinestringlistparameter.appendtoarglist.md new file mode 100644 index 000000000..91d04ec44 --- /dev/null +++ b/pages/api/ts-command-line.commandlinestringlistparameter.appendtoarglist.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineStringListParameter](./ts-command-line.commandlinestringlistparameter.md) > [appendToArgList](./ts-command-line.commandlinestringlistparameter.appendtoarglist.md) + +## CommandLineStringListParameter.appendToArgList() method + +Append the parsed values to the provided string array. + +Signature: + +```typescript +/** @override */ +appendToArgList(argList: string[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| argList | string[] | the parsed strings will be appended to this string array | + +Returns: + +`void` + +## Remarks + +Sometimes a command line parameter is not used directly, but instead gets passed through to another tool that will use it. For example if our parameter comes in as "--max-count 3", then we might want to call `child_process.spawn()` and append \["--max-count", "3"\] to the args array for that tool. appendToArgList() appends zero or more strings to the provided array, based on the input command-line that we parsed. + +If the parameter was omitted from our command-line and has no default value, then nothing will be appended. If the short name was used, the long name will be appended instead. + diff --git a/pages/api/ts-command-line.commandlinestringlistparameter.kind.md b/pages/api/ts-command-line.commandlinestringlistparameter.kind.md new file mode 100644 index 000000000..de9cac18e --- /dev/null +++ b/pages/api/ts-command-line.commandlinestringlistparameter.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineStringListParameter](./ts-command-line.commandlinestringlistparameter.md) > [kind](./ts-command-line.commandlinestringlistparameter.kind.md) + +## CommandLineStringListParameter.kind property + +Indicates the type of parameter. + +Signature: + +```typescript +readonly kind: CommandLineParameterKind; +``` diff --git a/pages/api/ts-command-line.commandlinestringlistparameter.md b/pages/api/ts-command-line.commandlinestringlistparameter.md new file mode 100644 index 000000000..ff844504b --- /dev/null +++ b/pages/api/ts-command-line.commandlinestringlistparameter.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineStringListParameter](./ts-command-line.commandlinestringlistparameter.md) + +## CommandLineStringListParameter class + +The data type returned by [CommandLineParameterProvider.defineStringListParameter()](./ts-command-line.commandlineparameterprovider.definestringlistparameter.md). + +Signature: + +```typescript +export declare class CommandLineStringListParameter extends CommandLineParameterWithArgument +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [kind](./ts-command-line.commandlinestringlistparameter.kind.md) | | CommandLineParameterKind | Indicates the type of parameter. | +| [values](./ts-command-line.commandlinestringlistparameter.values.md) | | ReadonlyArray<string> | Returns the string arguments for a string list parameter that was parsed from the command line. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [appendToArgList(argList)](./ts-command-line.commandlinestringlistparameter.appendtoarglist.md) | | Append the parsed values to the provided string array. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CommandLineStringListParameter` class. + diff --git a/pages/api/ts-command-line.commandlinestringlistparameter.values.md b/pages/api/ts-command-line.commandlinestringlistparameter.values.md new file mode 100644 index 000000000..87717c75a --- /dev/null +++ b/pages/api/ts-command-line.commandlinestringlistparameter.values.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineStringListParameter](./ts-command-line.commandlinestringlistparameter.md) > [values](./ts-command-line.commandlinestringlistparameter.values.md) + +## CommandLineStringListParameter.values property + +Returns the string arguments for a string list parameter that was parsed from the command line. + +Signature: + +```typescript +readonly values: ReadonlyArray; +``` + +## Remarks + +The array will be empty if the command-line has not been parsed yet, or if the parameter was omitted and has no default value. + diff --git a/pages/api/ts-command-line.commandlinestringparameter.appendtoarglist.md b/pages/api/ts-command-line.commandlinestringparameter.appendtoarglist.md new file mode 100644 index 000000000..dd77785d4 --- /dev/null +++ b/pages/api/ts-command-line.commandlinestringparameter.appendtoarglist.md @@ -0,0 +1,36 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineStringParameter](./ts-command-line.commandlinestringparameter.md) > [appendToArgList](./ts-command-line.commandlinestringparameter.appendtoarglist.md) + +## CommandLineStringParameter.appendToArgList() method + +Append the parsed values to the provided string array. + +Signature: + +```typescript +/** @override */ +appendToArgList(argList: string[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| argList | string[] | the parsed strings will be appended to this string array | + +Returns: + +`void` + +## Remarks + +Sometimes a command line parameter is not used directly, but instead gets passed through to another tool that will use it. For example if our parameter comes in as "--max-count 3", then we might want to call `child_process.spawn()` and append \["--max-count", "3"\] to the args array for that tool. appendToArgList() appends zero or more strings to the provided array, based on the input command-line that we parsed. + +If the parameter was omitted from our command-line and has no default value, then nothing will be appended. If the short name was used, the long name will be appended instead. + diff --git a/pages/api/ts-command-line.commandlinestringparameter.defaultvalue.md b/pages/api/ts-command-line.commandlinestringparameter.defaultvalue.md new file mode 100644 index 000000000..d00373265 --- /dev/null +++ b/pages/api/ts-command-line.commandlinestringparameter.defaultvalue.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineStringParameter](./ts-command-line.commandlinestringparameter.md) > [defaultValue](./ts-command-line.commandlinestringparameter.defaultvalue.md) + +## CommandLineStringParameter.defaultValue property + +The default value which will be used if the parameter is omitted from the command line. + +Signature: + +```typescript +readonly defaultValue: string | undefined; +``` + +## Remarks + +If a default value is specified, then [IBaseCommandLineDefinition.required](./ts-command-line.ibasecommandlinedefinition.required.md) must not be true. Instead, a custom error message should be used to report cases where a default value was not available. + diff --git a/pages/api/ts-command-line.commandlinestringparameter.kind.md b/pages/api/ts-command-line.commandlinestringparameter.kind.md new file mode 100644 index 000000000..b566d5efd --- /dev/null +++ b/pages/api/ts-command-line.commandlinestringparameter.kind.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineStringParameter](./ts-command-line.commandlinestringparameter.md) > [kind](./ts-command-line.commandlinestringparameter.kind.md) + +## CommandLineStringParameter.kind property + +Indicates the type of parameter. + +Signature: + +```typescript +readonly kind: CommandLineParameterKind; +``` diff --git a/pages/api/ts-command-line.commandlinestringparameter.md b/pages/api/ts-command-line.commandlinestringparameter.md new file mode 100644 index 000000000..e9711215c --- /dev/null +++ b/pages/api/ts-command-line.commandlinestringparameter.md @@ -0,0 +1,37 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineStringParameter](./ts-command-line.commandlinestringparameter.md) + +## CommandLineStringParameter class + +The data type returned by [CommandLineParameterProvider.defineStringParameter()](./ts-command-line.commandlineparameterprovider.definestringparameter.md). + +Signature: + +```typescript +export declare class CommandLineStringParameter extends CommandLineParameterWithArgument +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [defaultValue](./ts-command-line.commandlinestringparameter.defaultvalue.md) | | string | undefined | The default value which will be used if the parameter is omitted from the command line. | +| [kind](./ts-command-line.commandlinestringparameter.kind.md) | | CommandLineParameterKind | Indicates the type of parameter. | +| [value](./ts-command-line.commandlinestringparameter.value.md) | | string | undefined | Returns the argument value for a string parameter that was parsed from the command line. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [appendToArgList(argList)](./ts-command-line.commandlinestringparameter.appendtoarglist.md) | | Append the parsed values to the provided string array. | + +## Remarks + +The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `CommandLineStringParameter` class. + diff --git a/pages/api/ts-command-line.commandlinestringparameter.value.md b/pages/api/ts-command-line.commandlinestringparameter.value.md new file mode 100644 index 000000000..8a7c7433c --- /dev/null +++ b/pages/api/ts-command-line.commandlinestringparameter.value.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [CommandLineStringParameter](./ts-command-line.commandlinestringparameter.md) > [value](./ts-command-line.commandlinestringparameter.value.md) + +## CommandLineStringParameter.value property + +Returns the argument value for a string parameter that was parsed from the command line. + +Signature: + +```typescript +readonly value: string | undefined; +``` + +## Remarks + +The return value will be undefined if the command-line has not been parsed yet, or if the parameter was omitted and has no default value. + diff --git a/pages/api/ts-command-line.dynamiccommandlineaction.md b/pages/api/ts-command-line.dynamiccommandlineaction.md new file mode 100644 index 000000000..0dd1e19b2 --- /dev/null +++ b/pages/api/ts-command-line.dynamiccommandlineaction.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [DynamicCommandLineAction](./ts-command-line.dynamiccommandlineaction.md) + +## DynamicCommandLineAction class + + +Signature: + +```typescript +export declare class DynamicCommandLineAction extends CommandLineAction +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [onDefineParameters()](./ts-command-line.dynamiccommandlineaction.ondefineparameters.md) | | | +| [onExecute()](./ts-command-line.dynamiccommandlineaction.onexecute.md) | | | + diff --git a/pages/api/ts-command-line.dynamiccommandlineaction.ondefineparameters.md b/pages/api/ts-command-line.dynamiccommandlineaction.ondefineparameters.md new file mode 100644 index 000000000..f9a48ad1b --- /dev/null +++ b/pages/api/ts-command-line.dynamiccommandlineaction.ondefineparameters.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [DynamicCommandLineAction](./ts-command-line.dynamiccommandlineaction.md) > [onDefineParameters](./ts-command-line.dynamiccommandlineaction.ondefineparameters.md) + +## DynamicCommandLineAction.onDefineParameters() method + +Signature: + +```typescript +protected onDefineParameters(): void; +``` +Returns: + +`void` + diff --git a/pages/api/ts-command-line.dynamiccommandlineaction.onexecute.md b/pages/api/ts-command-line.dynamiccommandlineaction.onexecute.md new file mode 100644 index 000000000..c4c62dded --- /dev/null +++ b/pages/api/ts-command-line.dynamiccommandlineaction.onexecute.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [DynamicCommandLineAction](./ts-command-line.dynamiccommandlineaction.md) > [onExecute](./ts-command-line.dynamiccommandlineaction.onexecute.md) + +## DynamicCommandLineAction.onExecute() method + +Signature: + +```typescript +protected onExecute(): Promise; +``` +Returns: + +`Promise` + diff --git a/pages/api/ts-command-line.dynamiccommandlineparser.md b/pages/api/ts-command-line.dynamiccommandlineparser.md new file mode 100644 index 000000000..427c1e5e7 --- /dev/null +++ b/pages/api/ts-command-line.dynamiccommandlineparser.md @@ -0,0 +1,24 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [DynamicCommandLineParser](./ts-command-line.dynamiccommandlineparser.md) + +## DynamicCommandLineParser class + + +Signature: + +```typescript +export declare class DynamicCommandLineParser extends CommandLineParser +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [onDefineParameters()](./ts-command-line.dynamiccommandlineparser.ondefineparameters.md) | | | + diff --git a/pages/api/ts-command-line.dynamiccommandlineparser.ondefineparameters.md b/pages/api/ts-command-line.dynamiccommandlineparser.ondefineparameters.md new file mode 100644 index 000000000..9adde8ec2 --- /dev/null +++ b/pages/api/ts-command-line.dynamiccommandlineparser.ondefineparameters.md @@ -0,0 +1,20 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [DynamicCommandLineParser](./ts-command-line.dynamiccommandlineparser.md) > [onDefineParameters](./ts-command-line.dynamiccommandlineparser.ondefineparameters.md) + +## DynamicCommandLineParser.onDefineParameters() method + +Signature: + +```typescript +protected onDefineParameters(): void; +``` +Returns: + +`void` + diff --git a/pages/api/ts-command-line.ibasecommandlinedefinition.description.md b/pages/api/ts-command-line.ibasecommandlinedefinition.description.md new file mode 100644 index 000000000..f095eff3b --- /dev/null +++ b/pages/api/ts-command-line.ibasecommandlinedefinition.description.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [IBaseCommandLineDefinition](./ts-command-line.ibasecommandlinedefinition.md) > [description](./ts-command-line.ibasecommandlinedefinition.description.md) + +## IBaseCommandLineDefinition.description property + +Documentation for the flag, that will be shown when invoking the tool with "--help" + +Signature: + +```typescript +description: string; +``` diff --git a/pages/api/ts-command-line.ibasecommandlinedefinition.environmentvariable.md b/pages/api/ts-command-line.ibasecommandlinedefinition.environmentvariable.md new file mode 100644 index 000000000..e8440c242 --- /dev/null +++ b/pages/api/ts-command-line.ibasecommandlinedefinition.environmentvariable.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [IBaseCommandLineDefinition](./ts-command-line.ibasecommandlinedefinition.md) > [environmentVariable](./ts-command-line.ibasecommandlinedefinition.environmentvariable.md) + +## IBaseCommandLineDefinition.environmentVariable property + +The name of an environment variable that the parameter value will be read from, if it was omitted from the command-line. An error will be reported if the environment value cannot be parsed. + +Signature: + +```typescript +environmentVariable?: string; +``` + +## Remarks + +The environment variable name must consist only of upper-case letters, numbers, and underscores. It may not start with a number. + +This feature cannot be used when [IBaseCommandLineDefinition.required](./ts-command-line.ibasecommandlinedefinition.required.md) is true, because in that case the environmentVariable would never be used. + diff --git a/pages/api/ts-command-line.ibasecommandlinedefinition.md b/pages/api/ts-command-line.ibasecommandlinedefinition.md new file mode 100644 index 000000000..e0f97648f --- /dev/null +++ b/pages/api/ts-command-line.ibasecommandlinedefinition.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [IBaseCommandLineDefinition](./ts-command-line.ibasecommandlinedefinition.md) + +## IBaseCommandLineDefinition interface + +For use with CommandLineParser, this interface represents a generic command-line parameter + +Signature: + +```typescript +export interface IBaseCommandLineDefinition +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [description](./ts-command-line.ibasecommandlinedefinition.description.md) | string | Documentation for the flag, that will be shown when invoking the tool with "--help" | +| [environmentVariable](./ts-command-line.ibasecommandlinedefinition.environmentvariable.md) | string | The name of an environment variable that the parameter value will be read from, if it was omitted from the command-line. An error will be reported if the environment value cannot be parsed. | +| [parameterLongName](./ts-command-line.ibasecommandlinedefinition.parameterlongname.md) | string | The long name of the flag including double dashes, e.g. "--do-something" | +| [parameterShortName](./ts-command-line.ibasecommandlinedefinition.parametershortname.md) | string | An optional short name for the flag including the dash, e.g. "-d" | +| [required](./ts-command-line.ibasecommandlinedefinition.required.md) | boolean | If true, then an error occurs if the parameter was not included on the command-line. | + diff --git a/pages/api/ts-command-line.ibasecommandlinedefinition.parameterlongname.md b/pages/api/ts-command-line.ibasecommandlinedefinition.parameterlongname.md new file mode 100644 index 000000000..cbea8d110 --- /dev/null +++ b/pages/api/ts-command-line.ibasecommandlinedefinition.parameterlongname.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [IBaseCommandLineDefinition](./ts-command-line.ibasecommandlinedefinition.md) > [parameterLongName](./ts-command-line.ibasecommandlinedefinition.parameterlongname.md) + +## IBaseCommandLineDefinition.parameterLongName property + +The long name of the flag including double dashes, e.g. "--do-something" + +Signature: + +```typescript +parameterLongName: string; +``` diff --git a/pages/api/ts-command-line.ibasecommandlinedefinition.parametershortname.md b/pages/api/ts-command-line.ibasecommandlinedefinition.parametershortname.md new file mode 100644 index 000000000..ce4bd5b2f --- /dev/null +++ b/pages/api/ts-command-line.ibasecommandlinedefinition.parametershortname.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [IBaseCommandLineDefinition](./ts-command-line.ibasecommandlinedefinition.md) > [parameterShortName](./ts-command-line.ibasecommandlinedefinition.parametershortname.md) + +## IBaseCommandLineDefinition.parameterShortName property + +An optional short name for the flag including the dash, e.g. "-d" + +Signature: + +```typescript +parameterShortName?: string; +``` diff --git a/pages/api/ts-command-line.ibasecommandlinedefinition.required.md b/pages/api/ts-command-line.ibasecommandlinedefinition.required.md new file mode 100644 index 000000000..d88d26b9f --- /dev/null +++ b/pages/api/ts-command-line.ibasecommandlinedefinition.required.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [IBaseCommandLineDefinition](./ts-command-line.ibasecommandlinedefinition.md) > [required](./ts-command-line.ibasecommandlinedefinition.required.md) + +## IBaseCommandLineDefinition.required property + +If true, then an error occurs if the parameter was not included on the command-line. + +Signature: + +```typescript +required?: boolean; +``` diff --git a/pages/api/ts-command-line.ibasecommandlinedefinitionwithargument.argumentname.md b/pages/api/ts-command-line.ibasecommandlinedefinitionwithargument.argumentname.md new file mode 100644 index 000000000..f3a25378d --- /dev/null +++ b/pages/api/ts-command-line.ibasecommandlinedefinitionwithargument.argumentname.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [IBaseCommandLineDefinitionWithArgument](./ts-command-line.ibasecommandlinedefinitionwithargument.md) > [argumentName](./ts-command-line.ibasecommandlinedefinitionwithargument.argumentname.md) + +## IBaseCommandLineDefinitionWithArgument.argumentName property + +The name of the argument, which will be shown in the command-line help. + +Signature: + +```typescript +argumentName: string; +``` + +## Remarks + +For example, if the parameter name is '--count" and the argument name is "NUMBER", then the command-line help would display "--count NUMBER". The argument name must be comprised of upper-case letters, numbers, and underscores. It should be kept short. + diff --git a/pages/api/ts-command-line.ibasecommandlinedefinitionwithargument.md b/pages/api/ts-command-line.ibasecommandlinedefinitionwithargument.md new file mode 100644 index 000000000..d6b5b1cfc --- /dev/null +++ b/pages/api/ts-command-line.ibasecommandlinedefinitionwithargument.md @@ -0,0 +1,29 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [IBaseCommandLineDefinitionWithArgument](./ts-command-line.ibasecommandlinedefinitionwithargument.md) + +## IBaseCommandLineDefinitionWithArgument interface + +The common base interface for parameter types that accept an argument. + +Signature: + +```typescript +export interface IBaseCommandLineDefinitionWithArgument extends IBaseCommandLineDefinition +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [argumentName](./ts-command-line.ibasecommandlinedefinitionwithargument.argumentname.md) | string | The name of the argument, which will be shown in the command-line help. | + +## Remarks + +An argument is an accompanying command-line token, such as "123" in the example "--max-count 123". + diff --git a/pages/api/ts-command-line.icommandlineactionoptions.actionname.md b/pages/api/ts-command-line.icommandlineactionoptions.actionname.md new file mode 100644 index 000000000..5e7ebeffb --- /dev/null +++ b/pages/api/ts-command-line.icommandlineactionoptions.actionname.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [ICommandLineActionOptions](./ts-command-line.icommandlineactionoptions.md) > [actionName](./ts-command-line.icommandlineactionoptions.actionname.md) + +## ICommandLineActionOptions.actionName property + +The name of the action. For example, if the tool is called "example", then the "build" action might be invoked as: "example build -q --some-other-option" + +Signature: + +```typescript +actionName: string; +``` diff --git a/pages/api/ts-command-line.icommandlineactionoptions.documentation.md b/pages/api/ts-command-line.icommandlineactionoptions.documentation.md new file mode 100644 index 000000000..5d01a9236 --- /dev/null +++ b/pages/api/ts-command-line.icommandlineactionoptions.documentation.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [ICommandLineActionOptions](./ts-command-line.icommandlineactionoptions.md) > [documentation](./ts-command-line.icommandlineactionoptions.documentation.md) + +## ICommandLineActionOptions.documentation property + +A detailed description that is shown on the action help page, which is displayed by the command "example build --help", e.g. for actionName="build". + +Signature: + +```typescript +documentation: string; +``` diff --git a/pages/api/ts-command-line.icommandlineactionoptions.md b/pages/api/ts-command-line.icommandlineactionoptions.md new file mode 100644 index 000000000..4cc9d45a9 --- /dev/null +++ b/pages/api/ts-command-line.icommandlineactionoptions.md @@ -0,0 +1,27 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [ICommandLineActionOptions](./ts-command-line.icommandlineactionoptions.md) + +## ICommandLineActionOptions interface + +Options for the CommandLineAction constructor. + +Signature: + +```typescript +export interface ICommandLineActionOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [actionName](./ts-command-line.icommandlineactionoptions.actionname.md) | string | The name of the action. For example, if the tool is called "example", then the "build" action might be invoked as: "example build -q --some-other-option" | +| [documentation](./ts-command-line.icommandlineactionoptions.documentation.md) | string | A detailed description that is shown on the action help page, which is displayed by the command "example build --help", e.g. for actionName="build". | +| [summary](./ts-command-line.icommandlineactionoptions.summary.md) | string | A quick summary that is shown on the main help page, which is displayed by the command "example --help" | + diff --git a/pages/api/ts-command-line.icommandlineactionoptions.summary.md b/pages/api/ts-command-line.icommandlineactionoptions.summary.md new file mode 100644 index 000000000..f506638d1 --- /dev/null +++ b/pages/api/ts-command-line.icommandlineactionoptions.summary.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [ICommandLineActionOptions](./ts-command-line.icommandlineactionoptions.md) > [summary](./ts-command-line.icommandlineactionoptions.summary.md) + +## ICommandLineActionOptions.summary property + +A quick summary that is shown on the main help page, which is displayed by the command "example --help" + +Signature: + +```typescript +summary: string; +``` diff --git a/pages/api/ts-command-line.icommandlinechoicedefinition.alternatives.md b/pages/api/ts-command-line.icommandlinechoicedefinition.alternatives.md new file mode 100644 index 000000000..dd5650709 --- /dev/null +++ b/pages/api/ts-command-line.icommandlinechoicedefinition.alternatives.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [ICommandLineChoiceDefinition](./ts-command-line.icommandlinechoicedefinition.md) > [alternatives](./ts-command-line.icommandlinechoicedefinition.alternatives.md) + +## ICommandLineChoiceDefinition.alternatives property + +A list of strings (which contain no spaces), of possible options which can be selected + +Signature: + +```typescript +alternatives: string[]; +``` diff --git a/pages/api/ts-command-line.icommandlinechoicedefinition.defaultvalue.md b/pages/api/ts-command-line.icommandlinechoicedefinition.defaultvalue.md new file mode 100644 index 000000000..548879b35 --- /dev/null +++ b/pages/api/ts-command-line.icommandlinechoicedefinition.defaultvalue.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [ICommandLineChoiceDefinition](./ts-command-line.icommandlinechoicedefinition.md) > [defaultValue](./ts-command-line.icommandlinechoicedefinition.defaultvalue.md) + +## ICommandLineChoiceDefinition.defaultValue property + +The default value which will be used if the parameter is omitted from the command line. + +Signature: + +```typescript +defaultValue?: string; +``` + +## Remarks + +If a default value is specified, then [IBaseCommandLineDefinition.required](./ts-command-line.ibasecommandlinedefinition.required.md) must not be true. Instead, a custom error message should be used to report cases where a default value was not available. + diff --git a/pages/api/ts-command-line.icommandlinechoicedefinition.md b/pages/api/ts-command-line.icommandlinechoicedefinition.md new file mode 100644 index 000000000..eb8ed511c --- /dev/null +++ b/pages/api/ts-command-line.icommandlinechoicedefinition.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [ICommandLineChoiceDefinition](./ts-command-line.icommandlinechoicedefinition.md) + +## ICommandLineChoiceDefinition interface + +For use with CommandLineParser, this interface represents a parameter which is constrained to a list of possible options + +Signature: + +```typescript +export interface ICommandLineChoiceDefinition extends IBaseCommandLineDefinition +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [alternatives](./ts-command-line.icommandlinechoicedefinition.alternatives.md) | string[] | A list of strings (which contain no spaces), of possible options which can be selected | +| [defaultValue](./ts-command-line.icommandlinechoicedefinition.defaultvalue.md) | string | The default value which will be used if the parameter is omitted from the command line. | + diff --git a/pages/api/ts-command-line.icommandlineflagdefinition.md b/pages/api/ts-command-line.icommandlineflagdefinition.md new file mode 100644 index 000000000..05f789f24 --- /dev/null +++ b/pages/api/ts-command-line.icommandlineflagdefinition.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [ICommandLineFlagDefinition](./ts-command-line.icommandlineflagdefinition.md) + +## ICommandLineFlagDefinition interface + +For use with CommandLineParser, this interface represents a command line parameter that is a boolean flag. + +Signature: + +```typescript +export interface ICommandLineFlagDefinition extends IBaseCommandLineDefinition +``` diff --git a/pages/api/ts-command-line.icommandlineintegerdefinition.defaultvalue.md b/pages/api/ts-command-line.icommandlineintegerdefinition.defaultvalue.md new file mode 100644 index 000000000..2f7a894b7 --- /dev/null +++ b/pages/api/ts-command-line.icommandlineintegerdefinition.defaultvalue.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [ICommandLineIntegerDefinition](./ts-command-line.icommandlineintegerdefinition.md) > [defaultValue](./ts-command-line.icommandlineintegerdefinition.defaultvalue.md) + +## ICommandLineIntegerDefinition.defaultValue property + +The default value which will be used if the parameter is omitted from the command line. + +Signature: + +```typescript +defaultValue?: number; +``` + +## Remarks + +If a default value is specified, then [IBaseCommandLineDefinition.required](./ts-command-line.ibasecommandlinedefinition.required.md) must not be true. Instead, a custom error message should be used to report cases where a default value was not available. + diff --git a/pages/api/ts-command-line.icommandlineintegerdefinition.md b/pages/api/ts-command-line.icommandlineintegerdefinition.md new file mode 100644 index 000000000..5b4e51021 --- /dev/null +++ b/pages/api/ts-command-line.icommandlineintegerdefinition.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [ICommandLineIntegerDefinition](./ts-command-line.icommandlineintegerdefinition.md) + +## ICommandLineIntegerDefinition interface + +For use with CommandLineParser, this interface represents a command line parameter whose argument is an integer value. + +Signature: + +```typescript +export interface ICommandLineIntegerDefinition extends IBaseCommandLineDefinitionWithArgument +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [defaultValue](./ts-command-line.icommandlineintegerdefinition.defaultvalue.md) | number | The default value which will be used if the parameter is omitted from the command line. | + diff --git a/pages/api/ts-command-line.icommandlineparseroptions.md b/pages/api/ts-command-line.icommandlineparseroptions.md new file mode 100644 index 000000000..3d9ea1d1d --- /dev/null +++ b/pages/api/ts-command-line.icommandlineparseroptions.md @@ -0,0 +1,26 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [ICommandLineParserOptions](./ts-command-line.icommandlineparseroptions.md) + +## ICommandLineParserOptions interface + +Options for the [CommandLineParser](./ts-command-line.commandlineparser.md) constructor. + +Signature: + +```typescript +export interface ICommandLineParserOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [toolDescription](./ts-command-line.icommandlineparseroptions.tooldescription.md) | string | General documentation that is included in the "--help" main page | +| [toolFilename](./ts-command-line.icommandlineparseroptions.toolfilename.md) | string | The name of your tool when invoked from the command line | + diff --git a/pages/api/ts-command-line.icommandlineparseroptions.tooldescription.md b/pages/api/ts-command-line.icommandlineparseroptions.tooldescription.md new file mode 100644 index 000000000..76757c851 --- /dev/null +++ b/pages/api/ts-command-line.icommandlineparseroptions.tooldescription.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [ICommandLineParserOptions](./ts-command-line.icommandlineparseroptions.md) > [toolDescription](./ts-command-line.icommandlineparseroptions.tooldescription.md) + +## ICommandLineParserOptions.toolDescription property + +General documentation that is included in the "--help" main page + +Signature: + +```typescript +toolDescription: string; +``` diff --git a/pages/api/ts-command-line.icommandlineparseroptions.toolfilename.md b/pages/api/ts-command-line.icommandlineparseroptions.toolfilename.md new file mode 100644 index 000000000..c9eab60f0 --- /dev/null +++ b/pages/api/ts-command-line.icommandlineparseroptions.toolfilename.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [ICommandLineParserOptions](./ts-command-line.icommandlineparseroptions.md) > [toolFilename](./ts-command-line.icommandlineparseroptions.toolfilename.md) + +## ICommandLineParserOptions.toolFilename property + +The name of your tool when invoked from the command line + +Signature: + +```typescript +toolFilename: string; +``` diff --git a/pages/api/ts-command-line.icommandlinestringdefinition.defaultvalue.md b/pages/api/ts-command-line.icommandlinestringdefinition.defaultvalue.md new file mode 100644 index 000000000..a39f94b6c --- /dev/null +++ b/pages/api/ts-command-line.icommandlinestringdefinition.defaultvalue.md @@ -0,0 +1,23 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [ICommandLineStringDefinition](./ts-command-line.icommandlinestringdefinition.md) > [defaultValue](./ts-command-line.icommandlinestringdefinition.defaultvalue.md) + +## ICommandLineStringDefinition.defaultValue property + +The default value which will be used if the parameter is omitted from the command line. + +Signature: + +```typescript +defaultValue?: string; +``` + +## Remarks + +If a default value is specified, then [IBaseCommandLineDefinition.required](./ts-command-line.ibasecommandlinedefinition.required.md) must not be true. Instead, a custom error message should be used to report cases where a default value was not available. + diff --git a/pages/api/ts-command-line.icommandlinestringdefinition.md b/pages/api/ts-command-line.icommandlinestringdefinition.md new file mode 100644 index 000000000..7357e70f2 --- /dev/null +++ b/pages/api/ts-command-line.icommandlinestringdefinition.md @@ -0,0 +1,25 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [ICommandLineStringDefinition](./ts-command-line.icommandlinestringdefinition.md) + +## ICommandLineStringDefinition interface + +For use with CommandLineParser, this interface represents a command line parameter whose argument is a string value. + +Signature: + +```typescript +export interface ICommandLineStringDefinition extends IBaseCommandLineDefinitionWithArgument +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [defaultValue](./ts-command-line.icommandlinestringdefinition.defaultvalue.md) | string | The default value which will be used if the parameter is omitted from the command line. | + diff --git a/pages/api/ts-command-line.icommandlinestringlistdefinition.md b/pages/api/ts-command-line.icommandlinestringlistdefinition.md new file mode 100644 index 000000000..536090656 --- /dev/null +++ b/pages/api/ts-command-line.icommandlinestringlistdefinition.md @@ -0,0 +1,18 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) > [ICommandLineStringListDefinition](./ts-command-line.icommandlinestringlistdefinition.md) + +## ICommandLineStringListDefinition interface + +For use with CommandLineParser, this interface represents a command line parameter whose argument is a list of strings. + +Signature: + +```typescript +export interface ICommandLineStringListDefinition extends IBaseCommandLineDefinitionWithArgument +``` diff --git a/pages/api/ts-command-line.md b/pages/api/ts-command-line.md new file mode 100644 index 000000000..8915b8403 --- /dev/null +++ b/pages/api/ts-command-line.md @@ -0,0 +1,50 @@ +--- +layout: page +navigation_source: api_nav +improve_this_button: false +--- + + +[Home](./index.md) > [@microsoft/ts-command-line](./ts-command-line.md) + +## ts-command-line package + +An object-oriented command-line parser for TypeScript projects. + +## Classes + +| Class | Description | +| --- | --- | +| [CommandLineAction](./ts-command-line.commandlineaction.md) | Represents a sub-command that is part of the CommandLineParser command line. Applications should create subclasses of CommandLineAction corresponding to each action that they want to expose.The action name should be comprised of lower case words separated by hyphens or colons. The name should include an English verb (e.g. "deploy"). Use a hyphen to separate words (e.g. "upload-docs"). A group of related commands can be prefixed with a colon (e.g. "docs:generate", "docs:deploy", "docs:serve", etc). | +| [CommandLineChoiceParameter](./ts-command-line.commandlinechoiceparameter.md) | The data type returned by [CommandLineParameterProvider.defineChoiceParameter()](./ts-command-line.commandlineparameterprovider.definechoiceparameter.md). | +| [CommandLineFlagParameter](./ts-command-line.commandlineflagparameter.md) | The data type returned by [CommandLineParameterProvider.defineFlagParameter()](./ts-command-line.commandlineparameterprovider.defineflagparameter.md). | +| [CommandLineIntegerParameter](./ts-command-line.commandlineintegerparameter.md) | The data type returned by [CommandLineParameterProvider.defineIntegerParameter()](./ts-command-line.commandlineparameterprovider.defineintegerparameter.md). | +| [CommandLineParameter](./ts-command-line.commandlineparameter.md) | The base class for the various command-line parameter types. | +| [CommandLineParameterProvider](./ts-command-line.commandlineparameterprovider.md) | This is the common base class for CommandLineAction and CommandLineParser that provides functionality for defining command-line parameters. | +| [CommandLineParameterWithArgument](./ts-command-line.commandlineparameterwithargument.md) | The common base class for parameters types that receive an argument. | +| [CommandLineParser](./ts-command-line.commandlineparser.md) | The "argparse" library is a relatively advanced command-line parser with features such as word-wrapping and intelligible error messages (that are lacking in other similar libraries such as commander, yargs, and nomnom). Unfortunately, its ruby-inspired API is awkward to use. The abstract base classes CommandLineParser and CommandLineAction provide a wrapper for "argparse" that makes defining and consuming arguments quick and simple, and enforces that appropriate documentation is provided for each parameter. | +| [CommandLineStringListParameter](./ts-command-line.commandlinestringlistparameter.md) | The data type returned by [CommandLineParameterProvider.defineStringListParameter()](./ts-command-line.commandlineparameterprovider.definestringlistparameter.md). | +| [CommandLineStringParameter](./ts-command-line.commandlinestringparameter.md) | The data type returned by [CommandLineParameterProvider.defineStringParameter()](./ts-command-line.commandlineparameterprovider.definestringparameter.md). | +| [DynamicCommandLineAction](./ts-command-line.dynamiccommandlineaction.md) | | +| [DynamicCommandLineParser](./ts-command-line.dynamiccommandlineparser.md) | | + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [CommandLineParameterKind](./ts-command-line.commandlineparameterkind.md) | Identifies the kind of a CommandLineParameter. | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [IBaseCommandLineDefinition](./ts-command-line.ibasecommandlinedefinition.md) | For use with CommandLineParser, this interface represents a generic command-line parameter | +| [IBaseCommandLineDefinitionWithArgument](./ts-command-line.ibasecommandlinedefinitionwithargument.md) | The common base interface for parameter types that accept an argument. | +| [ICommandLineActionOptions](./ts-command-line.icommandlineactionoptions.md) | Options for the CommandLineAction constructor. | +| [ICommandLineChoiceDefinition](./ts-command-line.icommandlinechoicedefinition.md) | For use with CommandLineParser, this interface represents a parameter which is constrained to a list of possible options | +| [ICommandLineFlagDefinition](./ts-command-line.icommandlineflagdefinition.md) | For use with CommandLineParser, this interface represents a command line parameter that is a boolean flag. | +| [ICommandLineIntegerDefinition](./ts-command-line.icommandlineintegerdefinition.md) | For use with CommandLineParser, this interface represents a command line parameter whose argument is an integer value. | +| [ICommandLineParserOptions](./ts-command-line.icommandlineparseroptions.md) | Options for the [CommandLineParser](./ts-command-line.commandlineparser.md) constructor. | +| [ICommandLineStringDefinition](./ts-command-line.icommandlinestringdefinition.md) | For use with CommandLineParser, this interface represents a command line parameter whose argument is a string value. | +| [ICommandLineStringListDefinition](./ts-command-line.icommandlinestringlistdefinition.md) | For use with CommandLineParser, this interface represents a command line parameter whose argument is a list of strings. | +