/***ConfigfileforAPIExtractor.Formoreinfo,pleasevisit:https://api-extractor.com*/{"$schema":"https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",/***OptionallyspecifiesanotherJSONconfigfilethatthisfileextendsfrom.Thisprovidesawayfor*standardsettingstobesharedacrossmultipleprojects.**Ifthepathstartswith"./"or"../",thepathisresolvedrelativetothefolderofthefilethatcontains*the"extends"field.Otherwise,thefirstpathsegmentisinterpretedasanNPMpackagename,andwillbe*resolvedusingNodeJSrequire().**SUPPORTEDTOKENS:none*DEFAULTVALUE:""*///"extends":"./shared/api-extractor-base.json"//"extends":"my-package/include/api-extractor-base.json"/***Determinesthe"<projectFolder>"tokenthatcanbeusedwithotherconfigfilesettings.Theprojectfolder*typicallycontainsthetsconfig.jsonandpackage.jsonconfigfiles,butthepathisuser-defined.**Thepathisresolvedrelativetothefolderoftheconfigfilethatcontainsthesetting.**Thedefaultvaluefor"projectFolder"isthetoken"<lookup>",whichmeansthefolderisdeterminedbytraversing*parentfolders,startingfromthefoldercontainingapi-extractor.json,andstoppingatthefirstfolder*thatcontainsatsconfig.jsonfile.Ifatsconfig.jsonfilecannotbefoundinthisway,thenanerror*willbereported.**SUPPORTEDTOKENS:<lookup>*DEFAULTVALUE:"<lookup>"*///"projectFolder":"..",/***(REQUIRED)Specifiesthe.d.tsfiletobeusedasthestartingpointforanalysis.APIExtractor*analyzesthesymbolsexportedbythismodule.**Thefileextensionmustbe".d.ts"andnot".ts".**Thepathisresolvedrelativetothefolderoftheconfigfilethatcontainsthesetting;tochangethis,*prependafoldertokensuchas"<projectFolder>".**SUPPORTEDTOKENS:<projectFolder>,<packageName>,<unscopedPackageName>*/"mainEntryPointFilePath":"dist/index.d.ts",/***AlistofNPMpackagenameswhoseexportsshouldbetreatedaspartofthispackage.**Forexample,supposethatWebpackisusedtogenerateadistributedbundlefortheproject"library1",*andanotherNPMpackage"library2"isembeddedinthisbundle.Sometypesfromlibrary2maybecomepart*oftheexportedAPIforlibrary1,butbydefaultAPIExtractorwouldgeneratea.d.tsrollupthatexplicitly*importslibrary2.Toavoidthis,wecanspecify:**"bundledPackages":["library2"],**ThiswoulddirectAPIExtractortoembedthosetypesdirectlyinthe.d.tsrollup,asiftheyhadbeen*localfilesforlibrary1.*/"bundledPackages":[],/***DetermineshowtheTypeScriptcompilerenginewillbeinvokedbyAPIExtractor.*/"compiler":{/***Specifiesthepathtothetsconfig.jsonfiletobeusedbyAPIExtractorwhenanalyzingtheproject.**Thepathisresolvedrelativetothefolderoftheconfigfilethatcontainsthesetting;tochangethis,*prependafoldertokensuchas"<projectFolder>".**Note:Thissettingwillbeignoredif"overrideTsconfig"isused.**SUPPORTEDTOKENS:<projectFolder>,<packageName>,<unscopedPackageName>*DEFAULTVALUE:"<projectFolder>/tsconfig.json"*///"tsconfigFilePath":"<projectFolder>/tsconfig.json",/***Providesacompilerconfigurationthatwillbeusedinsteadofreadingthetsconfig.jsonfilefromdisk.*TheobjectmustconformtotheTypeScripttsconfigschema:**http://json.schemastore.org/tsconfig**Ifomitted,thenthetsconfig.jsonfilewillbereadfromthe"projectFolder".**DEFAULTVALUE:nooverrideTsconfigsection*///"overrideTsconfig":{//...//}/***Thisoptioncausesthecompilertobeinvokedwiththe--skipLibCheckoption.Thisoptionisnotrecommended*andmaycauseAPIExtractortoproduceincompleteorincorrectdeclarations,butitmayberequiredwhen*dependenciescontaindeclarationsthatareincompatiblewiththeTypeScriptenginethatAPIExtractoruses*foritsanalysis.Wherepossible,theunderlyingissueshouldbefixedratherthanrelyingonskipLibCheck.**DEFAULTVALUE:false*///"skipLibCheck":true,},/***ConfigureshowtheAPIreportfile(*.api.md)willbegenerated.*/"apiReport":{/***(REQUIRED)WhethertogenerateanAPIreport.*/"enabled":false/***ThefilenamefortheAPIreportfiles.Itwillbecombinedwith"reportFolder"or"reportTempFolder"toproduce*afullfilepath.**Thefileextensionshouldbe".api.md",andthestringshouldnotcontainapathseparatorsuchas"\" or "/".** SUPPORTED TOKENS: <packageName>, <unscopedPackageName>* DEFAULT VALUE: "<unscopedPackageName>.api.md"*/// "reportFileName": "<unscopedPackageName>.api.md",/*** Specifies the folder where the API report file is written. The file name portion is determined by* the "reportFileName" setting.** 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 "<projectFolder>".** SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>* DEFAULT VALUE: "<projectFolder>/temp/"*/// "reportFolder": "<projectFolder>/temp/",/*** Specifies the folder where the temporary report file is written. The file name portion is determined by* the "reportFileName" setting.** 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 "<projectFolder>".** SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>* DEFAULT VALUE: "<projectFolder>/temp/"*/// "reportTempFolder": "<projectFolder>/temp/"},/*** Configures how the doc model file (*.api.json) will be generated.*/"docModel": {/*** (REQUIRED) Whether to generate a doc model file.*/"enabled": true/*** The output path for the doc model file. The file extension should be ".api.json".** 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 "<projectFolder>".** SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>* DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json"*/// "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json"},/*** Configures how the .d.ts rollup file will be generated.*/"dtsRollup": {/*** (REQUIRED) Whether to generate the .d.ts rollup file.*/"enabled": true,/*** Specifies the output path for a .d.ts rollup file to be generated without any trimming.* 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 "<projectFolder>".** SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>* DEFAULT VALUE: "<projectFolder>/dist/<unscopedPackageName>.d.ts"*/"untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>_rollup.d.ts"/*** Specifies the output path for a .d.ts rollup file to be generated with trimming for an "alpha" release.* This file will include only declarations that are marked as "@public", "@beta", or "@alpha".** 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 "<projectFolder>".** SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>* DEFAULT VALUE: ""*/// "alphaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-alpha.d.ts",/*** Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release.* 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 "<projectFolder>".** SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>* DEFAULT VALUE: ""*/// "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-beta.d.ts",/*** Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release.* 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 "<projectFolder>".** SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>* DEFAULT VALUE: ""*/// "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts",/*** When a declaration is trimmed, by default it will be replaced by a code comment such as* "Excludedfromthisreleasetype:exampleMember". Set "omitTrimmingComments" to true to remove the* declaration completely.** DEFAULT VALUE: false*/// "omitTrimmingComments": true},/*** Configures how the tsdoc-metadata.json file will be generated.*/"tsdocMetadata": {/*** Whether to generate the tsdoc-metadata.json file.** DEFAULT VALUE: true*/// "enabled": true,/*** Specifies where the TSDoc metadata file should 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 "<projectFolder>".** The default value is "<lookup>", 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.** SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>* DEFAULT VALUE: "<lookup>"*/// "tsdocMetadataFilePath": "<projectFolder>/dist/tsdoc-metadata.json"},/*** Specifies what type of newlines API Extractor should use when writing output files. By default, the output files* will be written with Windows-style newlines. To use POSIX-style newlines, specify "lf" instead.* To use the OS's default newline kind, specify "os".** DEFAULT VALUE: "crlf"*/// "newlineKind": "crlf",/*** Configures how API Extractor reports error and warning messages produced during analysis.** There are three sources of messages: compiler messages, API Extractor messages, and TSDoc messages.*/"messages": {/*** Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing* the input .d.ts files.** TypeScript message identifiers start with "TS" followed by an integer. For example: "TS2551"** DEFAULT VALUE: A single "default" entry with logLevel=warning.*/"compilerMessageReporting": {/*** Configures the default routing for messages that don't match an explicit rule in this table.*/"default": {/*** Specifies whether the message should be written to the the tool's output log. Note that* the "addToApiReportFile" property may supersede this option.** Possible values: "error", "warning", "none"** Errors cause the build to fail and return a nonzero exit code. Warnings cause a production build fail* and return a nonzero exit code. For a non-production build (e.g. when "api-extractorrun" includes* the "--local" option), the warning is displayed but the build will not fail.** DEFAULT VALUE: "warning"*/"logLevel": "warning"/*** 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.** DEFAULT VALUE: false*/// "addToApiReportFile": false}// "TS2551": {// "logLevel": "warning",// "addToApiReportFile": true// },//// . . .},/*** Configures handling of messages reported by API Extractor during its analysis.** API Extractor message identifiers start with "ae-". For example: "ae-extra-release-tag"** DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings*/"extractorMessageReporting": {"default": {"logLevel": "warning"// "addToApiReportFile": false},// We don't use `@public`, that's just the default."ae-missing-release-tag": {"logLevel": "none"},// Needs investigation."ae-forgotten-export": {"logLevel": "none"}},/*** Configures handling of messages reported by the TSDoc parser when analyzing code comments.** TSDoc message identifiers start with "tsdoc-". For example: "tsdoc-link-tag-unescaped-text"** DEFAULT VALUE: A single "default" entry with logLevel=warning.*/"tsdocMessageReporting": {"default": {"logLevel": "warning"// "addToApiReportFile": false},"tsdoc-param-tag-missing-hyphen": {"logLevel": "none"},// These two are due to "type-like" tags in JsDoc like// `@suppress {warningName}`. The braces are unexpected in TsDoc."tsdoc-malformed-inline-tag": {"logLevel": "none"},"tsdoc-escape-right-brace": {"logLevel": "none"}}}}
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。