microsoft
/
rushstack.io-website
зеркало из https://github.com/microsoft/rushstack.io-website.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Merge pull request #10 from microsoft/octogonz/refresh-api-docs 

Refresh API docs
This commit is contained in:
Pete Gonzalez 2020-03-12 17:37:04 -07:00 коммит произвёл GitHub
Родитель d245b9a735 c5945a6d4f
Коммит add71f5149
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
169 изменённых файлов: 2782 добавлений и 90 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

258
_data/api_nav.yaml
Просмотреть файл

@ -97,6 +97,8 @@ api_nav:
url: /pages/api/api-extractor.extractorconfig.apireportenabled
- title: betaTrimmedFilePath
url: /pages/api/api-extractor.extractorconfig.betatrimmedfilepath
- title: bundledPackages
url: /pages/api/api-extractor.extractorconfig.bundledpackages
- title: docModelEnabled
url: /pages/api/api-extractor.extractorconfig.docmodelenabled
- title: FILENAME
@ -115,6 +117,8 @@ api_nav:
url: /pages/api/api-extractor.extractorconfig.mainentrypointfilepath
- title: messages
url: /pages/api/api-extractor.extractorconfig.messages
- title: newlineKind
url: /pages/api/api-extractor.extractorconfig.newlinekind
- title: omitTrimmingComments
url: /pages/api/api-extractor.extractorconfig.omittrimmingcomments
- title: overrideTsconfig
@ -245,6 +249,8 @@ api_nav:
subitems:
- title: apiReport
url: /pages/api/api-extractor.iconfigfile.apireport
- title: bundledPackages
url: /pages/api/api-extractor.iconfigfile.bundledpackages
- title: compiler
url: /pages/api/api-extractor.iconfigfile.compiler
- title: docModel
@ -257,6 +263,8 @@ api_nav:
url: /pages/api/api-extractor.iconfigfile.mainentrypointfilepath
- title: messages
url: /pages/api/api-extractor.iconfigfile.messages
- title: newlineKind
url: /pages/api/api-extractor.iconfigfile.newlinekind
- title: projectFolder
url: /pages/api/api-extractor.iconfigfile.projectfolder
- title: testMode
@ -1444,6 +1452,8 @@ api_nav:
url: /pages/api/node-core-library.jsonfile.updatestring
- title: validateNoUndefinedMembers
url: /pages/api/node-core-library.jsonfile.validatenoundefinedmembers
- title: JsonObject
url: /pages/api/node-core-library.jsonobject
- title: JsonSchema
url: /pages/api/node-core-library.jsonschema
subitems:
@ -1474,6 +1484,8 @@ api_nav:
url: /pages/api/node-core-library.legacyadapters.convertcallbacktopromise_4
- title: scrubError
url: /pages/api/node-core-library.legacyadapters.scruberror
- title: sortStable
url: /pages/api/node-core-library.legacyadapters.sortstable
- title: LegacyCallback
url: /pages/api/node-core-library.legacycallback
- title: LockFile
@ -1643,6 +1655,8 @@ api_nav:
- title: Text
url: /pages/api/node-core-library.text
subitems:
- title: convertTo
url: /pages/api/node-core-library.text.convertto
- title: convertToCrLf
url: /pages/api/node-core-library.text.converttocrlf
- title: convertToLf
@ -1662,6 +1676,8 @@ api_nav:
- title: '@microsoft/package-deps-hash'
url: /pages/api/package-deps-hash
subitems:
- title: getGitHashForFiles
url: /pages/api/package-deps-hash.getgithashforfiles
- title: getPackageDeps
url: /pages/api/package-deps-hash.getpackagedeps
- title: IPackageDeps
@ -1729,6 +1745,8 @@ api_nav:
url: /pages/api/rush-lib.commonversionsconfiguration.filepath
- title: getAllPreferredVersions
url: /pages/api/rush-lib.commonversionsconfiguration.getallpreferredversions
- title: implicitlyPreferredVersions
url: /pages/api/rush-lib.commonversionsconfiguration.implicitlypreferredversions
- title: loadFromFile
url: /pages/api/rush-lib.commonversionsconfiguration.loadfromfile
- title: preferredVersions
@ -1748,6 +1766,16 @@ api_nav:
subitems:
- title: get
url: /pages/api/rush-lib.eventhooks.get
- title: ExperimentsConfiguration
url: /pages/api/rush-lib.experimentsconfiguration
subitems:
- title: configuration
url: /pages/api/rush-lib.experimentsconfiguration.configuration
- title: IExperimentsJson
url: /pages/api/rush-lib.iexperimentsjson
subitems:
- title: legacyIncrementalBuildDependencyDetection
url: /pages/api/rush-lib.iexperimentsjson.legacyincrementalbuilddependencydetection
- title: ILaunchOptions
url: /pages/api/rush-lib.ilaunchoptions
subitems:
@ -1844,10 +1872,16 @@ api_nav:
- title: PnpmOptionsConfiguration
url: /pages/api/rush-lib.pnpmoptionsconfiguration
subitems:
- title: pnpmStore
url: /pages/api/rush-lib.pnpmoptionsconfiguration.pnpmstore
- title: pnpmStorePath
url: /pages/api/rush-lib.pnpmoptionsconfiguration.pnpmstorepath
- title: resolutionStrategy
url: /pages/api/rush-lib.pnpmoptionsconfiguration.resolutionstrategy
- title: strictPeerDependencies
url: /pages/api/rush-lib.pnpmoptionsconfiguration.strictpeerdependencies
- title: PnpmStoreOptions
url: /pages/api/rush-lib.pnpmstoreoptions
- title: ResolutionStrategy
url: /pages/api/rush-lib.resolutionstrategy
- title: Rush
@ -1886,6 +1920,8 @@ api_nav:
url: /pages/api/rush-lib.rushconfiguration.ensureconsistentversions
- title: eventHooks
url: /pages/api/rush-lib.rushconfiguration.eventhooks
- title: experimentsConfiguration
url: /pages/api/rush-lib.rushconfiguration.experimentsconfiguration
- title: findProjectByShorthandName
url: /pages/api/rush-lib.rushconfiguration.findprojectbyshorthandname
- title: findProjectByTempName
@ -1926,8 +1962,6 @@ api_nav:
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
@ -1936,6 +1970,12 @@ api_nav:
url: /pages/api/rush-lib.rushconfiguration.projects
- title: projectsByName
url: /pages/api/rush-lib.rushconfiguration.projectsbyname
- title: repositoryDefaultBranch
url: /pages/api/rush-lib.rushconfiguration.repositorydefaultbranch
- title: repositoryDefaultFullyQualifiedRemoteBranch
url: /pages/api/rush-lib.rushconfiguration.repositorydefaultfullyqualifiedremotebranch
- title: repositoryDefaultRemote
url: /pages/api/rush-lib.rushconfiguration.repositorydefaultremote
- title: repositoryUrl
url: /pages/api/rush-lib.rushconfiguration.repositoryurl
- title: rushJsonFile
@ -1989,6 +2029,8 @@ api_nav:
url: /pages/api/rush-lib.rushconfigurationproject.projectrushtempfolder
- title: reviewCategory
url: /pages/api/rush-lib.rushconfigurationproject.reviewcategory
- title: rushConfiguration
url: /pages/api/rush-lib.rushconfigurationproject.rushconfiguration
- title: shouldPublish
url: /pages/api/rush-lib.rushconfigurationproject.shouldpublish
- title: skipRushCheck
@ -2289,3 +2331,215 @@ api_nav:
url: /pages/api/ts-command-line.icommandlinestringdefinition.defaultvalue
- title: ICommandLineStringListDefinition
url: /pages/api/ts-command-line.icommandlinestringlistdefinition
- title: '@rushstack/debug-certificate-manager'
url: /pages/api/debug-certificate-manager
subitems:
- title: CertificateManager
url: /pages/api/debug-certificate-manager.certificatemanager
subitems:
- title: (constructor)
url: /pages/api/debug-certificate-manager.certificatemanager._constructor_
- title: ensureCertificate
url: /pages/api/debug-certificate-manager.certificatemanager.ensurecertificate
- title: untrustCertificate
url: /pages/api/debug-certificate-manager.certificatemanager.untrustcertificate
- title: CertificateStore
url: /pages/api/debug-certificate-manager.certificatestore
subitems:
- title: (constructor)
url: /pages/api/debug-certificate-manager.certificatestore._constructor_
- title: certificateData
url: /pages/api/debug-certificate-manager.certificatestore.certificatedata
- title: certificatePath
url: /pages/api/debug-certificate-manager.certificatestore.certificatepath
- title: keyData
url: /pages/api/debug-certificate-manager.certificatestore.keydata
- title: ICertificate
url: /pages/api/debug-certificate-manager.icertificate
subitems:
- title: pemCertificate
url: /pages/api/debug-certificate-manager.icertificate.pemcertificate
- title: pemKey
url: /pages/api/debug-certificate-manager.icertificate.pemkey
- title: '@rushstack/localization-plugin'
url: /pages/api/localization-plugin
subitems:
- title: IDefaultLocaleOptions
url: /pages/api/localization-plugin.idefaultlocaleoptions
subitems:
- title: fillMissingTranslationStrings
url: /pages/api/localization-plugin.idefaultlocaleoptions.fillmissingtranslationstrings
- title: localeName
url: /pages/api/localization-plugin.idefaultlocaleoptions.localename
- title: ILocaleData
url: /pages/api/localization-plugin.ilocaledata
- title: ILocaleElementMap
url: /pages/api/localization-plugin.ilocaleelementmap
- title: ILocaleFileData
url: /pages/api/localization-plugin.ilocalefiledata
- title: ILocalizationPluginOptions
url: /pages/api/localization-plugin.ilocalizationpluginoptions
subitems:
- title: filesToIgnore
url: /pages/api/localization-plugin.ilocalizationpluginoptions.filestoignore
- title: localizationStats
url: /pages/api/localization-plugin.ilocalizationpluginoptions.localizationstats
- title: localizedData
url: /pages/api/localization-plugin.ilocalizationpluginoptions.localizeddata
- title: noStringsLocaleName
url: /pages/api/localization-plugin.ilocalizationpluginoptions.nostringslocalename
- title: typingsOptions
url: /pages/api/localization-plugin.ilocalizationpluginoptions.typingsoptions
- title: ILocalizationStats
url: /pages/api/localization-plugin.ilocalizationstats
subitems:
- title: entrypoints
url: /pages/api/localization-plugin.ilocalizationstats.entrypoints
- title: namedChunkGroups
url: /pages/api/localization-plugin.ilocalizationstats.namedchunkgroups
- title: ILocalizationStatsChunkGroup
url: /pages/api/localization-plugin.ilocalizationstatschunkgroup
subitems:
- title: localizedAssets
url: /pages/api/localization-plugin.ilocalizationstatschunkgroup.localizedassets
- title: ILocalizationStatsEntrypoint
url: /pages/api/localization-plugin.ilocalizationstatsentrypoint
subitems:
- title: localizedAssets
url: /pages/api/localization-plugin.ilocalizationstatsentrypoint.localizedassets
- title: ILocalizationStatsOptions
url: /pages/api/localization-plugin.ilocalizationstatsoptions
subitems:
- title: callback
url: /pages/api/localization-plugin.ilocalizationstatsoptions.callback
- title: dropPath
url: /pages/api/localization-plugin.ilocalizationstatsoptions.droppath
- title: ILocalizedData
url: /pages/api/localization-plugin.ilocalizeddata
subitems:
- title: defaultLocale
url: /pages/api/localization-plugin.ilocalizeddata.defaultlocale
- title: passthroughLocale
url: /pages/api/localization-plugin.ilocalizeddata.passthroughlocale
- title: pseudolocales
url: /pages/api/localization-plugin.ilocalizeddata.pseudolocales
- title: translatedStrings
url: /pages/api/localization-plugin.ilocalizeddata.translatedstrings
- title: ILocalizedStrings
url: /pages/api/localization-plugin.ilocalizedstrings
- title: ILocalizedWebpackChunk
url: /pages/api/localization-plugin.ilocalizedwebpackchunk
subitems:
- title: localizedFiles
url: /pages/api/localization-plugin.ilocalizedwebpackchunk.localizedfiles
- title: IPassthroughLocaleOptions
url: /pages/api/localization-plugin.ipassthroughlocaleoptions
subitems:
- title: passthroughLocaleName
url: /pages/api/localization-plugin.ipassthroughlocaleoptions.passthroughlocalename
- title: usePassthroughLocale
url: /pages/api/localization-plugin.ipassthroughlocaleoptions.usepassthroughlocale
- title: IPseudolocaleOptions
url: /pages/api/localization-plugin.ipseudolocaleoptions
subitems:
- title: append
url: /pages/api/localization-plugin.ipseudolocaleoptions.append
- title: delimiter
url: /pages/api/localization-plugin.ipseudolocaleoptions.delimiter
- title: endDelimiter
url: /pages/api/localization-plugin.ipseudolocaleoptions.enddelimiter
- title: extend
url: /pages/api/localization-plugin.ipseudolocaleoptions.extend
- title: override
url: /pages/api/localization-plugin.ipseudolocaleoptions.override
- title: prepend
url: /pages/api/localization-plugin.ipseudolocaleoptions.prepend
- title: startDelimiter
url: /pages/api/localization-plugin.ipseudolocaleoptions.startdelimiter
- title: IPseudolocalesOptions
url: /pages/api/localization-plugin.ipseudolocalesoptions
- title: ITypingsGenerationOptions
url: /pages/api/localization-plugin.itypingsgenerationoptions
subitems:
- title: exportAsDefault
url: /pages/api/localization-plugin.itypingsgenerationoptions.exportasdefault
- title: generatedTsFolder
url: /pages/api/localization-plugin.itypingsgenerationoptions.generatedtsfolder
- title: sourceRoot
url: /pages/api/localization-plugin.itypingsgenerationoptions.sourceroot
- title: ITypingsGeneratorOptions
url: /pages/api/localization-plugin.itypingsgeneratoroptions
subitems:
- title: exportAsDefault
url: /pages/api/localization-plugin.itypingsgeneratoroptions.exportasdefault
- title: filesToIgnore
url: /pages/api/localization-plugin.itypingsgeneratoroptions.filestoignore
- title: generatedTsFolder
url: /pages/api/localization-plugin.itypingsgeneratoroptions.generatedtsfolder
- title: srcFolder
url: /pages/api/localization-plugin.itypingsgeneratoroptions.srcfolder
- title: terminal
url: /pages/api/localization-plugin.itypingsgeneratoroptions.terminal
- title: LocalizationPlugin
url: /pages/api/localization-plugin.localizationplugin
subitems:
- title: (constructor)
url: /pages/api/localization-plugin.localizationplugin._constructor_
- title: apply
url: /pages/api/localization-plugin.localizationplugin.apply
- title: TypingsGenerator
url: /pages/api/localization-plugin.typingsgenerator
subitems:
- title: (constructor)
url: /pages/api/localization-plugin.typingsgenerator._constructor_
- title: '@rushstack/typings-generator'
url: /pages/api/typings-generator
subitems:
- title: IStringValuesTypingsGeneratorOptions
url: /pages/api/typings-generator.istringvaluestypingsgeneratoroptions
subitems:
- title: exportAsDefault
url: /pages/api/typings-generator.istringvaluestypingsgeneratoroptions.exportasdefault
- title: IStringValueTyping
url: /pages/api/typings-generator.istringvaluetyping
subitems:
- title: comment
url: /pages/api/typings-generator.istringvaluetyping.comment
- title: exportName
url: /pages/api/typings-generator.istringvaluetyping.exportname
- title: IStringValueTypings
url: /pages/api/typings-generator.istringvaluetypings
subitems:
- title: typings
url: /pages/api/typings-generator.istringvaluetypings.typings
- title: ITypingsGeneratorOptions
url: /pages/api/typings-generator.itypingsgeneratoroptions
subitems:
- title: fileExtensions
url: /pages/api/typings-generator.itypingsgeneratoroptions.fileextensions
- title: filesToIgnore
url: /pages/api/typings-generator.itypingsgeneratoroptions.filestoignore
- title: generatedTsFolder
url: /pages/api/typings-generator.itypingsgeneratoroptions.generatedtsfolder
- title: parseAndGenerateTypings
url: /pages/api/typings-generator.itypingsgeneratoroptions.parseandgeneratetypings
- title: srcFolder
url: /pages/api/typings-generator.itypingsgeneratoroptions.srcfolder
- title: terminal
url: /pages/api/typings-generator.itypingsgeneratoroptions.terminal
- title: StringValuesTypingsGenerator
url: /pages/api/typings-generator.stringvaluestypingsgenerator
subitems:
- title: (constructor)
url: /pages/api/typings-generator.stringvaluestypingsgenerator._constructor_
- title: TypingsGenerator
url: /pages/api/typings-generator.typingsgenerator
subitems:
- title: _options
url: /pages/api/typings-generator.typingsgenerator._options
- title: (constructor)
url: /pages/api/typings-generator.typingsgenerator._constructor_
- title: generateTypings
url: /pages/api/typings-generator.typingsgenerator.generatetypings
- title: runWatcher
url: /pages/api/typings-generator.typingsgenerator.runwatcher

4
pages/api/api-extractor-model.excerpttokenkind.md
Просмотреть файл

@ -20,6 +20,6 @@ export declare const enum ExcerptTokenKind
| Member | Value | Description |
| --- | --- | --- |
| Content | <code>&quot;Content&quot;</code> | |
| Reference | <code>&quot;Reference&quot;</code> | |
| Content | <code>&quot;Content&quot;</code> | Generic text without any special properties |
| Reference | <code>&quot;Reference&quot;</code> | A reference to an API declaration |

2
pages/api/api-extractor.compilerstate.md
Просмотреть файл

@ -21,7 +21,7 @@ export declare class CompilerState
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [program](./api-extractor.compilerstate.program.md) | | <code>ts.Program</code> | The TypeScript compiler's <code>Program</code> object, which represents a complete scope of analysis. |
| [program](./api-extractor.compilerstate.program.md) | | <code>unknown</code> | The TypeScript compiler's <code>Program</code> object, which represents a complete scope of analysis. |
## Methods

2
pages/api/api-extractor.compilerstate.program.md
Просмотреть файл

@ -14,5 +14,5 @@ The TypeScript compiler's `Program` object, which represents a complete scope of
<b>Signature:</b>
```typescript
readonly program: ts.Program;
readonly program: unknown;
```

29
pages/api/api-extractor.extractorconfig.bundledpackages.md Normal file
Просмотреть файл

@ -0,0 +1,29 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@microsoft/api-extractor](./api-extractor.md) &gt; [ExtractorConfig](./api-extractor.extractorconfig.md) &gt; [bundledPackages](./api-extractor.extractorconfig.bundledpackages.md)
## ExtractorConfig.bundledPackages property
A list of NPM package names whose exports should be treated as part of this package.
<b>Signature:</b>
```typescript
readonly bundledPackages: string[];
```
## Remarks
For example, suppose that Webpack is used to generate a distributed bundle for the project `library1`<!-- -->, and another NPM package `library2` is embedded in this bundle. Some types from `library2` may become part of the exported API for `library1`<!-- -->, but by default API Extractor would generate a .d.ts rollup that explicitly imports `library2`<!-- -->. To avoid this, we can specify:
```js
"bundledPackages": [ "library2" ],
```
This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been local files for `library1`<!-- -->.

2
pages/api/api-extractor.extractorconfig.md
Просмотреть файл

@ -24,11 +24,13 @@ export declare class ExtractorConfig
| [apiJsonFilePath](./api-extractor.extractorconfig.apijsonfilepath.md) | | <code>string</code> | The output path for the doc model file. The file extension should be ".api.json". |
| [apiReportEnabled](./api-extractor.extractorconfig.apireportenabled.md) | | <code>boolean</code> | Whether to generate an API report. |
| [betaTrimmedFilePath](./api-extractor.extractorconfig.betatrimmedfilepath.md) | | <code>string</code> | Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release. |
| [bundledPackages](./api-extractor.extractorconfig.bundledpackages.md) | | <code>string[]</code> | A list of NPM package names whose exports should be treated as part of this package. |
| [docModelEnabled](./api-extractor.extractorconfig.docmodelenabled.md) | | <code>boolean</code> | Whether to generate a doc model file. |
| [FILENAME](./api-extractor.extractorconfig.filename.md) | <code>static</code> | <code>string</code> | The config file name "api-extractor.json". |
| [jsonSchema](./api-extractor.extractorconfig.jsonschema.md) | <code>static</code> | <code>JsonSchema</code> | The JSON Schema for API Extractor config file (api-extractor.schema.json). |
| [mainEntryPointFilePath](./api-extractor.extractorconfig.mainentrypointfilepath.md) | | <code>string</code> | 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) | | <code>IExtractorMessagesConfig</code> | Configures how API Extractor reports error and warning messages produced during analysis. |
| [newlineKind](./api-extractor.extractorconfig.newlinekind.md) | | <code>NewlineKind</code> | 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. |
| [omitTrimmingComments](./api-extractor.extractorconfig.omittrimmingcomments.md) | | <code>boolean</code> | 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) | | <code>{} &#124; undefined</code> | Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk. |
| [packageFolder](./api-extractor.extractorconfig.packagefolder.md) | | <code>string &#124; undefined</code> | 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. |

18
pages/api/api-extractor.extractorconfig.newlinekind.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@microsoft/api-extractor](./api-extractor.md) &gt; [ExtractorConfig](./api-extractor.extractorconfig.md) &gt; [newlineKind](./api-extractor.extractorconfig.newlinekind.md)
## ExtractorConfig.newlineKind property
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.
<b>Signature:</b>
```typescript
readonly newlineKind: NewlineKind;
```

10
pages/api/api-extractor.extractormessageid.md
Просмотреть файл

@ -21,7 +21,7 @@ export declare const enum ExtractorMessageId
| Member | Value | Description |
| --- | --- | --- |
| CyclicInheritDoc | <code>&quot;ae-cyclic-inherit-doc&quot;</code> | "The <code>@inheritDoc</code> tag for \_\_\_ refers to its own declaration". |
| CyclicInheritDoc | <code>&quot;ae-cyclic-inherit-doc&quot;</code> | "The <code>@inheritDoc</code> tag for \_\_\_ refers to its own declaration." |
| DifferentReleaseTags | <code>&quot;ae-different-release-tags&quot;</code> | "This symbol has another declaration with a different release tag." |
| ExtraReleaseTag | <code>&quot;ae-extra-release-tag&quot;</code> | "The doc comment should not contain more than one release tag." |
| ForgottenExport | <code>&quot;ae-forgotten-export&quot;</code> | "The symbol \_\_\_ needs to be exported by the entry point \_\_\_." |
@ -29,12 +29,14 @@ export declare const enum ExtractorMessageId
| InternalMissingUnderscore | <code>&quot;ae-internal-missing-underscore&quot;</code> | "The name \_\_\_ should be prefixed with an underscore because the declaration is marked as <code>@internal</code>." |
| InternalMixedReleaseTag | <code>&quot;ae-internal-mixed-release-tag&quot;</code> | "Mixed release tags are not allowed for \_\_\_ because one of its declarations is marked as <code>@internal</code>." |
| MisplacedPackageTag | <code>&quot;ae-misplaced-package-tag&quot;</code> | "The <code>@packageDocumentation</code> comment must appear at the top of entry point \*.d.ts file." |
| MissingGetter | <code>&quot;ae-missing-getter&quot;</code> | "The property \_\_\_ has a setter but no getter." |
| MissingReleaseTag | <code>&quot;ae-missing-release-tag&quot;</code> | "\_\_\_ is exported by the package, but it is missing a release tag (<code>@alpha</code>, <code>@beta</code>, <code>@public</code>, or <code>@internal</code>)." |
| PreapprovedBadReleaseTag | <code>&quot;ae-preapproved-bad-release-tag&quot;</code> | "The <code>@preapproved</code> tag cannot be applied to \_\_\_ without an <code>@internal</code> release tag." |
| PreapprovedUnsupportedType | <code>&quot;ae-preapproved-unsupported-type&quot;</code> | "The <code>@preapproved</code> tag cannot be applied to \_\_\_ because it is not a supported declaration type." |
| UnresolvedInheritDocBase | <code>&quot;ae-unresolved-inheritdoc-base&quot;</code> | "The <code>@inheritDoc</code> tag needs a TSDoc declaration reference; signature matching is not supported yet". |
| UnresolvedInheritDocReference | <code>&quot;ae-unresolved-inheritdoc-reference&quot;</code> | "The <code>@inheritDoc</code> reference could not be resolved". |
| UnresolvedLink | <code>&quot;ae-unresolved-link&quot;</code> | "The <code>@link</code> reference could not be resolved". |
| SetterWithDocs | <code>&quot;ae-setter-with-docs&quot;</code> | "The doc comment for the property \_\_\_ must appear on the getter, not the setter." |
| UnresolvedInheritDocBase | <code>&quot;ae-unresolved-inheritdoc-base&quot;</code> | "The <code>@inheritDoc</code> tag needs a TSDoc declaration reference; signature matching is not supported yet." |
| UnresolvedInheritDocReference | <code>&quot;ae-unresolved-inheritdoc-reference&quot;</code> | "The <code>@inheritDoc</code> reference could not be resolved." |
| UnresolvedLink | <code>&quot;ae-unresolved-link&quot;</code> | "The <code>@link</code> reference could not be resolved." |
## Remarks

29
pages/api/api-extractor.iconfigfile.bundledpackages.md Normal file
Просмотреть файл

@ -0,0 +1,29 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@microsoft/api-extractor](./api-extractor.md) &gt; [IConfigFile](./api-extractor.iconfigfile.md) &gt; [bundledPackages](./api-extractor.iconfigfile.bundledpackages.md)
## IConfigFile.bundledPackages property
A list of NPM package names whose exports should be treated as part of this package.
<b>Signature:</b>
```typescript
bundledPackages?: string[];
```
## Remarks
For example, suppose that Webpack is used to generate a distributed bundle for the project `library1`<!-- -->, and another NPM package `library2` is embedded in this bundle. Some types from `library2` may become part of the exported API for `library1`<!-- -->, but by default API Extractor would generate a .d.ts rollup that explicitly imports `library2`<!-- -->. To avoid this, we can specify:
```js
"bundledPackages": [ "library2" ],
```
This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been local files for `library1`<!-- -->.

2
pages/api/api-extractor.iconfigfile.md
Просмотреть файл

@ -22,12 +22,14 @@ export interface IConfigFile
| Property | Type | Description |
| --- | --- | --- |
| [apiReport](./api-extractor.iconfigfile.apireport.md) | <code>IConfigApiReport</code> | Configures how the API report files (\*.api.md) will be generated. |
| [bundledPackages](./api-extractor.iconfigfile.bundledpackages.md) | <code>string[]</code> | A list of NPM package names whose exports should be treated as part of this package. |
| [compiler](./api-extractor.iconfigfile.compiler.md) | <code>IConfigCompiler</code> | Determines how the TypeScript compiler engine will be invoked by API Extractor. |
| [docModel](./api-extractor.iconfigfile.docmodel.md) | <code>IConfigDocModel</code> | Configures how the doc model file (\*.api.json) will be generated. |
| [dtsRollup](./api-extractor.iconfigfile.dtsrollup.md) | <code>IConfigDtsRollup</code> | <b><i>(BETA)</i></b> Configures how the .d.ts rollup file will be generated. |
| [extends](./api-extractor.iconfigfile.extends.md) | <code>string</code> | 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) | <code>string</code> | 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) | <code>IExtractorMessagesConfig</code> | Configures how API Extractor reports error and warning messages produced during analysis. |
| [newlineKind](./api-extractor.iconfigfile.newlinekind.md) | <code>'crlf' &#124; 'lf' &#124; 'os'</code> | Specifies what type of newlines API Extractor should use when writing output files. |
| [projectFolder](./api-extractor.iconfigfile.projectfolder.md) | <code>string</code> | Determines the <code>&lt;projectFolder&gt;</code> 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) | <code>boolean</code> | Set to true when invoking API Extractor's test harness. |
| [tsdocMetadata](./api-extractor.iconfigfile.tsdocmetadata.md) | <code>IConfigTsdocMetadata</code> | <b><i>(BETA)</i></b> Configures how the tsdoc-metadata.json file will be generated. |

23
pages/api/api-extractor.iconfigfile.newlinekind.md Normal file
Просмотреть файл

@ -0,0 +1,23 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@microsoft/api-extractor](./api-extractor.md) &gt; [IConfigFile](./api-extractor.iconfigfile.md) &gt; [newlineKind](./api-extractor.iconfigfile.newlinekind.md)
## IConfigFile.newlineKind property
Specifies what type of newlines API Extractor should use when writing output files.
<b>Signature:</b>
```typescript
newlineKind?: 'crlf' | 'lf' | 'os';
```
## Remarks
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".

18
pages/api/debug-certificate-manager.certificatemanager._constructor_.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/debug-certificate-manager](./debug-certificate-manager.md) &gt; [CertificateManager](./debug-certificate-manager.certificatemanager.md) &gt; [(constructor)](./debug-certificate-manager.certificatemanager._constructor_.md)
## CertificateManager.(constructor)
Constructs a new instance of the `CertificateManager` class
<b>Signature:</b>
```typescript
constructor();
```

30
pages/api/debug-certificate-manager.certificatemanager.ensurecertificate.md Normal file
Просмотреть файл

@ -0,0 +1,30 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/debug-certificate-manager](./debug-certificate-manager.md) &gt; [CertificateManager](./debug-certificate-manager.certificatemanager.md) &gt; [ensureCertificate](./debug-certificate-manager.certificatemanager.ensurecertificate.md)
## CertificateManager.ensureCertificate() method
Get a dev certificate from the store, or optionally, generate a new one and trust it if one doesn't exist in the store.
<b>Signature:</b>
```typescript
ensureCertificate(canGenerateNewCertificate: boolean, terminal: Terminal): ICertificate;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| canGenerateNewCertificate | <code>boolean</code> | |
| terminal | <code>Terminal</code> | |
<b>Returns:</b>
`ICertificate`

32
pages/api/debug-certificate-manager.certificatemanager.md Normal file
Просмотреть файл

@ -0,0 +1,32 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/debug-certificate-manager](./debug-certificate-manager.md) &gt; [CertificateManager](./debug-certificate-manager.certificatemanager.md)
## CertificateManager class
A utility class to handle generating, trusting, and untrustring a debug certificate. Contains two public methods to `ensureCertificate` and `untrustCertificate`<!-- -->.
<b>Signature:</b>
```typescript
export declare class CertificateManager
```
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)()](./debug-certificate-manager.certificatemanager._constructor_.md) | | Constructs a new instance of the <code>CertificateManager</code> class |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [ensureCertificate(canGenerateNewCertificate, terminal)](./debug-certificate-manager.certificatemanager.ensurecertificate.md) | | Get a dev certificate from the store, or optionally, generate a new one and trust it if one doesn't exist in the store. |
| [untrustCertificate(terminal)](./debug-certificate-manager.certificatemanager.untrustcertificate.md) | | Attempt to locate a previously generated debug certificate and untrust it. |

29
pages/api/debug-certificate-manager.certificatemanager.untrustcertificate.md Normal file
Просмотреть файл

@ -0,0 +1,29 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/debug-certificate-manager](./debug-certificate-manager.md) &gt; [CertificateManager](./debug-certificate-manager.certificatemanager.md) &gt; [untrustCertificate](./debug-certificate-manager.certificatemanager.untrustcertificate.md)
## CertificateManager.untrustCertificate() method
Attempt to locate a previously generated debug certificate and untrust it.
<b>Signature:</b>
```typescript
untrustCertificate(terminal: Terminal): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| terminal | <code>Terminal</code> | |
<b>Returns:</b>
`boolean`

18
pages/api/debug-certificate-manager.certificatestore._constructor_.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/debug-certificate-manager](./debug-certificate-manager.md) &gt; [CertificateStore](./debug-certificate-manager.certificatestore.md) &gt; [(constructor)](./debug-certificate-manager.certificatestore._constructor_.md)
## CertificateStore.(constructor)
Constructs a new instance of the `CertificateStore` class
<b>Signature:</b>
```typescript
constructor();
```

18
pages/api/debug-certificate-manager.certificatestore.certificatedata.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/debug-certificate-manager](./debug-certificate-manager.md) &gt; [CertificateStore](./debug-certificate-manager.certificatestore.md) &gt; [certificateData](./debug-certificate-manager.certificatestore.certificatedata.md)
## CertificateStore.certificateData property
Debug certificate pem file contents.
<b>Signature:</b>
```typescript
certificateData: string | undefined;
```

18
pages/api/debug-certificate-manager.certificatestore.certificatepath.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/debug-certificate-manager](./debug-certificate-manager.md) &gt; [CertificateStore](./debug-certificate-manager.certificatestore.md) &gt; [certificatePath](./debug-certificate-manager.certificatestore.certificatepath.md)
## CertificateStore.certificatePath property
Path to the saved debug certificate
<b>Signature:</b>
```typescript
readonly certificatePath: string;
```

18
pages/api/debug-certificate-manager.certificatestore.keydata.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/debug-certificate-manager](./debug-certificate-manager.md) &gt; [CertificateStore](./debug-certificate-manager.certificatestore.md) &gt; [keyData](./debug-certificate-manager.certificatestore.keydata.md)
## CertificateStore.keyData property
Key used to sign the debug pem certificate.
<b>Signature:</b>
```typescript
keyData: string | undefined;
```

33
pages/api/debug-certificate-manager.certificatestore.md Normal file
Просмотреть файл

@ -0,0 +1,33 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/debug-certificate-manager](./debug-certificate-manager.md) &gt; [CertificateStore](./debug-certificate-manager.certificatestore.md)
## CertificateStore class
Store to retrieve and save debug certificate data.
<b>Signature:</b>
```typescript
export declare class CertificateStore
```
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)()](./debug-certificate-manager.certificatestore._constructor_.md) | | Constructs a new instance of the <code>CertificateStore</code> class |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [certificateData](./debug-certificate-manager.certificatestore.certificatedata.md) | | <code>string &#124; undefined</code> | Debug certificate pem file contents. |
| [certificatePath](./debug-certificate-manager.certificatestore.certificatepath.md) | | <code>string</code> | Path to the saved debug certificate |
| [keyData](./debug-certificate-manager.certificatestore.keydata.md) | | <code>string &#124; undefined</code> | Key used to sign the debug pem certificate. |

26
pages/api/debug-certificate-manager.icertificate.md Normal file
Просмотреть файл

@ -0,0 +1,26 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/debug-certificate-manager](./debug-certificate-manager.md) &gt; [ICertificate](./debug-certificate-manager.icertificate.md)
## ICertificate interface
The interface for a debug certificate instance
<b>Signature:</b>
```typescript
export interface ICertificate
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [pemCertificate](./debug-certificate-manager.icertificate.pemcertificate.md) | <code>string &#124; undefined</code> | Generated pem certificate contents |
| [pemKey](./debug-certificate-manager.icertificate.pemkey.md) | <code>string &#124; undefined</code> | Private key used to sign the pem certificate |

18
pages/api/debug-certificate-manager.icertificate.pemcertificate.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/debug-certificate-manager](./debug-certificate-manager.md) &gt; [ICertificate](./debug-certificate-manager.icertificate.md) &gt; [pemCertificate](./debug-certificate-manager.icertificate.pemcertificate.md)
## ICertificate.pemCertificate property
Generated pem certificate contents
<b>Signature:</b>
```typescript
pemCertificate: string | undefined;
```

18
pages/api/debug-certificate-manager.icertificate.pemkey.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/debug-certificate-manager](./debug-certificate-manager.md) &gt; [ICertificate](./debug-certificate-manager.icertificate.md) &gt; [pemKey](./debug-certificate-manager.icertificate.pemkey.md)
## ICertificate.pemKey property
Private key used to sign the pem certificate
<b>Signature:</b>
```typescript
pemKey: string | undefined;
```

28
pages/api/debug-certificate-manager.md Normal file
Просмотреть файл

@ -0,0 +1,28 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/debug-certificate-manager](./debug-certificate-manager.md)
## debug-certificate-manager package
This package is used to manage debug certificates for development servers. It is used by \[@<!-- -->microsoft/gulp-core-build-serve\](https://www.npmjs.com/package/<!-- -->@<!-- -->microsoft/gulp-core-build-serve) to generate and trust a certificate when HTTPS is turned on.
This package provides the following utilities: - `CertificateStore` to handle retrieving and saving a debug certificate. - `CertificateManager` is a utility class containing the following public methods: \| - `ensureCertificate` will find or optionally create a debug certificate and trust it. \| - `untrustCertificate` will untrust a debug certificate.
## Classes
| Class | Description |
| --- | --- |
| [CertificateManager](./debug-certificate-manager.certificatemanager.md) | A utility class to handle generating, trusting, and untrustring a debug certificate. Contains two public methods to <code>ensureCertificate</code> and <code>untrustCertificate</code>. |
| [CertificateStore](./debug-certificate-manager.certificatestore.md) | Store to retrieve and save debug certificate data. |
## Interfaces
| Interface | Description |
| --- | --- |
| [ICertificate](./debug-certificate-manager.icertificate.md) | The interface for a debug certificate instance |

3
pages/api/index.md
Просмотреть файл

@ -21,4 +21,7 @@ improve_this_button: false
| [@microsoft/rush-lib](./rush-lib.md) | A library for writing scripts that interact with the [Rush](https://rushjs.io/) tool. |
| [@microsoft/stream-collator](./stream-collator.md) | This library enables a tool to display live console output from multiple asynchronous processes, while ensuring that their output does not get jumbled together. |
| [@microsoft/ts-command-line](./ts-command-line.md) | An object-oriented command-line parser for TypeScript projects. |
| [@rushstack/debug-certificate-manager](./debug-certificate-manager.md) | This package is used to manage debug certificates for development servers. It is used by \[@<!-- -->microsoft/gulp-core-build-serve\](https://www.npmjs.com/package/<!-- -->@<!-- -->microsoft/gulp-core-build-serve) to generate and trust a certificate when HTTPS is turned on.<!-- -->This package provides the following utilities: - <code>CertificateStore</code> to handle retrieving and saving a debug certificate. - <code>CertificateManager</code> is a utility class containing the following public methods: \| - <code>ensureCertificate</code> will find or optionally create a debug certificate and trust it. \| - <code>untrustCertificate</code> will untrust a debug certificate. |
| [@rushstack/localization-plugin](./localization-plugin.md) | |
| [@rushstack/typings-generator](./typings-generator.md) | |

18
pages/api/localization-plugin.idefaultlocaleoptions.fillmissingtranslationstrings.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [IDefaultLocaleOptions](./localization-plugin.idefaultlocaleoptions.md) &gt; [fillMissingTranslationStrings](./localization-plugin.idefaultlocaleoptions.fillmissingtranslationstrings.md)
## IDefaultLocaleOptions.fillMissingTranslationStrings property
If this option is set to `true`<!-- -->, strings that are missing from `localizedData.translatedStrings` will be provided by the default locale
<b>Signature:</b>
```typescript
fillMissingTranslationStrings?: boolean;
```

18
pages/api/localization-plugin.idefaultlocaleoptions.localename.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [IDefaultLocaleOptions](./localization-plugin.idefaultlocaleoptions.md) &gt; [localeName](./localization-plugin.idefaultlocaleoptions.localename.md)
## IDefaultLocaleOptions.localeName property
This required property specifies the name of the locale used in the `.resx` and `.loc.json` files in the source
<b>Signature:</b>
```typescript
localeName: string;
```

25
pages/api/localization-plugin.idefaultlocaleoptions.md Normal file
Просмотреть файл

@ -0,0 +1,25 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [IDefaultLocaleOptions](./localization-plugin.idefaultlocaleoptions.md)
## IDefaultLocaleOptions interface
<b>Signature:</b>
```typescript
export interface IDefaultLocaleOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [fillMissingTranslationStrings](./localization-plugin.idefaultlocaleoptions.fillmissingtranslationstrings.md) | <code>boolean</code> | If this option is set to <code>true</code>, strings that are missing from <code>localizedData.translatedStrings</code> will be provided by the default locale |
| [localeName](./localization-plugin.idefaultlocaleoptions.localename.md) | <code>string</code> | This required property specifies the name of the locale used in the <code>.resx</code> and <code>.loc.json</code> files in the source |

17
pages/api/localization-plugin.ilocaledata.md Normal file
Просмотреть файл

@ -0,0 +1,17 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocaleData](./localization-plugin.ilocaledata.md)
## ILocaleData interface
<b>Signature:</b>
```typescript
export interface ILocaleData
```

17
pages/api/localization-plugin.ilocaleelementmap.md Normal file
Просмотреть файл

@ -0,0 +1,17 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocaleElementMap](./localization-plugin.ilocaleelementmap.md)
## ILocaleElementMap interface
<b>Signature:</b>
```typescript
export interface ILocaleElementMap
```

17
pages/api/localization-plugin.ilocalefiledata.md Normal file
Просмотреть файл

@ -0,0 +1,17 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocaleFileData](./localization-plugin.ilocalefiledata.md)
## ILocaleFileData interface
<b>Signature:</b>
```typescript
export interface ILocaleFileData
```

18
pages/api/localization-plugin.ilocalizationpluginoptions.filestoignore.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizationPluginOptions](./localization-plugin.ilocalizationpluginoptions.md) &gt; [filesToIgnore](./localization-plugin.ilocalizationpluginoptions.filestoignore.md)
## ILocalizationPluginOptions.filesToIgnore property
This option is used to specify `.resx` and `.loc.json` files that should not be processed by this plugin.
<b>Signature:</b>
```typescript
filesToIgnore?: string[];
```

18
pages/api/localization-plugin.ilocalizationpluginoptions.localizationstats.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizationPluginOptions](./localization-plugin.ilocalizationpluginoptions.md) &gt; [localizationStats](./localization-plugin.ilocalizationpluginoptions.localizationstats.md)
## ILocalizationPluginOptions.localizationStats property
Options for how localization stats data should be produced.
<b>Signature:</b>
```typescript
localizationStats?: ILocalizationStatsOptions;
```

18
pages/api/localization-plugin.ilocalizationpluginoptions.localizeddata.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizationPluginOptions](./localization-plugin.ilocalizationpluginoptions.md) &gt; [localizedData](./localization-plugin.ilocalizationpluginoptions.localizeddata.md)
## ILocalizationPluginOptions.localizedData property
Localization data.
<b>Signature:</b>
```typescript
localizedData: ILocalizedData;
```

29
pages/api/localization-plugin.ilocalizationpluginoptions.md Normal file
Просмотреть файл

@ -0,0 +1,29 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizationPluginOptions](./localization-plugin.ilocalizationpluginoptions.md)
## ILocalizationPluginOptions interface
The options for localization.
<b>Signature:</b>
```typescript
export interface ILocalizationPluginOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [filesToIgnore](./localization-plugin.ilocalizationpluginoptions.filestoignore.md) | <code>string[]</code> | This option is used to specify <code>.resx</code> and <code>.loc.json</code> files that should not be processed by this plugin. |
| [localizationStats](./localization-plugin.ilocalizationpluginoptions.localizationstats.md) | <code>ILocalizationStatsOptions</code> | Options for how localization stats data should be produced. |
| [localizedData](./localization-plugin.ilocalizationpluginoptions.localizeddata.md) | <code>ILocalizedData</code> | Localization data. |
| [noStringsLocaleName](./localization-plugin.ilocalizationpluginoptions.nostringslocalename.md) | <code>string</code> | The value to replace the \[locale\] token with for chunks without localized strings. Defaults to "none" |
| [typingsOptions](./localization-plugin.ilocalizationpluginoptions.typingsoptions.md) | <code>ITypingsGenerationOptions</code> | This option is used to specify how and if TypeScript typings should be generated for loc files. |

18
pages/api/localization-plugin.ilocalizationpluginoptions.nostringslocalename.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizationPluginOptions](./localization-plugin.ilocalizationpluginoptions.md) &gt; [noStringsLocaleName](./localization-plugin.ilocalizationpluginoptions.nostringslocalename.md)
## ILocalizationPluginOptions.noStringsLocaleName property
The value to replace the \[locale\] token with for chunks without localized strings. Defaults to "none"
<b>Signature:</b>
```typescript
noStringsLocaleName?: string;
```

18
pages/api/localization-plugin.ilocalizationpluginoptions.typingsoptions.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizationPluginOptions](./localization-plugin.ilocalizationpluginoptions.md) &gt; [typingsOptions](./localization-plugin.ilocalizationpluginoptions.typingsoptions.md)
## ILocalizationPluginOptions.typingsOptions property
This option is used to specify how and if TypeScript typings should be generated for loc files.
<b>Signature:</b>
```typescript
typingsOptions?: ITypingsGenerationOptions;
```

18
pages/api/localization-plugin.ilocalizationstats.entrypoints.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizationStats](./localization-plugin.ilocalizationstats.md) &gt; [entrypoints](./localization-plugin.ilocalizationstats.entrypoints.md)
## ILocalizationStats.entrypoints property
<b>Signature:</b>
```typescript
entrypoints: {
[name: string]: ILocalizationStatsEntrypoint;
};
```

25
pages/api/localization-plugin.ilocalizationstats.md Normal file
Просмотреть файл

@ -0,0 +1,25 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizationStats](./localization-plugin.ilocalizationstats.md)
## ILocalizationStats interface
<b>Signature:</b>
```typescript
export interface ILocalizationStats
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [entrypoints](./localization-plugin.ilocalizationstats.entrypoints.md) | <code>{</code><br/><code> [name: string]: ILocalizationStatsEntrypoint;</code><br/><code> }</code> | |
| [namedChunkGroups](./localization-plugin.ilocalizationstats.namedchunkgroups.md) | <code>{</code><br/><code> [name: string]: ILocalizationStatsChunkGroup;</code><br/><code> }</code> | |

18
pages/api/localization-plugin.ilocalizationstats.namedchunkgroups.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizationStats](./localization-plugin.ilocalizationstats.md) &gt; [namedChunkGroups](./localization-plugin.ilocalizationstats.namedchunkgroups.md)
## ILocalizationStats.namedChunkGroups property
<b>Signature:</b>
```typescript
namedChunkGroups: {
[name: string]: ILocalizationStatsChunkGroup;
};
```

16
pages/api/localization-plugin.ilocalizationstatschunkgroup.localizedassets.md Normal file
Просмотреть файл

@ -0,0 +1,16 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizationStatsChunkGroup](./localization-plugin.ilocalizationstatschunkgroup.md) &gt; [localizedAssets](./localization-plugin.ilocalizationstatschunkgroup.localizedassets.md)
## ILocalizationStatsChunkGroup.localizedAssets property
<b>Signature:</b>
```typescript
localizedAssets: ILocaleElementMap;
```

24
pages/api/localization-plugin.ilocalizationstatschunkgroup.md Normal file
Просмотреть файл

@ -0,0 +1,24 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizationStatsChunkGroup](./localization-plugin.ilocalizationstatschunkgroup.md)
## ILocalizationStatsChunkGroup interface
<b>Signature:</b>
```typescript
export interface ILocalizationStatsChunkGroup
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [localizedAssets](./localization-plugin.ilocalizationstatschunkgroup.localizedassets.md) | <code>ILocaleElementMap</code> | |

16
pages/api/localization-plugin.ilocalizationstatsentrypoint.localizedassets.md Normal file
Просмотреть файл

@ -0,0 +1,16 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizationStatsEntrypoint](./localization-plugin.ilocalizationstatsentrypoint.md) &gt; [localizedAssets](./localization-plugin.ilocalizationstatsentrypoint.localizedassets.md)
## ILocalizationStatsEntrypoint.localizedAssets property
<b>Signature:</b>
```typescript
localizedAssets: ILocaleElementMap;
```

24
pages/api/localization-plugin.ilocalizationstatsentrypoint.md Normal file
Просмотреть файл

@ -0,0 +1,24 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizationStatsEntrypoint](./localization-plugin.ilocalizationstatsentrypoint.md)
## ILocalizationStatsEntrypoint interface
<b>Signature:</b>
```typescript
export interface ILocalizationStatsEntrypoint
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [localizedAssets](./localization-plugin.ilocalizationstatsentrypoint.localizedassets.md) | <code>ILocaleElementMap</code> | |

18
pages/api/localization-plugin.ilocalizationstatsoptions.callback.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizationStatsOptions](./localization-plugin.ilocalizationstatsoptions.md) &gt; [callback](./localization-plugin.ilocalizationstatsoptions.callback.md)
## ILocalizationStatsOptions.callback property
This option is used to specify a callback to be called with the stats data that would be dropped at `localizationStats.dropPath` after compilation completes.
<b>Signature:</b>
```typescript
callback?: (stats: ILocalizationStats) => void;
```

18
pages/api/localization-plugin.ilocalizationstatsoptions.droppath.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizationStatsOptions](./localization-plugin.ilocalizationstatsoptions.md) &gt; [dropPath](./localization-plugin.ilocalizationstatsoptions.droppath.md)
## ILocalizationStatsOptions.dropPath property
This option is used to designate a path at which a JSON file describing the localized assets produced should be written.
<b>Signature:</b>
```typescript
dropPath?: string;
```

26
pages/api/localization-plugin.ilocalizationstatsoptions.md Normal file
Просмотреть файл

@ -0,0 +1,26 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizationStatsOptions](./localization-plugin.ilocalizationstatsoptions.md)
## ILocalizationStatsOptions interface
Options for how localization stats data should be produced.
<b>Signature:</b>
```typescript
export interface ILocalizationStatsOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [callback](./localization-plugin.ilocalizationstatsoptions.callback.md) | <code>(stats: ILocalizationStats) =&gt; void</code> | This option is used to specify a callback to be called with the stats data that would be dropped at <code>localizationStats.dropPath</code> after compilation completes. |
| [dropPath](./localization-plugin.ilocalizationstatsoptions.droppath.md) | <code>string</code> | This option is used to designate a path at which a JSON file describing the localized assets produced should be written. |

18
pages/api/localization-plugin.ilocalizeddata.defaultlocale.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizedData](./localization-plugin.ilocalizeddata.md) &gt; [defaultLocale](./localization-plugin.ilocalizeddata.defaultlocale.md)
## ILocalizedData.defaultLocale property
Options for the locale used in the source localized data files.
<b>Signature:</b>
```typescript
defaultLocale: IDefaultLocaleOptions;
```

27
pages/api/localization-plugin.ilocalizeddata.md Normal file
Просмотреть файл

@ -0,0 +1,27 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizedData](./localization-plugin.ilocalizeddata.md)
## ILocalizedData interface
<b>Signature:</b>
```typescript
export interface ILocalizedData
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [defaultLocale](./localization-plugin.ilocalizeddata.defaultlocale.md) | <code>IDefaultLocaleOptions</code> | Options for the locale used in the source localized data files. |
| [passthroughLocale](./localization-plugin.ilocalizeddata.passthroughlocale.md) | <code>IPassthroughLocaleOptions</code> | Options around including a passthrough locale. |
| [pseudolocales](./localization-plugin.ilocalizeddata.pseudolocales.md) | <code>IPseudolocalesOptions</code> | Options for pseudo-localization. |
| [translatedStrings](./localization-plugin.ilocalizeddata.translatedstrings.md) | <code>ILocalizedStrings</code> | Use this parameter to specify the translated data. |

18
pages/api/localization-plugin.ilocalizeddata.passthroughlocale.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizedData](./localization-plugin.ilocalizeddata.md) &gt; [passthroughLocale](./localization-plugin.ilocalizeddata.passthroughlocale.md)
## ILocalizedData.passthroughLocale property
Options around including a passthrough locale.
<b>Signature:</b>
```typescript
passthroughLocale?: IPassthroughLocaleOptions;
```

18
pages/api/localization-plugin.ilocalizeddata.pseudolocales.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizedData](./localization-plugin.ilocalizeddata.md) &gt; [pseudolocales](./localization-plugin.ilocalizeddata.pseudolocales.md)
## ILocalizedData.pseudolocales property
Options for pseudo-localization.
<b>Signature:</b>
```typescript
pseudolocales?: IPseudolocalesOptions;
```

18
pages/api/localization-plugin.ilocalizeddata.translatedstrings.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizedData](./localization-plugin.ilocalizeddata.md) &gt; [translatedStrings](./localization-plugin.ilocalizeddata.translatedstrings.md)
## ILocalizedData.translatedStrings property
Use this parameter to specify the translated data.
<b>Signature:</b>
```typescript
translatedStrings: ILocalizedStrings;
```

17
pages/api/localization-plugin.ilocalizedstrings.md Normal file
Просмотреть файл

@ -0,0 +1,17 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizedStrings](./localization-plugin.ilocalizedstrings.md)
## ILocalizedStrings interface
<b>Signature:</b>
```typescript
export interface ILocalizedStrings
```

18
pages/api/localization-plugin.ilocalizedwebpackchunk.localizedfiles.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizedWebpackChunk](./localization-plugin.ilocalizedwebpackchunk.md) &gt; [localizedFiles](./localization-plugin.ilocalizedwebpackchunk.localizedfiles.md)
## ILocalizedWebpackChunk.localizedFiles property
<b>Signature:</b>
```typescript
localizedFiles?: {
[locale: string]: string;
};
```

24
pages/api/localization-plugin.ilocalizedwebpackchunk.md Normal file
Просмотреть файл

@ -0,0 +1,24 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ILocalizedWebpackChunk](./localization-plugin.ilocalizedwebpackchunk.md)
## ILocalizedWebpackChunk interface
<b>Signature:</b>
```typescript
export interface ILocalizedWebpackChunk extends webpack.compilation.Chunk
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [localizedFiles](./localization-plugin.ilocalizedwebpackchunk.localizedfiles.md) | <code>{</code><br/><code> [locale: string]: string;</code><br/><code> }</code> | |

26
pages/api/localization-plugin.ipassthroughlocaleoptions.md Normal file
Просмотреть файл

@ -0,0 +1,26 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [IPassthroughLocaleOptions](./localization-plugin.ipassthroughlocaleoptions.md)
## IPassthroughLocaleOptions interface
Options for the passthrough locale.
<b>Signature:</b>
```typescript
export interface IPassthroughLocaleOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [passthroughLocaleName](./localization-plugin.ipassthroughlocaleoptions.passthroughlocalename.md) | <code>string</code> | If [IPassthroughLocaleOptions.usePassthroughLocale](./localization-plugin.ipassthroughlocaleoptions.usepassthroughlocale.md) is set, use this name for the passthrough locale. Defaults to "passthrough" |
| [usePassthroughLocale](./localization-plugin.ipassthroughlocaleoptions.usepassthroughlocale.md) | <code>boolean</code> | If this is set to <code>true</code>, a passthrough locale will be included in the output |

18
pages/api/localization-plugin.ipassthroughlocaleoptions.passthroughlocalename.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [IPassthroughLocaleOptions](./localization-plugin.ipassthroughlocaleoptions.md) &gt; [passthroughLocaleName](./localization-plugin.ipassthroughlocaleoptions.passthroughlocalename.md)
## IPassthroughLocaleOptions.passthroughLocaleName property
If [IPassthroughLocaleOptions.usePassthroughLocale](./localization-plugin.ipassthroughlocaleoptions.usepassthroughlocale.md) is set, use this name for the passthrough locale. Defaults to "passthrough"
<b>Signature:</b>
```typescript
passthroughLocaleName?: string;
```

18
pages/api/localization-plugin.ipassthroughlocaleoptions.usepassthroughlocale.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [IPassthroughLocaleOptions](./localization-plugin.ipassthroughlocaleoptions.md) &gt; [usePassthroughLocale](./localization-plugin.ipassthroughlocaleoptions.usepassthroughlocale.md)
## IPassthroughLocaleOptions.usePassthroughLocale property
If this is set to `true`<!-- -->, a passthrough locale will be included in the output
<b>Signature:</b>
```typescript
usePassthroughLocale?: boolean;
```

16
pages/api/localization-plugin.ipseudolocaleoptions.append.md Normal file
Просмотреть файл

@ -0,0 +1,16 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [IPseudolocaleOptions](./localization-plugin.ipseudolocaleoptions.md) &gt; [append](./localization-plugin.ipseudolocaleoptions.append.md)
## IPseudolocaleOptions.append property
<b>Signature:</b>
```typescript
append?: string;
```

16
pages/api/localization-plugin.ipseudolocaleoptions.delimiter.md Normal file
Просмотреть файл

@ -0,0 +1,16 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [IPseudolocaleOptions](./localization-plugin.ipseudolocaleoptions.md) &gt; [delimiter](./localization-plugin.ipseudolocaleoptions.delimiter.md)
## IPseudolocaleOptions.delimiter property
<b>Signature:</b>
```typescript
delimiter?: string;
```

16
pages/api/localization-plugin.ipseudolocaleoptions.enddelimiter.md Normal file
Просмотреть файл

@ -0,0 +1,16 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [IPseudolocaleOptions](./localization-plugin.ipseudolocaleoptions.md) &gt; [endDelimiter](./localization-plugin.ipseudolocaleoptions.enddelimiter.md)
## IPseudolocaleOptions.endDelimiter property
<b>Signature:</b>
```typescript
endDelimiter?: string;
```

16
pages/api/localization-plugin.ipseudolocaleoptions.extend.md Normal file
Просмотреть файл

@ -0,0 +1,16 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [IPseudolocaleOptions](./localization-plugin.ipseudolocaleoptions.md) &gt; [extend](./localization-plugin.ipseudolocaleoptions.extend.md)
## IPseudolocaleOptions.extend property
<b>Signature:</b>
```typescript
extend?: number;
```

31
pages/api/localization-plugin.ipseudolocaleoptions.md Normal file
Просмотреть файл

@ -0,0 +1,31 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [IPseudolocaleOptions](./localization-plugin.ipseudolocaleoptions.md)
## IPseudolocaleOptions interface
Options for the pseudolocale library.
<b>Signature:</b>
```typescript
export interface IPseudolocaleOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [append](./localization-plugin.ipseudolocaleoptions.append.md) | <code>string</code> | |
| [delimiter](./localization-plugin.ipseudolocaleoptions.delimiter.md) | <code>string</code> | |
| [endDelimiter](./localization-plugin.ipseudolocaleoptions.enddelimiter.md) | <code>string</code> | |
| [extend](./localization-plugin.ipseudolocaleoptions.extend.md) | <code>number</code> | |
| [override](./localization-plugin.ipseudolocaleoptions.override.md) | <code>string</code> | |
| [prepend](./localization-plugin.ipseudolocaleoptions.prepend.md) | <code>string</code> | |
| [startDelimiter](./localization-plugin.ipseudolocaleoptions.startdelimiter.md) | <code>string</code> | |

16
pages/api/localization-plugin.ipseudolocaleoptions.override.md Normal file
Просмотреть файл

@ -0,0 +1,16 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [IPseudolocaleOptions](./localization-plugin.ipseudolocaleoptions.md) &gt; [override](./localization-plugin.ipseudolocaleoptions.override.md)
## IPseudolocaleOptions.override property
<b>Signature:</b>
```typescript
override?: string;
```

16
pages/api/localization-plugin.ipseudolocaleoptions.prepend.md Normal file
Просмотреть файл

@ -0,0 +1,16 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [IPseudolocaleOptions](./localization-plugin.ipseudolocaleoptions.md) &gt; [prepend](./localization-plugin.ipseudolocaleoptions.prepend.md)
## IPseudolocaleOptions.prepend property
<b>Signature:</b>
```typescript
prepend?: string;
```

16
pages/api/localization-plugin.ipseudolocaleoptions.startdelimiter.md Normal file
Просмотреть файл

@ -0,0 +1,16 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [IPseudolocaleOptions](./localization-plugin.ipseudolocaleoptions.md) &gt; [startDelimiter](./localization-plugin.ipseudolocaleoptions.startdelimiter.md)
## IPseudolocaleOptions.startDelimiter property
<b>Signature:</b>
```typescript
startDelimiter?: string;
```

18
pages/api/localization-plugin.ipseudolocalesoptions.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [IPseudolocalesOptions](./localization-plugin.ipseudolocalesoptions.md)
## IPseudolocalesOptions interface
Options for generated pseudolocales.
<b>Signature:</b>
```typescript
export interface IPseudolocalesOptions
```

18
pages/api/localization-plugin.itypingsgenerationoptions.exportasdefault.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ITypingsGenerationOptions](./localization-plugin.itypingsgenerationoptions.md) &gt; [exportAsDefault](./localization-plugin.itypingsgenerationoptions.exportasdefault.md)
## ITypingsGenerationOptions.exportAsDefault property
If this option is set to `true`<!-- -->, loc modules typings will be exported wrapped in a `default` property.
<b>Signature:</b>
```typescript
exportAsDefault?: boolean;
```

18
pages/api/localization-plugin.itypingsgenerationoptions.generatedtsfolder.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ITypingsGenerationOptions](./localization-plugin.itypingsgenerationoptions.md) &gt; [generatedTsFolder](./localization-plugin.itypingsgenerationoptions.generatedtsfolder.md)
## ITypingsGenerationOptions.generatedTsFolder property
This property specifies the folder in which `.d.ts` files for loc files should be dropped.
<b>Signature:</b>
```typescript
generatedTsFolder: string;
```

27
pages/api/localization-plugin.itypingsgenerationoptions.md Normal file
Просмотреть файл

@ -0,0 +1,27 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ITypingsGenerationOptions](./localization-plugin.itypingsgenerationoptions.md)
## ITypingsGenerationOptions interface
Options for typing generation.
<b>Signature:</b>
```typescript
export interface ITypingsGenerationOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [exportAsDefault](./localization-plugin.itypingsgenerationoptions.exportasdefault.md) | <code>boolean</code> | If this option is set to <code>true</code>, loc modules typings will be exported wrapped in a <code>default</code> property. |
| [generatedTsFolder](./localization-plugin.itypingsgenerationoptions.generatedtsfolder.md) | <code>string</code> | This property specifies the folder in which <code>.d.ts</code> files for loc files should be dropped. |
| [sourceRoot](./localization-plugin.itypingsgenerationoptions.sourceroot.md) | <code>string</code> | This optional property overrides the compiler context for discovery of localization files for which typings should be generated. |

18
pages/api/localization-plugin.itypingsgenerationoptions.sourceroot.md Normal file
Просмотреть файл

@ -0,0 +1,18 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ITypingsGenerationOptions](./localization-plugin.itypingsgenerationoptions.md) &gt; [sourceRoot](./localization-plugin.itypingsgenerationoptions.sourceroot.md)
## ITypingsGenerationOptions.sourceRoot property
This optional property overrides the compiler context for discovery of localization files for which typings should be generated.
<b>Signature:</b>
```typescript
sourceRoot?: string;
```

16
pages/api/localization-plugin.itypingsgeneratoroptions.exportasdefault.md Normal file
Просмотреть файл

@ -0,0 +1,16 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ITypingsGeneratorOptions](./localization-plugin.itypingsgeneratoroptions.md) &gt; [exportAsDefault](./localization-plugin.itypingsgeneratoroptions.exportasdefault.md)
## ITypingsGeneratorOptions.exportAsDefault property
<b>Signature:</b>
```typescript
exportAsDefault?: boolean;
```

16
pages/api/localization-plugin.itypingsgeneratoroptions.filestoignore.md Normal file
Просмотреть файл

@ -0,0 +1,16 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ITypingsGeneratorOptions](./localization-plugin.itypingsgeneratoroptions.md) &gt; [filesToIgnore](./localization-plugin.itypingsgeneratoroptions.filestoignore.md)
## ITypingsGeneratorOptions.filesToIgnore property
<b>Signature:</b>
```typescript
filesToIgnore?: string[];
```

16
pages/api/localization-plugin.itypingsgeneratoroptions.generatedtsfolder.md Normal file
Просмотреть файл

@ -0,0 +1,16 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ITypingsGeneratorOptions](./localization-plugin.itypingsgeneratoroptions.md) &gt; [generatedTsFolder](./localization-plugin.itypingsgeneratoroptions.generatedtsfolder.md)
## ITypingsGeneratorOptions.generatedTsFolder property
<b>Signature:</b>
```typescript
generatedTsFolder: string;
```

28
pages/api/localization-plugin.itypingsgeneratoroptions.md Normal file
Просмотреть файл

@ -0,0 +1,28 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ITypingsGeneratorOptions](./localization-plugin.itypingsgeneratoroptions.md)
## ITypingsGeneratorOptions interface
<b>Signature:</b>
```typescript
export interface ITypingsGeneratorOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [exportAsDefault](./localization-plugin.itypingsgeneratoroptions.exportasdefault.md) | <code>boolean</code> | |
| [filesToIgnore](./localization-plugin.itypingsgeneratoroptions.filestoignore.md) | <code>string[]</code> | |
| [generatedTsFolder](./localization-plugin.itypingsgeneratoroptions.generatedtsfolder.md) | <code>string</code> | |
| [srcFolder](./localization-plugin.itypingsgeneratoroptions.srcfolder.md) | <code>string</code> | |
| [terminal](./localization-plugin.itypingsgeneratoroptions.terminal.md) | <code>Terminal</code> | |

16
pages/api/localization-plugin.itypingsgeneratoroptions.srcfolder.md Normal file
Просмотреть файл

@ -0,0 +1,16 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ITypingsGeneratorOptions](./localization-plugin.itypingsgeneratoroptions.md) &gt; [srcFolder](./localization-plugin.itypingsgeneratoroptions.srcfolder.md)
## ITypingsGeneratorOptions.srcFolder property
<b>Signature:</b>
```typescript
srcFolder: string;
```

16
pages/api/localization-plugin.itypingsgeneratoroptions.terminal.md Normal file
Просмотреть файл

@ -0,0 +1,16 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [ITypingsGeneratorOptions](./localization-plugin.itypingsgeneratoroptions.md) &gt; [terminal](./localization-plugin.itypingsgeneratoroptions.terminal.md)
## ITypingsGeneratorOptions.terminal property
<b>Signature:</b>
```typescript
terminal?: Terminal;
```

25
pages/api/localization-plugin.localizationplugin._constructor_.md Normal file
Просмотреть файл

@ -0,0 +1,25 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [LocalizationPlugin](./localization-plugin.localizationplugin.md) &gt; [(constructor)](./localization-plugin.localizationplugin._constructor_.md)
## LocalizationPlugin.(constructor)
Constructs a new instance of the `LocalizationPlugin` class
<b>Signature:</b>
```typescript
constructor(options: ILocalizationPluginOptions);
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| options | <code>ILocalizationPluginOptions</code> | |

27
pages/api/localization-plugin.localizationplugin.apply.md Normal file
Просмотреть файл

@ -0,0 +1,27 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [LocalizationPlugin](./localization-plugin.localizationplugin.md) &gt; [apply](./localization-plugin.localizationplugin.apply.md)
## LocalizationPlugin.apply() method
<b>Signature:</b>
```typescript
apply(compiler: Webpack.Compiler): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| compiler | <code>Webpack.Compiler</code> | |
<b>Returns:</b>
`void`

31
pages/api/localization-plugin.localizationplugin.md Normal file
Просмотреть файл

@ -0,0 +1,31 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [LocalizationPlugin](./localization-plugin.localizationplugin.md)
## LocalizationPlugin class
This plugin facilitates localization in webpack.
<b>Signature:</b>
```typescript
export declare class LocalizationPlugin implements Webpack.Plugin
```
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(options)](./localization-plugin.localizationplugin._constructor_.md) | | Constructs a new instance of the <code>LocalizationPlugin</code> class |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [apply(compiler)](./localization-plugin.localizationplugin.apply.md) | | |

40
pages/api/localization-plugin.md Normal file
Просмотреть файл

@ -0,0 +1,40 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md)
## localization-plugin package
## Classes
| Class | Description |
| --- | --- |
| [LocalizationPlugin](./localization-plugin.localizationplugin.md) | This plugin facilitates localization in webpack. |
| [TypingsGenerator](./localization-plugin.typingsgenerator.md) | This is a simple tool that generates .d.ts files for .loc.json and .resx files. |
## Interfaces
| Interface | Description |
| --- | --- |
| [IDefaultLocaleOptions](./localization-plugin.idefaultlocaleoptions.md) | |
| [ILocaleData](./localization-plugin.ilocaledata.md) | |
| [ILocaleElementMap](./localization-plugin.ilocaleelementmap.md) | |
| [ILocaleFileData](./localization-plugin.ilocalefiledata.md) | |
| [ILocalizationPluginOptions](./localization-plugin.ilocalizationpluginoptions.md) | The options for localization. |
| [ILocalizationStats](./localization-plugin.ilocalizationstats.md) | |
| [ILocalizationStatsChunkGroup](./localization-plugin.ilocalizationstatschunkgroup.md) | |
| [ILocalizationStatsEntrypoint](./localization-plugin.ilocalizationstatsentrypoint.md) | |
| [ILocalizationStatsOptions](./localization-plugin.ilocalizationstatsoptions.md) | Options for how localization stats data should be produced. |
| [ILocalizedData](./localization-plugin.ilocalizeddata.md) | |
| [ILocalizedStrings](./localization-plugin.ilocalizedstrings.md) | |
| [ILocalizedWebpackChunk](./localization-plugin.ilocalizedwebpackchunk.md) | |
| [IPassthroughLocaleOptions](./localization-plugin.ipassthroughlocaleoptions.md) | Options for the passthrough locale. |
| [IPseudolocaleOptions](./localization-plugin.ipseudolocaleoptions.md) | Options for the pseudolocale library. |
| [IPseudolocalesOptions](./localization-plugin.ipseudolocalesoptions.md) | Options for generated pseudolocales. |
| [ITypingsGenerationOptions](./localization-plugin.itypingsgenerationoptions.md) | Options for typing generation. |
| [ITypingsGeneratorOptions](./localization-plugin.itypingsgeneratoroptions.md) | |

25
pages/api/localization-plugin.typingsgenerator._constructor_.md Normal file
Просмотреть файл

@ -0,0 +1,25 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [TypingsGenerator](./localization-plugin.typingsgenerator.md) &gt; [(constructor)](./localization-plugin.typingsgenerator._constructor_.md)
## TypingsGenerator.(constructor)
Constructs a new instance of the `LocFileTypingsGenerator` class
<b>Signature:</b>
```typescript
constructor(options: ITypingsGeneratorOptions);
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| options | <code>ITypingsGeneratorOptions</code> | |

25
pages/api/localization-plugin.typingsgenerator.md Normal file
Просмотреть файл

@ -0,0 +1,25 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@rushstack/localization-plugin](./localization-plugin.md) &gt; [TypingsGenerator](./localization-plugin.typingsgenerator.md)
## TypingsGenerator class
This is a simple tool that generates .d.ts files for .loc.json and .resx files.
<b>Signature:</b>
```typescript
export declare class LocFileTypingsGenerator extends StringValuesTypingsGenerator
```
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(options)](./localization-plugin.typingsgenerator._constructor_.md) | | Constructs a new instance of the <code>LocFileTypingsGenerator</code> class |

4
pages/api/node-core-library.filesystem.readfolder.md
Просмотреть файл

@ -14,7 +14,7 @@ Reads the contents of the folder, not including "." or "..". Behind the scenes i
<b>Signature:</b>
```typescript
static readFolder(folderPath: string, options?: IFileSystemReadFolderOptions): Array<string>;
static readFolder(folderPath: string, options?: IFileSystemReadFolderOptions): string[];
```
## Parameters
@ -26,5 +26,5 @@ static readFolder(folderPath: string, options?: IFileSystemReadFolderOptions): A
<b>Returns:</b>
`Array<string>`
`string[]`

2
pages/api/node-core-library.ifilesystemdeletefileoptions.md
Просмотреть файл

@ -21,5 +21,5 @@ export interface IFileSystemDeleteFileOptions
| Property | Type | Description |
| --- | --- | --- |
| [throwIfNotExists](./node-core-library.ifilesystemdeletefileoptions.throwifnotexists.md) | <code>boolean</code> | If true, will throw an exception if the file did not exist before <code>deleteFile()</code> was called. Defaults to <code>false</code>. |
| [throwIfNotExists](./node-core-library.ifilesystemdeletefileoptions.throwifnotexists.md) | <code>boolean</code> | If true, will throw an exception if the file did not exist before <code>deleteFile()</code> was called. |

2
pages/api/node-core-library.ifilesystemdeletefileoptions.throwifnotexists.md
Просмотреть файл

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemDeleteFileOptions.throwIfNotExists property
If true, will throw an exception if the file did not exist before `deleteFile()` was called. Defaults to `false`<!-- -->.
If true, will throw an exception if the file did not exist before `deleteFile()` was called.
<b>Signature:</b>

2
pages/api/node-core-library.ifilesystemmoveoptions.ensurefolderexists.md
Просмотреть файл

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemMoveOptions.ensureFolderExists property
If true, will ensure the folder is created before writing the file. Defaults to `false`<!-- -->.
If true, will ensure the folder is created before writing the file.
<b>Signature:</b>

4
pages/api/node-core-library.ifilesystemmoveoptions.md
Просмотреть файл

@ -22,7 +22,7 @@ export interface IFileSystemMoveOptions
| Property | Type | Description |
| --- | --- | --- |
| [destinationPath](./node-core-library.ifilesystemmoveoptions.destinationpath.md) | <code>string</code> | The new path for the object. The path may be absolute or relative. |
| [ensureFolderExists](./node-core-library.ifilesystemmoveoptions.ensurefolderexists.md) | <code>boolean</code> | If true, will ensure the folder is created before writing the file. Defaults to <code>false</code>. |
| [overwrite](./node-core-library.ifilesystemmoveoptions.overwrite.md) | <code>boolean</code> | If true, will overwrite the file if it already exists. Defaults to true. |
| [ensureFolderExists](./node-core-library.ifilesystemmoveoptions.ensurefolderexists.md) | <code>boolean</code> | If true, will ensure the folder is created before writing the file. |
| [overwrite](./node-core-library.ifilesystemmoveoptions.overwrite.md) | <code>boolean</code> | If true, will overwrite the file if it already exists. |
| [sourcePath](./node-core-library.ifilesystemmoveoptions.sourcepath.md) | <code>string</code> | The path of the existing object to be moved. The path may be absolute or relative. |

2
pages/api/node-core-library.ifilesystemmoveoptions.overwrite.md
Просмотреть файл

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemMoveOptions.overwrite property
If true, will overwrite the file if it already exists. Defaults to true.
If true, will overwrite the file if it already exists.
<b>Signature:</b>

2
pages/api/node-core-library.ifilesystemreadfileoptions.convertlineendings.md
Просмотреть файл

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemReadFileOptions.convertLineEndings property
If specified, will normalize line endings to the specified style of newline. Defaults to `NewlineKind.None`<!-- -->.
If specified, will normalize line endings to the specified style of newline.
<b>Signature:</b>

2
pages/api/node-core-library.ifilesystemreadfileoptions.encoding.md
Просмотреть файл

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemReadFileOptions.encoding property
If specified, will change the encoding of the file that will be written. Defaults to `"utf8"`<!-- -->.
If specified, will change the encoding of the file that will be written.
<b>Signature:</b>

4
pages/api/node-core-library.ifilesystemreadfileoptions.md
Просмотреть файл

@ -21,6 +21,6 @@ export interface IFileSystemReadFileOptions
| Property | Type | Description |
| --- | --- | --- |
| [convertLineEndings](./node-core-library.ifilesystemreadfileoptions.convertlineendings.md) | <code>NewlineKind</code> | If specified, will normalize line endings to the specified style of newline. Defaults to <code>NewlineKind.None</code>. |
| [encoding](./node-core-library.ifilesystemreadfileoptions.encoding.md) | <code>Encoding</code> | If specified, will change the encoding of the file that will be written. Defaults to <code>&quot;utf8&quot;</code>. |
| [convertLineEndings](./node-core-library.ifilesystemreadfileoptions.convertlineendings.md) | <code>NewlineKind</code> | If specified, will normalize line endings to the specified style of newline. |
| [encoding](./node-core-library.ifilesystemreadfileoptions.encoding.md) | <code>Encoding</code> | If specified, will change the encoding of the file that will be written. |

2
pages/api/node-core-library.ifilesystemreadfolderoptions.absolutepaths.md
Просмотреть файл

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemReadFolderOptions.absolutePaths property
If true, returns the absolute paths of the files in the folder. Defaults to `false`<!-- -->.
If true, returns the absolute paths of the files in the folder.
<b>Signature:</b>

2
pages/api/node-core-library.ifilesystemreadfolderoptions.md
Просмотреть файл

@ -21,5 +21,5 @@ export interface IFileSystemReadFolderOptions
| Property | Type | Description |
| --- | --- | --- |
| [absolutePaths](./node-core-library.ifilesystemreadfolderoptions.absolutepaths.md) | <code>boolean</code> | If true, returns the absolute paths of the files in the folder. Defaults to <code>false</code>. |
| [absolutePaths](./node-core-library.ifilesystemreadfolderoptions.absolutepaths.md) | <code>boolean</code> | If true, returns the absolute paths of the files in the folder. |

2
pages/api/node-core-library.ifilesystemwritefileoptions.convertlineendings.md
Просмотреть файл

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemWriteFileOptions.convertLineEndings property
If specified, will normalize line endings to the specified style of newline. Defaults to `NewlineKind.None`<!-- -->.
If specified, will normalize line endings to the specified style of newline.
<b>Signature:</b>

2
pages/api/node-core-library.ifilesystemwritefileoptions.encoding.md
Просмотреть файл

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemWriteFileOptions.encoding property
If specified, will change the encoding of the file that will be written. Defaults to `"utf8"`<!-- -->.
If specified, will change the encoding of the file that will be written.
<b>Signature:</b>

2
pages/api/node-core-library.ifilesystemwritefileoptions.ensurefolderexists.md
Просмотреть файл

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemWriteFileOptions.ensureFolderExists property
If true, will ensure the folder is created before writing the file. Defaults to `false`<!-- -->.
If true, will ensure the folder is created before writing the file.
<b>Signature:</b>

6
pages/api/node-core-library.ifilesystemwritefileoptions.md
Просмотреть файл

@ -21,7 +21,7 @@ export interface IFileSystemWriteFileOptions
| Property | Type | Description |
| --- | --- | --- |
| [convertLineEndings](./node-core-library.ifilesystemwritefileoptions.convertlineendings.md) | <code>NewlineKind</code> | If specified, will normalize line endings to the specified style of newline. Defaults to <code>NewlineKind.None</code>. |
| [encoding](./node-core-library.ifilesystemwritefileoptions.encoding.md) | <code>Encoding</code> | If specified, will change the encoding of the file that will be written. Defaults to <code>&quot;utf8&quot;</code>. |
| [ensureFolderExists](./node-core-library.ifilesystemwritefileoptions.ensurefolderexists.md) | <code>boolean</code> | If true, will ensure the folder is created before writing the file. Defaults to <code>false</code>. |
| [convertLineEndings](./node-core-library.ifilesystemwritefileoptions.convertlineendings.md) | <code>NewlineKind</code> | If specified, will normalize line endings to the specified style of newline. |
| [encoding](./node-core-library.ifilesystemwritefileoptions.encoding.md) | <code>Encoding</code> | If specified, will change the encoding of the file that will be written. |
| [ensureFolderExists](./node-core-library.ifilesystemwritefileoptions.ensurefolderexists.md) | <code>boolean</code> | If true, will ensure the folder is created before writing the file. |

2
pages/api/node-core-library.ijsonfilestringifyoptions.md
Просмотреть файл

@ -21,6 +21,6 @@ export interface IJsonFileStringifyOptions
| Property | Type | Description |
| --- | --- | --- |
| [newlineConversion](./node-core-library.ijsonfilestringifyoptions.newlineconversion.md) | <code>NewlineKind</code> | If true, then <code>\n</code> will be used for newlines instead of the default <code>\r\n</code>. |
| [newlineConversion](./node-core-library.ijsonfilestringifyoptions.newlineconversion.md) | <code>NewlineKind</code> | If provided, the specified newline type will be used instead of the default <code>\r\n</code>. |
| [prettyFormatting](./node-core-library.ijsonfilestringifyoptions.prettyformatting.md) | <code>boolean</code> | 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. |

2
pages/api/node-core-library.ijsonfilestringifyoptions.newlineconversion.md
Просмотреть файл

@ -9,7 +9,7 @@ improve_this_button: false
## IJsonFileStringifyOptions.newlineConversion property
If true, then `\n` will be used for newlines instead of the default `\r\n`<!-- -->.
If provided, the specified newline type will be used instead of the default `\r\n`<!-- -->.
<b>Signature:</b>

Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше