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

Merge pull request #15 from microsoft/octogonz/regen-apis 

Regenerate API docs
This commit is contained in:
Pete Gonzalez 2020-05-29 19:58:19 -07:00 коммит произвёл GitHub
Родитель c3bc016581 117837d7da
Коммит b2f6ad9263
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
123 изменённых файлов: 2311 добавлений и 76 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

24
Gemfile.lock
Просмотреть файл

@ -1,18 +1,18 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (6.0.2.2)
activesupport (6.0.3.1)
concurrent-ruby (~> 1.0, >= 1.0.2)
i18n (>= 0.7, < 2)
minitest (~> 5.1)
tzinfo (~> 1.1)
zeitwerk (~> 2.2)
zeitwerk (~> 2.2, >= 2.2.2)
addressable (2.7.0)
public_suffix (>= 2.0.2, < 5.0)
algolia_html_extractor (2.6.2)
json (~> 2.0)
nokogiri (~> 1.10.4)
algoliasearch (1.27.1)
algoliasearch (1.27.2)
httpclient (~> 2.8, >= 2.8.3)
json (>= 1.5.1)
coffee-script (2.4.1)
@ -40,9 +40,9 @@ GEM
filesize (0.2.0)
forwardable-extended (2.6.0)
gemoji (3.0.1)
github-pages (204)
github-pages (206)
github-pages-health-check (= 1.16.1)
jekyll (= 3.8.5)
jekyll (= 3.8.7)
jekyll-avatar (= 0.7.0)
jekyll-coffeescript (= 1.1.1)
jekyll-commonmark-ghpages (= 0.1.6)
@ -81,7 +81,7 @@ GEM
mercenary (~> 0.3)
minima (= 2.5.1)
nokogiri (>= 1.10.4, < 2.0)
rouge (= 3.13.0)
rouge (= 3.19.0)
terminal-table (~> 1.4)
github-pages-health-check (1.16.1)
addressable (~> 2.3)
@ -89,14 +89,14 @@ GEM
octokit (~> 4.0)
public_suffix (~> 3.0)
typhoeus (~> 1.3)
html-pipeline (2.12.3)
html-pipeline (2.13.0)
activesupport (>= 2)
nokogiri (>= 1.4)
http_parser.rb (0.6.0)
httpclient (2.8.3)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
jekyll (3.8.5)
jekyll (3.8.7)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
@ -222,7 +222,7 @@ GEM
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.14.0)
minitest (5.14.1)
multipart-post (2.1.1)
nokogiri (1.10.9)
mini_portile2 (~> 2.4.0)
@ -235,10 +235,10 @@ GEM
forwardable-extended (~> 2.6)
progressbar (1.10.1)
public_suffix (3.1.1)
rb-fsevent (0.10.3)
rb-fsevent (0.10.4)
rb-inotify (0.10.1)
ffi (~> 1.0)
rouge (3.13.0)
rouge (3.19.0)
ruby-enum (0.8.0)
i18n
rubyzip (2.3.0)
@ -254,7 +254,7 @@ GEM
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
thread_safe (0.3.6)
typhoeus (1.3.1)
typhoeus (1.4.0)
ethon (>= 0.9.0)
tzinfo (1.2.7)
thread_safe (~> 0.1)

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

@ -822,6 +822,8 @@ api_nav:
url: /pages/api/api-extractor-model.excerpt._constructor_
- title: isEmpty
url: /pages/api/api-extractor-model.excerpt.isempty
- title: spannedTokens
url: /pages/api/api-extractor-model.excerpt.spannedtokens
- title: text
url: /pages/api/api-extractor-model.excerpt.text
- title: tokenRange
@ -1160,6 +1162,8 @@ api_nav:
url: /pages/api/rush-lib.iexperimentsjson.legacyincrementalbuilddependencydetection
- title: noChmodFieldInTarHeaderNormalization
url: /pages/api/rush-lib.iexperimentsjson.nochmodfieldintarheadernormalization
- title: usePnpmFrozenLockfileForRushInstall
url: /pages/api/rush-lib.iexperimentsjson.usepnpmfrozenlockfileforrushinstall
- title: ILaunchOptions
url: /pages/api/rush-lib.ilaunchoptions
subitems:
@ -1294,6 +1298,8 @@ api_nav:
- title: RushConfiguration
url: /pages/api/rush-lib.rushconfiguration
subitems:
- title: allowMostlyStandardPackageNames
url: /pages/api/rush-lib.rushconfiguration.allowmostlystandardpackagenames
- title: approvedPackagesPolicy
url: /pages/api/rush-lib.rushconfiguration.approvedpackagespolicy
- title: changesFolder
@ -1362,6 +1368,8 @@ api_nav:
url: /pages/api/rush-lib.rushconfiguration.packagemanagertoolversion
- title: packageManagerWrapper
url: /pages/api/rush-lib.rushconfiguration.packagemanagerwrapper
- title: packageNameParser
url: /pages/api/rush-lib.rushconfiguration.packagenameparser
- title: pnpmOptions
url: /pages/api/rush-lib.rushconfiguration.pnpmoptions
- title: projectFolderMaxDepth
@ -1658,6 +1666,8 @@ api_nav:
- title: '@rushstack/node-core-library'
url: /pages/api/node-core-library
subitems:
- title: AlreadyExistsBehavior
url: /pages/api/node-core-library.alreadyexistsbehavior
- title: Colors
url: /pages/api/node-core-library.colors
subitems:
@ -1744,50 +1754,114 @@ api_nav:
subitems:
- title: appendToFile
url: /pages/api/node-core-library.filesystem.appendtofile
- title: appendToFileAsync
url: /pages/api/node-core-library.filesystem.appendtofileasync
- title: changePosixModeBits
url: /pages/api/node-core-library.filesystem.changeposixmodebits
- title: changePosixModeBitsAsync
url: /pages/api/node-core-library.filesystem.changeposixmodebitsasync
- title: copyFile
url: /pages/api/node-core-library.filesystem.copyfile
- title: copyFileAsync
url: /pages/api/node-core-library.filesystem.copyfileasync
- title: copyFiles
url: /pages/api/node-core-library.filesystem.copyfiles
- title: copyFilesAsync
url: /pages/api/node-core-library.filesystem.copyfilesasync
- title: createHardLink
url: /pages/api/node-core-library.filesystem.createhardlink
- title: createHardLinkAsync
url: /pages/api/node-core-library.filesystem.createhardlinkasync
- title: createSymbolicLinkFile
url: /pages/api/node-core-library.filesystem.createsymboliclinkfile
- title: createSymbolicLinkFileAsync
url: /pages/api/node-core-library.filesystem.createsymboliclinkfileasync
- title: createSymbolicLinkFolder
url: /pages/api/node-core-library.filesystem.createsymboliclinkfolder
- title: createSymbolicLinkFolderAsync
url: /pages/api/node-core-library.filesystem.createsymboliclinkfolderasync
- title: createSymbolicLinkJunction
url: /pages/api/node-core-library.filesystem.createsymboliclinkjunction
- title: createSymbolicLinkJunctionAsync
url: /pages/api/node-core-library.filesystem.createsymboliclinkjunctionasync
- title: deleteFile
url: /pages/api/node-core-library.filesystem.deletefile
- title: deleteFileAsync
url: /pages/api/node-core-library.filesystem.deletefileasync
- title: deleteFolder
url: /pages/api/node-core-library.filesystem.deletefolder
- title: deleteFolderAsync
url: /pages/api/node-core-library.filesystem.deletefolderasync
- title: ensureEmptyFolder
url: /pages/api/node-core-library.filesystem.ensureemptyfolder
- title: ensureEmptyFolderAsync
url: /pages/api/node-core-library.filesystem.ensureemptyfolderasync
- title: ensureFolder
url: /pages/api/node-core-library.filesystem.ensurefolder
- title: ensureFolderAsync
url: /pages/api/node-core-library.filesystem.ensurefolderasync
- title: exists
url: /pages/api/node-core-library.filesystem.exists
- title: formatPosixModeBits
url: /pages/api/node-core-library.filesystem.formatposixmodebits
- title: getLinkStatistics
url: /pages/api/node-core-library.filesystem.getlinkstatistics
- title: getLinkStatisticsAsync
url: /pages/api/node-core-library.filesystem.getlinkstatisticsasync
- title: getPosixModeBits
url: /pages/api/node-core-library.filesystem.getposixmodebits
- title: getPosixModeBitsAsync
url: /pages/api/node-core-library.filesystem.getposixmodebitsasync
- title: getRealPath
url: /pages/api/node-core-library.filesystem.getrealpath
- title: getRealPathAsync
url: /pages/api/node-core-library.filesystem.getrealpathasync
- title: getStatistics
url: /pages/api/node-core-library.filesystem.getstatistics
- title: getStatisticsAsync
url: /pages/api/node-core-library.filesystem.getstatisticsasync
- title: isErrnoException
url: /pages/api/node-core-library.filesystem.iserrnoexception
- title: isFileDoesNotExistError
url: /pages/api/node-core-library.filesystem.isfiledoesnotexisterror
- title: isFolderDoesNotExistError
url: /pages/api/node-core-library.filesystem.isfolderdoesnotexisterror
- title: isNotExistError
url: /pages/api/node-core-library.filesystem.isnotexisterror
- title: move
url: /pages/api/node-core-library.filesystem.move
- title: moveAsync
url: /pages/api/node-core-library.filesystem.moveasync
- title: readFile
url: /pages/api/node-core-library.filesystem.readfile
- title: readFileAsync
url: /pages/api/node-core-library.filesystem.readfileasync
- title: readFileToBuffer
url: /pages/api/node-core-library.filesystem.readfiletobuffer
- title: readFileToBufferAsync
url: /pages/api/node-core-library.filesystem.readfiletobufferasync
- title: readFolder
url: /pages/api/node-core-library.filesystem.readfolder
- title: readFolderAsync
url: /pages/api/node-core-library.filesystem.readfolderasync
- title: readLink
url: /pages/api/node-core-library.filesystem.readlink
- title: readLinkAsync
url: /pages/api/node-core-library.filesystem.readlinkasync
- title: updateTimes
url: /pages/api/node-core-library.filesystem.updatetimes
- title: updateTimesAsync
url: /pages/api/node-core-library.filesystem.updatetimesasync
- title: writeFile
url: /pages/api/node-core-library.filesystem.writefile
- title: writeFileAsync
url: /pages/api/node-core-library.filesystem.writefileasync
- title: FileSystemCopyFilesAsyncFilter
url: /pages/api/node-core-library.filesystemcopyfilesasyncfilter
- title: FileSystemCopyFilesFilter
url: /pages/api/node-core-library.filesystemcopyfilesfilter
- title: FileSystemStats
url: /pages/api/node-core-library.filesystemstats
- title: FileWriter
url: /pages/api/node-core-library.filewriter
subitems:
@ -1838,10 +1912,32 @@ api_nav:
- title: IFileSystemCopyFileOptions
url: /pages/api/node-core-library.ifilesystemcopyfileoptions
subitems:
- title: alreadyExistsBehavior
url: /pages/api/node-core-library.ifilesystemcopyfileoptions.alreadyexistsbehavior
- title: destinationPath
url: /pages/api/node-core-library.ifilesystemcopyfileoptions.destinationpath
- title: sourcePath
url: /pages/api/node-core-library.ifilesystemcopyfileoptions.sourcepath
- title: IFileSystemCopyFilesAsyncOptions
url: /pages/api/node-core-library.ifilesystemcopyfilesasyncoptions
subitems:
- title: alreadyExistsBehavior
url: /pages/api/node-core-library.ifilesystemcopyfilesasyncoptions.alreadyexistsbehavior
- title: dereferenceSymlinks
url: /pages/api/node-core-library.ifilesystemcopyfilesasyncoptions.dereferencesymlinks
- title: destinationPath
url: /pages/api/node-core-library.ifilesystemcopyfilesasyncoptions.destinationpath
- title: filter
url: /pages/api/node-core-library.ifilesystemcopyfilesasyncoptions.filter
- title: preserveTimestamps
url: /pages/api/node-core-library.ifilesystemcopyfilesasyncoptions.preservetimestamps
- title: sourcePath
url: /pages/api/node-core-library.ifilesystemcopyfilesasyncoptions.sourcepath
- title: IFileSystemCopyFilesOptions
url: /pages/api/node-core-library.ifilesystemcopyfilesoptions
subitems:
- title: filter
url: /pages/api/node-core-library.ifilesystemcopyfilesoptions.filter
- title: IFileSystemCreateLinkOptions
url: /pages/api/node-core-library.ifilesystemcreatelinkoptions
subitems:
@ -1993,6 +2089,11 @@ api_nav:
url: /pages/api/node-core-library.ipackagejsonlookupparameters.loadextrafields
- title: IPackageJsonScriptTable
url: /pages/api/node-core-library.ipackagejsonscripttable
- title: IPackageNameParserOptions
url: /pages/api/node-core-library.ipackagenameparseroptions
subitems:
- title: allowUpperCase
url: /pages/api/node-core-library.ipackagenameparseroptions.allowuppercase
- title: IParsedPackageName
url: /pages/api/node-core-library.iparsedpackagename
subitems:
@ -2037,10 +2138,20 @@ api_nav:
url: /pages/api/node-core-library.jsonfile.load
- title: loadAndValidate
url: /pages/api/node-core-library.jsonfile.loadandvalidate
- title: loadAndValidateAsync
url: /pages/api/node-core-library.jsonfile.loadandvalidateasync
- title: loadAndValidateWithCallback
url: /pages/api/node-core-library.jsonfile.loadandvalidatewithcallback
- title: loadAndValidateWithCallbackAsync
url: /pages/api/node-core-library.jsonfile.loadandvalidatewithcallbackasync
- title: loadAsync
url: /pages/api/node-core-library.jsonfile.loadasync
- title: parseString
url: /pages/api/node-core-library.jsonfile.parsestring
- title: save
url: /pages/api/node-core-library.jsonfile.save
- title: saveAsync
url: /pages/api/node-core-library.jsonfile.saveasync
- title: stringify
url: /pages/api/node-core-library.jsonfile.stringify
- title: updateString
@ -2145,6 +2256,25 @@ api_nav:
url: /pages/api/node-core-library.packagename.tryparse
- title: validate
url: /pages/api/node-core-library.packagename.validate
- title: PackageNameParser
url: /pages/api/node-core-library.packagenameparser
subitems:
- title: (constructor)
url: /pages/api/node-core-library.packagenameparser._constructor_
- title: combineParts
url: /pages/api/node-core-library.packagenameparser.combineparts
- title: getScope
url: /pages/api/node-core-library.packagenameparser.getscope
- title: getUnscopedName
url: /pages/api/node-core-library.packagenameparser.getunscopedname
- title: isValidName
url: /pages/api/node-core-library.packagenameparser.isvalidname
- title: parse
url: /pages/api/node-core-library.packagenameparser.parse
- title: tryParse
url: /pages/api/node-core-library.packagenameparser.tryparse
- title: validate
url: /pages/api/node-core-library.packagenameparser.validate
- title: Path
url: /pages/api/node-core-library.path
subitems:
@ -2388,6 +2518,8 @@ api_nav:
subitems:
- title: defineChoiceParameter
url: /pages/api/ts-command-line.commandlineparameterprovider.definechoiceparameter
- title: defineCommandLineRemainder
url: /pages/api/ts-command-line.commandlineparameterprovider.definecommandlineremainder
- title: defineFlagParameter
url: /pages/api/ts-command-line.commandlineparameterprovider.defineflagparameter
- title: defineIntegerParameter
@ -2410,6 +2542,8 @@ api_nav:
url: /pages/api/ts-command-line.commandlineparameterprovider.ondefineparameters
- title: parameters
url: /pages/api/ts-command-line.commandlineparameterprovider.parameters
- title: remainder
url: /pages/api/ts-command-line.commandlineparameterprovider.remainder
- title: renderHelpText
url: /pages/api/ts-command-line.commandlineparameterprovider.renderhelptext
- title: CommandLineParameterWithArgument
@ -2442,6 +2576,15 @@ api_nav:
url: /pages/api/ts-command-line.commandlineparser.toolfilename
- title: tryGetAction
url: /pages/api/ts-command-line.commandlineparser.trygetaction
- title: CommandLineRemainder
url: /pages/api/ts-command-line.commandlineremainder
subitems:
- title: appendToArgList
url: /pages/api/ts-command-line.commandlineremainder.appendtoarglist
- title: description
url: /pages/api/ts-command-line.commandlineremainder.description
- title: values
url: /pages/api/ts-command-line.commandlineremainder.values
- title: CommandLineStringListParameter
url: /pages/api/ts-command-line.commandlinestringlistparameter
subitems:
@ -2522,6 +2665,11 @@ api_nav:
url: /pages/api/ts-command-line.icommandlineparseroptions.tooldescription
- title: toolFilename
url: /pages/api/ts-command-line.icommandlineparseroptions.toolfilename
- title: ICommandLineRemainderDefinition
url: /pages/api/ts-command-line.icommandlineremainderdefinition
subitems:
- title: description
url: /pages/api/ts-command-line.icommandlineremainderdefinition.description
- title: ICommandLineStringDefinition
url: /pages/api/ts-command-line.icommandlinestringdefinition
subitems:

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

@ -12,14 +12,14 @@ improve_this_button: false
<b>Signature:</b>
```typescript
resolveDeclarationReference(declarationReference: DocDeclarationReference, contextApiItem: ApiItem | undefined): IResolveDeclarationReferenceResult;
resolveDeclarationReference(declarationReference: DocDeclarationReference | DeclarationReference, contextApiItem: ApiItem | undefined): IResolveDeclarationReferenceResult;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| declarationReference | DocDeclarationReference | |
| declarationReference | DocDeclarationReference \| DeclarationReference | |
| contextApiItem | [ApiItem](./api-extractor-model.apiitem.md) \| undefined | |
<b>Returns:</b>

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

@ -9,6 +9,8 @@ improve_this_button: false
## Excerpt.isEmpty property
Returns true if the excerpt is an empty range.
<b>Signature:</b>
```typescript

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

@ -9,7 +9,7 @@ improve_this_button: false
## Excerpt class
This class is used by [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) to represent a source code excerpt containing a TypeScript declaration.
The `Excerpt` class is used by [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) to represent a TypeScript code fragment that may be annotated with hyperlinks to declared types (and in the future, source code locations).
<b>Signature:</b>
@ -19,7 +19,15 @@ export declare class Excerpt
## Remarks
The main excerpt is parsed into an array of tokens, and the main excerpt's token range will span all of these tokens. The declaration may also have have "captured" excerpts, which are other subranges of tokens. For example, if the main excerpt is a function declaration, it will also have a captured excerpt corresponding to the return type of the function.
API Extractor's .api.json file format stores excerpts compactly as a start/end indexes into an array of tokens. Every `ApiDeclaredItem` has a "main excerpt" corresponding to the full list of tokens. The declaration may also have have "captured" excerpts that correspond to subranges of tokens.
For example, if the main excerpt is:
```
function parse(s: string): Vector | undefined;
```
...then this entire signature is the "main excerpt", whereas the function's return type `Vector | undefined` is a captured excerpt. The `Vector` token might be a hyperlink to that API item.
An excerpt may be empty (i.e. a token range containing zero tokens). For example, if a function's return value is not explicitly declared, then the returnTypeExcerpt will be empty. By contrast, a class constructor cannot have a return value, so ApiConstructor has no returnTypeExcerpt property at all.
@ -33,8 +41,9 @@ An excerpt may be empty (i.e. a token range containing zero tokens). For example
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [isEmpty](./api-extractor-model.excerpt.isempty.md) | | boolean | |
| [text](./api-extractor-model.excerpt.text.md) | | string | |
| [tokenRange](./api-extractor-model.excerpt.tokenrange.md) | | Readonly&lt;[IExcerptTokenRange](./api-extractor-model.iexcerpttokenrange.md)<!-- -->&gt; | |
| [tokens](./api-extractor-model.excerpt.tokens.md) | | ReadonlyArray&lt;[ExcerptToken](./api-extractor-model.excerpttoken.md)<!-- -->&gt; | |
| [isEmpty](./api-extractor-model.excerpt.isempty.md) | | boolean | Returns true if the excerpt is an empty range. |
| [spannedTokens](./api-extractor-model.excerpt.spannedtokens.md) | | ReadonlyArray&lt;[ExcerptToken](./api-extractor-model.excerpttoken.md)<!-- -->&gt; | The tokens spanned by this excerpt. It is the range of the <code>tokens</code> array as specified by the <code>tokenRange</code> property. |
| [text](./api-extractor-model.excerpt.text.md) | | string | The excerpted text, formed by concatenating the text of the <code>spannedTokens</code> strings. |
| [tokenRange](./api-extractor-model.excerpt.tokenrange.md) | | Readonly&lt;[IExcerptTokenRange](./api-extractor-model.iexcerpttokenrange.md)<!-- -->&gt; | Specifies the excerpt's range within the <code>tokens</code> array. |
| [tokens](./api-extractor-model.excerpt.tokens.md) | | ReadonlyArray&lt;[ExcerptToken](./api-extractor-model.excerpttoken.md)<!-- -->&gt; | The complete list of tokens for the source code fragment that this excerpt is based upon. If this object is the main excerpt, then it will span all of the tokens; otherwise, it will correspond to a range within the array. |

18
pages/api/api-extractor-model.excerpt.spannedtokens.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-model](./api-extractor-model.md) &gt; [Excerpt](./api-extractor-model.excerpt.md) &gt; [spannedTokens](./api-extractor-model.excerpt.spannedtokens.md)
## Excerpt.spannedTokens property
The tokens spanned by this excerpt. It is the range of the `tokens` array as specified by the `tokenRange` property.
<b>Signature:</b>
```typescript
readonly spannedTokens: ReadonlyArray<ExcerptToken>;
```

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

@ -9,6 +9,8 @@ improve_this_button: false
## Excerpt.text property
The excerpted text, formed by concatenating the text of the `spannedTokens` strings.
<b>Signature:</b>
```typescript

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

@ -9,6 +9,8 @@ improve_this_button: false
## Excerpt.tokenRange property
Specifies the excerpt's range within the `tokens` array.
<b>Signature:</b>
```typescript

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

@ -9,6 +9,8 @@ improve_this_button: false
## Excerpt.tokens property
The complete list of tokens for the source code fragment that this excerpt is based upon. If this object is the main excerpt, then it will span all of the tokens; otherwise, it will correspond to a range within the array.
<b>Signature:</b>
```typescript

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

@ -9,6 +9,8 @@ improve_this_button: false
## ExcerptToken.canonicalReference property
The hyperlink target for a token whose type is `ExcerptTokenKind.Reference`<!-- -->. For other token types, this property will be `undefined`<!-- -->.
<b>Signature:</b>
```typescript

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

@ -9,6 +9,8 @@ improve_this_button: false
## ExcerptToken.kind property
Indicates the kind of token.
<b>Signature:</b>
```typescript

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

@ -9,6 +9,7 @@ improve_this_button: false
## ExcerptToken class
Represents a fragment of text belonging to an [Excerpt](./api-extractor-model.excerpt.md) object.
<b>Signature:</b>
@ -26,7 +27,7 @@ export declare class ExcerptToken
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [canonicalReference](./api-extractor-model.excerpttoken.canonicalreference.md) | | DeclarationReference \| undefined | |
| [kind](./api-extractor-model.excerpttoken.kind.md) | | [ExcerptTokenKind](./api-extractor-model.excerpttokenkind.md) | |
| [text](./api-extractor-model.excerpttoken.text.md) | | string | |
| [canonicalReference](./api-extractor-model.excerpttoken.canonicalreference.md) | | DeclarationReference \| undefined | The hyperlink target for a token whose type is <code>ExcerptTokenKind.Reference</code>. For other token types, this property will be <code>undefined</code>. |
| [kind](./api-extractor-model.excerpttoken.kind.md) | | [ExcerptTokenKind](./api-extractor-model.excerpttokenkind.md) | Indicates the kind of token. |
| [text](./api-extractor-model.excerpttoken.text.md) | | string | The text fragment. |

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

@ -9,6 +9,8 @@ improve_this_button: false
## ExcerptToken.text property
The text fragment.
<b>Signature:</b>
```typescript

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

@ -9,8 +9,15 @@ improve_this_button: false
## IExcerptTokenRange.endIndex property
The index of the last member of the span, plus one.
<b>Signature:</b>
```typescript
endIndex: number;
```
## Remarks
If `startIndex` and `endIndex` are the same number, then the span is empty.

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

@ -9,6 +9,7 @@ improve_this_button: false
## IExcerptTokenRange interface
Used by [Excerpt](./api-extractor-model.excerpt.md) to indicate a range of indexes within an array of `ExcerptToken` objects.
<b>Signature:</b>
@ -20,6 +21,6 @@ export interface IExcerptTokenRange
| Property | Type | Description |
| --- | --- | --- |
| [endIndex](./api-extractor-model.iexcerpttokenrange.endindex.md) | number | |
| [startIndex](./api-extractor-model.iexcerpttokenrange.startindex.md) | number | |
| [endIndex](./api-extractor-model.iexcerpttokenrange.endindex.md) | number | The index of the last member of the span, plus one. |
| [startIndex](./api-extractor-model.iexcerpttokenrange.startindex.md) | number | The starting index of the span. |

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

@ -9,6 +9,8 @@ improve_this_button: false
## IExcerptTokenRange.startIndex property
The starting index of the span.
<b>Signature:</b>
```typescript

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

@ -38,8 +38,8 @@ Use this library to read and write \*.api.json files as defined by the [API Extr
| [ApiPropertySignature](./api-extractor-model.apipropertysignature.md) | Represents a TypeScript property declaration that belongs to an <code>ApiInterface</code>. |
| [ApiTypeAlias](./api-extractor-model.apitypealias.md) | Represents a TypeScript type alias declaration. |
| [ApiVariable](./api-extractor-model.apivariable.md) | Represents a TypeScript variable declaration. |
| [Excerpt](./api-extractor-model.excerpt.md) | This class is used by [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) to represent a source code excerpt containing a TypeScript declaration. |
| [ExcerptToken](./api-extractor-model.excerpttoken.md) | |
| [Excerpt](./api-extractor-model.excerpt.md) | The <code>Excerpt</code> class is used by [ApiDeclaredItem](./api-extractor-model.apideclareditem.md) to represent a TypeScript code fragment that may be annotated with hyperlinks to declared types (and in the future, source code locations). |
| [ExcerptToken](./api-extractor-model.excerpttoken.md) | Represents a fragment of text belonging to an [Excerpt](./api-extractor-model.excerpt.md) object. |
| [HeritageType](./api-extractor-model.heritagetype.md) | Represents a type referenced via an "extends" or "implements" heritage clause for a TypeScript class. |
| [Parameter](./api-extractor-model.parameter.md) | Represents a named parameter for a function-like declaration. |
| [TypeParameter](./api-extractor-model.typeparameter.md) | Represents a named type parameter for a generic declaration. |
@ -109,7 +109,7 @@ Use this library to read and write \*.api.json files as defined by the [API Extr
| [IApiTypeParameterOptions](./api-extractor-model.iapitypeparameteroptions.md) | Represents parameter information that is part of [IApiTypeParameterListMixinOptions](./api-extractor-model.iapitypeparameterlistmixinoptions.md) |
| [IApiVariableOptions](./api-extractor-model.iapivariableoptions.md) | Constructor options for [ApiVariable](./api-extractor-model.apivariable.md)<!-- -->. |
| [IExcerptToken](./api-extractor-model.iexcerpttoken.md) | |
| [IExcerptTokenRange](./api-extractor-model.iexcerpttokenrange.md) | |
| [IExcerptTokenRange](./api-extractor-model.iexcerpttokenrange.md) | Used by [Excerpt](./api-extractor-model.excerpt.md) to indicate a range of indexes within an array of <code>ExcerptToken</code> objects. |
| [IParameterOptions](./api-extractor-model.iparameteroptions.md) | Constructor options for [Parameter](./api-extractor-model.parameter.md)<!-- -->. |
| [IResolveDeclarationReferenceResult](./api-extractor-model.iresolvedeclarationreferenceresult.md) | Result object for [ApiModel.resolveDeclarationReference()](./api-extractor-model.apimodel.resolvedeclarationreference.md)<!-- -->. |
| [ITypeParameterOptions](./api-extractor-model.itypeparameteroptions.md) | Constructor options for [TypeParameter](./api-extractor-model.typeparameter.md)<!-- -->. |

27
pages/api/node-core-library.alreadyexistsbehavior.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/node-core-library](./node-core-library.md) &gt; [AlreadyExistsBehavior](./node-core-library.alreadyexistsbehavior.md)
## AlreadyExistsBehavior enum
Specifies the behavior of [FileSystem.copyFiles()](./node-core-library.filesystem.copyfiles.md) in a situation where the target object already exists.
<b>Signature:</b>
```typescript
export declare const enum AlreadyExistsBehavior
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Error | <code>&quot;error&quot;</code> | If the destination object exists, report an error. |
| Ignore | <code>&quot;ignore&quot;</code> | If the destination object exists, skip it and continue the operation. |
| Overwrite | <code>&quot;overwrite&quot;</code> | If the destination object exists, overwrite it. This is the default behavior for [FileSystem.copyFiles()](./node-core-library.filesystem.copyfiles.md)<!-- -->. |

31
pages/api/node-core-library.filesystem.appendtofileasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [appendToFileAsync](./node-core-library.filesystem.appendtofileasync.md)
## FileSystem.appendToFileAsync() method
An async version of [FileSystem.appendToFile()](./node-core-library.filesystem.appendtofile.md)<!-- -->.
<b>Signature:</b>
```typescript
static appendToFileAsync(filePath: string, contents: string | Buffer, options?: IFileSystemWriteFileOptions): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | string | |
| contents | string \| Buffer | |
| options | [IFileSystemWriteFileOptions](./node-core-library.ifilesystemwritefileoptions.md) | |
<b>Returns:</b>
Promise&lt;void&gt;

30
pages/api/node-core-library.filesystem.changeposixmodebitsasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [changePosixModeBitsAsync](./node-core-library.filesystem.changeposixmodebitsasync.md)
## FileSystem.changePosixModeBitsAsync() method
An async version of [FileSystem.changePosixModeBits()](./node-core-library.filesystem.changeposixmodebits.md)<!-- -->.
<b>Signature:</b>
```typescript
static changePosixModeBitsAsync(path: string, mode: PosixModeBits): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| path | string | |
| mode | [PosixModeBits](./node-core-library.posixmodebits.md) | |
<b>Returns:</b>
Promise&lt;void&gt;

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

@ -9,7 +9,7 @@ improve_this_button: false
## FileSystem.copyFile() method
Copies a file from one location to another. By default, destinationPath is overwritten if it already exists. Behind the scenes it uses `fs.copyFileSync()`<!-- -->.
Copies a single file from one location to another. By default, destinationPath is overwritten if it already exists.
<b>Signature:</b>
@ -27,3 +27,9 @@ static copyFile(options: IFileSystemCopyFileOptions): void;
void
## Remarks
The `copyFile()` API cannot be used to copy folders. It copies at most one file. Use [FileSystem.copyFiles()](./node-core-library.filesystem.copyfiles.md) if you need to recursively copy a tree of folders.
The implementation is based on `copySync()` from the `fs-extra` package.

29
pages/api/node-core-library.filesystem.copyfileasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [copyFileAsync](./node-core-library.filesystem.copyfileasync.md)
## FileSystem.copyFileAsync() method
An async version of [FileSystem.copyFile()](./node-core-library.filesystem.copyfile.md)<!-- -->.
<b>Signature:</b>
```typescript
static copyFileAsync(options: IFileSystemCopyFileOptions): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| options | [IFileSystemCopyFileOptions](./node-core-library.ifilesystemcopyfileoptions.md) | |
<b>Returns:</b>
Promise&lt;void&gt;

35
pages/api/node-core-library.filesystem.copyfiles.md Normal file
Просмотреть файл

@ -0,0 +1,35 @@
---
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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [copyFiles](./node-core-library.filesystem.copyfiles.md)
## FileSystem.copyFiles() method
Copies a file or folder from one location to another, recursively copying any folder contents. By default, destinationPath is overwritten if it already exists.
<b>Signature:</b>
```typescript
static copyFiles(options: IFileSystemCopyFilesOptions): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| options | [IFileSystemCopyFilesOptions](./node-core-library.ifilesystemcopyfilesoptions.md) | |
<b>Returns:</b>
void
## Remarks
If you only intend to copy a single file, it is recommended to use [FileSystem.copyFile()](./node-core-library.filesystem.copyfile.md) instead to more clearly communicate the intended operation.
The implementation is based on `copySync()` from the `fs-extra` package.

29
pages/api/node-core-library.filesystem.copyfilesasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [copyFilesAsync](./node-core-library.filesystem.copyfilesasync.md)
## FileSystem.copyFilesAsync() method
An async version of [FileSystem.copyFiles()](./node-core-library.filesystem.copyfiles.md)<!-- -->.
<b>Signature:</b>
```typescript
static copyFilesAsync(options: IFileSystemCopyFilesOptions): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| options | [IFileSystemCopyFilesOptions](./node-core-library.ifilesystemcopyfilesoptions.md) | |
<b>Returns:</b>
Promise&lt;void&gt;

29
pages/api/node-core-library.filesystem.createhardlinkasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [createHardLinkAsync](./node-core-library.filesystem.createhardlinkasync.md)
## FileSystem.createHardLinkAsync() method
An async version of [FileSystem.createHardLink()](./node-core-library.filesystem.createhardlink.md)<!-- -->.
<b>Signature:</b>
```typescript
static createHardLinkAsync(options: IFileSystemCreateLinkOptions): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| options | [IFileSystemCreateLinkOptions](./node-core-library.ifilesystemcreatelinkoptions.md) | |
<b>Returns:</b>
Promise&lt;void&gt;

29
pages/api/node-core-library.filesystem.createsymboliclinkfileasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [createSymbolicLinkFileAsync](./node-core-library.filesystem.createsymboliclinkfileasync.md)
## FileSystem.createSymbolicLinkFileAsync() method
An async version of [FileSystem.createSymbolicLinkFile()](./node-core-library.filesystem.createsymboliclinkfile.md)<!-- -->.
<b>Signature:</b>
```typescript
static createSymbolicLinkFileAsync(options: IFileSystemCreateLinkOptions): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| options | [IFileSystemCreateLinkOptions](./node-core-library.ifilesystemcreatelinkoptions.md) | |
<b>Returns:</b>
Promise&lt;void&gt;

29
pages/api/node-core-library.filesystem.createsymboliclinkfolderasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [createSymbolicLinkFolderAsync](./node-core-library.filesystem.createsymboliclinkfolderasync.md)
## FileSystem.createSymbolicLinkFolderAsync() method
An async version of [FileSystem.createSymbolicLinkFolder()](./node-core-library.filesystem.createsymboliclinkfolder.md)<!-- -->.
<b>Signature:</b>
```typescript
static createSymbolicLinkFolderAsync(options: IFileSystemCreateLinkOptions): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| options | [IFileSystemCreateLinkOptions](./node-core-library.ifilesystemcreatelinkoptions.md) | |
<b>Returns:</b>
Promise&lt;void&gt;

29
pages/api/node-core-library.filesystem.createsymboliclinkjunctionasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [createSymbolicLinkJunctionAsync](./node-core-library.filesystem.createsymboliclinkjunctionasync.md)
## FileSystem.createSymbolicLinkJunctionAsync() method
An async version of [FileSystem.createSymbolicLinkJunction()](./node-core-library.filesystem.createsymboliclinkjunction.md)<!-- -->.
<b>Signature:</b>
```typescript
static createSymbolicLinkJunctionAsync(options: IFileSystemCreateLinkOptions): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| options | [IFileSystemCreateLinkOptions](./node-core-library.ifilesystemcreatelinkoptions.md) | |
<b>Returns:</b>
Promise&lt;void&gt;

30
pages/api/node-core-library.filesystem.deletefileasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [deleteFileAsync](./node-core-library.filesystem.deletefileasync.md)
## FileSystem.deleteFileAsync() method
An async version of [FileSystem.deleteFile()](./node-core-library.filesystem.deletefile.md)<!-- -->.
<b>Signature:</b>
```typescript
static deleteFileAsync(filePath: string, options?: IFileSystemDeleteFileOptions): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | string | |
| options | [IFileSystemDeleteFileOptions](./node-core-library.ifilesystemdeletefileoptions.md) | |
<b>Returns:</b>
Promise&lt;void&gt;

29
pages/api/node-core-library.filesystem.deletefolderasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [deleteFolderAsync](./node-core-library.filesystem.deletefolderasync.md)
## FileSystem.deleteFolderAsync() method
An async version of [FileSystem.deleteFolder()](./node-core-library.filesystem.deletefolder.md)<!-- -->.
<b>Signature:</b>
```typescript
static deleteFolderAsync(folderPath: string): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| folderPath | string | |
<b>Returns:</b>
Promise&lt;void&gt;

29
pages/api/node-core-library.filesystem.ensureemptyfolderasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [ensureEmptyFolderAsync](./node-core-library.filesystem.ensureemptyfolderasync.md)
## FileSystem.ensureEmptyFolderAsync() method
An async version of [FileSystem.ensureEmptyFolder()](./node-core-library.filesystem.ensureemptyfolder.md)<!-- -->.
<b>Signature:</b>
```typescript
static ensureEmptyFolderAsync(folderPath: string): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| folderPath | string | |
<b>Returns:</b>
Promise&lt;void&gt;

29
pages/api/node-core-library.filesystem.ensurefolderasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [ensureFolderAsync](./node-core-library.filesystem.ensurefolderasync.md)
## FileSystem.ensureFolderAsync() method
An async version of [FileSystem.ensureFolder()](./node-core-library.filesystem.ensurefolder.md)<!-- -->.
<b>Signature:</b>
```typescript
static ensureFolderAsync(folderPath: string): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| folderPath | string | |
<b>Returns:</b>
Promise&lt;void&gt;

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

@ -14,7 +14,7 @@ Gets the statistics of a filesystem object. Does NOT follow the link to its targ
<b>Signature:</b>
```typescript
static getLinkStatistics(path: string): fs.Stats;
static getLinkStatistics(path: string): FileSystemStats;
```
## Parameters
@ -25,5 +25,5 @@ static getLinkStatistics(path: string): fs.Stats;
<b>Returns:</b>
fs.Stats
[FileSystemStats](./node-core-library.filesystemstats.md)

29
pages/api/node-core-library.filesystem.getlinkstatisticsasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [getLinkStatisticsAsync](./node-core-library.filesystem.getlinkstatisticsasync.md)
## FileSystem.getLinkStatisticsAsync() method
An async version of [FileSystem.getLinkStatistics()](./node-core-library.filesystem.getlinkstatistics.md)<!-- -->.
<b>Signature:</b>
```typescript
static getLinkStatisticsAsync(path: string): Promise<FileSystemStats>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| path | string | |
<b>Returns:</b>
Promise&lt;[FileSystemStats](./node-core-library.filesystemstats.md)<!-- -->&gt;

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

@ -27,3 +27,7 @@ static getPosixModeBits(path: string): PosixModeBits;
[PosixModeBits](./node-core-library.posixmodebits.md)
## Remarks
This calls [FileSystem.getStatistics()](./node-core-library.filesystem.getstatistics.md) to get the POSIX mode bits. If statistics in addition to the mode bits are needed, it is more efficient to call [FileSystem.getStatistics()](./node-core-library.filesystem.getstatistics.md) directly instead.

29
pages/api/node-core-library.filesystem.getposixmodebitsasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [getPosixModeBitsAsync](./node-core-library.filesystem.getposixmodebitsasync.md)
## FileSystem.getPosixModeBitsAsync() method
An async version of [FileSystem.getPosixModeBits()](./node-core-library.filesystem.getposixmodebits.md)<!-- -->.
<b>Signature:</b>
```typescript
static getPosixModeBitsAsync(path: string): Promise<PosixModeBits>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| path | string | |
<b>Returns:</b>
Promise&lt;[PosixModeBits](./node-core-library.posixmodebits.md)<!-- -->&gt;

29
pages/api/node-core-library.filesystem.getrealpathasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [getRealPathAsync](./node-core-library.filesystem.getrealpathasync.md)
## FileSystem.getRealPathAsync() method
An async version of [FileSystem.getRealPath()](./node-core-library.filesystem.getrealpath.md)<!-- -->.
<b>Signature:</b>
```typescript
static getRealPathAsync(linkPath: string): Promise<string>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| linkPath | string | |
<b>Returns:</b>
Promise&lt;string&gt;

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

@ -14,7 +14,7 @@ Gets the statistics for a particular filesystem object. If the path is a link, t
<b>Signature:</b>
```typescript
static getStatistics(path: string): fs.Stats;
static getStatistics(path: string): FileSystemStats;
```
## Parameters
@ -25,5 +25,5 @@ static getStatistics(path: string): fs.Stats;
<b>Returns:</b>
fs.Stats
[FileSystemStats](./node-core-library.filesystemstats.md)

29
pages/api/node-core-library.filesystem.getstatisticsasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [getStatisticsAsync](./node-core-library.filesystem.getstatisticsasync.md)
## FileSystem.getStatisticsAsync() method
An async version of [FileSystem.getStatistics()](./node-core-library.filesystem.getstatistics.md)<!-- -->.
<b>Signature:</b>
```typescript
static getStatisticsAsync(path: string): Promise<FileSystemStats>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| path | string | |
<b>Returns:</b>
Promise&lt;[FileSystemStats](./node-core-library.filesystemstats.md)<!-- -->&gt;

29
pages/api/node-core-library.filesystem.iserrnoexception.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [isErrnoException](./node-core-library.filesystem.iserrnoexception.md)
## FileSystem.isErrnoException() method
Detects if the provided error object is a `NodeJS.ErrnoException`
<b>Signature:</b>
```typescript
static isErrnoException(error: Error): error is NodeJS.ErrnoException;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| error | Error | |
<b>Returns:</b>
error is NodeJS.ErrnoException

29
pages/api/node-core-library.filesystem.isfiledoesnotexisterror.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [isFileDoesNotExistError](./node-core-library.filesystem.isfiledoesnotexisterror.md)
## FileSystem.isFileDoesNotExistError() method
Returns true if the error provided indicates the file does not exist.
<b>Signature:</b>
```typescript
static isFileDoesNotExistError(error: Error): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| error | Error | |
<b>Returns:</b>
boolean

29
pages/api/node-core-library.filesystem.isfolderdoesnotexisterror.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [isFolderDoesNotExistError](./node-core-library.filesystem.isfolderdoesnotexisterror.md)
## FileSystem.isFolderDoesNotExistError() method
Returns true if the error provided indicates the folder does not exist.
<b>Signature:</b>
```typescript
static isFolderDoesNotExistError(error: Error): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| error | Error | |
<b>Returns:</b>
boolean

29
pages/api/node-core-library.filesystem.isnotexisterror.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [isNotExistError](./node-core-library.filesystem.isnotexisterror.md)
## FileSystem.isNotExistError() method
Returns true if the error provided indicates the file or folder does not exist.
<b>Signature:</b>
```typescript
static isNotExistError(error: Error): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| error | Error | |
<b>Returns:</b>
boolean

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

@ -28,26 +28,55 @@ Note that in the documentation, we refer to "filesystem objects", this can be a
| Method | Modifiers | Description |
| --- | --- | --- |
| [appendToFile(filePath, contents, options)](./node-core-library.filesystem.appendtofile.md) | <code>static</code> | Writes a text string to a file on disk, appending to the file if it already exists. Behind the scenes it uses <code>fs.appendFileSync()</code>. |
| [appendToFileAsync(filePath, contents, options)](./node-core-library.filesystem.appendtofileasync.md) | <code>static</code> | An async version of [FileSystem.appendToFile()](./node-core-library.filesystem.appendtofile.md)<!-- -->. |
| [changePosixModeBits(path, mode)](./node-core-library.filesystem.changeposixmodebits.md) | <code>static</code> | Changes the permissions (i.e. file mode bits) for a filesystem object. Behind the scenes it uses <code>fs.chmodSync()</code>. |
| [copyFile(options)](./node-core-library.filesystem.copyfile.md) | <code>static</code> | Copies a file from one location to another. By default, destinationPath is overwritten if it already exists. Behind the scenes it uses <code>fs.copyFileSync()</code>. |
| [changePosixModeBitsAsync(path, mode)](./node-core-library.filesystem.changeposixmodebitsasync.md) | <code>static</code> | An async version of [FileSystem.changePosixModeBits()](./node-core-library.filesystem.changeposixmodebits.md)<!-- -->. |
| [copyFile(options)](./node-core-library.filesystem.copyfile.md) | <code>static</code> | Copies a single file from one location to another. By default, destinationPath is overwritten if it already exists. |
| [copyFileAsync(options)](./node-core-library.filesystem.copyfileasync.md) | <code>static</code> | An async version of [FileSystem.copyFile()](./node-core-library.filesystem.copyfile.md)<!-- -->. |
| [copyFiles(options)](./node-core-library.filesystem.copyfiles.md) | <code>static</code> | Copies a file or folder from one location to another, recursively copying any folder contents. By default, destinationPath is overwritten if it already exists. |
| [copyFilesAsync(options)](./node-core-library.filesystem.copyfilesasync.md) | <code>static</code> | An async version of [FileSystem.copyFiles()](./node-core-library.filesystem.copyfiles.md)<!-- -->. |
| [createHardLink(options)](./node-core-library.filesystem.createhardlink.md) | <code>static</code> | Creates a hard link. Behind the scenes it uses <code>fs.linkSync()</code>. |
| [createHardLinkAsync(options)](./node-core-library.filesystem.createhardlinkasync.md) | <code>static</code> | An async version of [FileSystem.createHardLink()](./node-core-library.filesystem.createhardlink.md)<!-- -->. |
| [createSymbolicLinkFile(options)](./node-core-library.filesystem.createsymboliclinkfile.md) | <code>static</code> | Creates a symbolic link to a file (on Windows this requires elevated permissionsBits). Behind the scenes it uses <code>fs.symlinkSync()</code>. |
| [createSymbolicLinkFileAsync(options)](./node-core-library.filesystem.createsymboliclinkfileasync.md) | <code>static</code> | An async version of [FileSystem.createSymbolicLinkFile()](./node-core-library.filesystem.createsymboliclinkfile.md)<!-- -->. |
| [createSymbolicLinkFolder(options)](./node-core-library.filesystem.createsymboliclinkfolder.md) | <code>static</code> | Creates a symbolic link to a folder (on Windows this requires elevated permissionsBits). Behind the scenes it uses <code>fs.symlinkSync()</code>. |
| [createSymbolicLinkFolderAsync(options)](./node-core-library.filesystem.createsymboliclinkfolderasync.md) | <code>static</code> | An async version of [FileSystem.createSymbolicLinkFolder()](./node-core-library.filesystem.createsymboliclinkfolder.md)<!-- -->. |
| [createSymbolicLinkJunction(options)](./node-core-library.filesystem.createsymboliclinkjunction.md) | <code>static</code> | Creates a Windows "directory junction". Behaves like <code>createSymbolicLinkToFile()</code> on other platforms. Behind the scenes it uses <code>fs.symlinkSync()</code>. |
| [createSymbolicLinkJunctionAsync(options)](./node-core-library.filesystem.createsymboliclinkjunctionasync.md) | <code>static</code> | An async version of [FileSystem.createSymbolicLinkJunction()](./node-core-library.filesystem.createsymboliclinkjunction.md)<!-- -->. |
| [deleteFile(filePath, options)](./node-core-library.filesystem.deletefile.md) | <code>static</code> | Deletes a file. Can optionally throw if the file doesn't exist. Behind the scenes it uses <code>fs.unlinkSync()</code>. |
| [deleteFileAsync(filePath, options)](./node-core-library.filesystem.deletefileasync.md) | <code>static</code> | An async version of [FileSystem.deleteFile()](./node-core-library.filesystem.deletefile.md)<!-- -->. |
| [deleteFolder(folderPath)](./node-core-library.filesystem.deletefolder.md) | <code>static</code> | Deletes a folder, including all of its contents. Behind the scenes is uses <code>fs-extra.removeSync()</code>. |
| [deleteFolderAsync(folderPath)](./node-core-library.filesystem.deletefolderasync.md) | <code>static</code> | An async version of [FileSystem.deleteFolder()](./node-core-library.filesystem.deletefolder.md)<!-- -->. |
| [ensureEmptyFolder(folderPath)](./node-core-library.filesystem.ensureemptyfolder.md) | <code>static</code> | Deletes the content of a folder, but not the folder itself. Also ensures the folder exists. Behind the scenes it uses <code>fs-extra.emptyDirSync()</code>. |
| [ensureEmptyFolderAsync(folderPath)](./node-core-library.filesystem.ensureemptyfolderasync.md) | <code>static</code> | An async version of [FileSystem.ensureEmptyFolder()](./node-core-library.filesystem.ensureemptyfolder.md)<!-- -->. |
| [ensureFolder(folderPath)](./node-core-library.filesystem.ensurefolder.md) | <code>static</code> | Recursively creates a folder at a given path. Behind the scenes is uses <code>fs-extra.ensureDirSync()</code>. |
| [ensureFolderAsync(folderPath)](./node-core-library.filesystem.ensurefolderasync.md) | <code>static</code> | An async version of [FileSystem.ensureFolder()](./node-core-library.filesystem.ensurefolder.md)<!-- -->. |
| [exists(path)](./node-core-library.filesystem.exists.md) | <code>static</code> | Returns true if the path exists on disk. Behind the scenes it uses <code>fs.existsSync()</code>. |
| [formatPosixModeBits(modeBits)](./node-core-library.filesystem.formatposixmodebits.md) | <code>static</code> | Returns a 10-character string representation of a PosixModeBits value similar to what would be displayed by a command such as "ls -l" on a POSIX-like operating system. |
| [getLinkStatistics(path)](./node-core-library.filesystem.getlinkstatistics.md) | <code>static</code> | Gets the statistics of a filesystem object. Does NOT follow the link to its target. Behind the scenes it uses <code>fs.lstatSync()</code>. |
| [getLinkStatisticsAsync(path)](./node-core-library.filesystem.getlinkstatisticsasync.md) | <code>static</code> | An async version of [FileSystem.getLinkStatistics()](./node-core-library.filesystem.getlinkstatistics.md)<!-- -->. |
| [getPosixModeBits(path)](./node-core-library.filesystem.getposixmodebits.md) | <code>static</code> | Retrieves the permissions (i.e. file mode bits) for a filesystem object. Behind the scenes it uses <code>fs.chmodSync()</code>. |
| [getPosixModeBitsAsync(path)](./node-core-library.filesystem.getposixmodebitsasync.md) | <code>static</code> | An async version of [FileSystem.getPosixModeBits()](./node-core-library.filesystem.getposixmodebits.md)<!-- -->. |
| [getRealPath(linkPath)](./node-core-library.filesystem.getrealpath.md) | <code>static</code> | Follows a link to its destination and returns the absolute path to the final target of the link. Behind the scenes it uses <code>fs.realpathSync()</code>. |
| [getRealPathAsync(linkPath)](./node-core-library.filesystem.getrealpathasync.md) | <code>static</code> | An async version of [FileSystem.getRealPath()](./node-core-library.filesystem.getrealpath.md)<!-- -->. |
| [getStatistics(path)](./node-core-library.filesystem.getstatistics.md) | <code>static</code> | Gets the statistics for a particular filesystem object. If the path is a link, this function follows the link and returns statistics about the link target. Behind the scenes it uses <code>fs.statSync()</code>. |
| [getStatisticsAsync(path)](./node-core-library.filesystem.getstatisticsasync.md) | <code>static</code> | An async version of [FileSystem.getStatistics()](./node-core-library.filesystem.getstatistics.md)<!-- -->. |
| [isErrnoException(error)](./node-core-library.filesystem.iserrnoexception.md) | <code>static</code> | Detects if the provided error object is a <code>NodeJS.ErrnoException</code> |
| [isFileDoesNotExistError(error)](./node-core-library.filesystem.isfiledoesnotexisterror.md) | <code>static</code> | Returns true if the error provided indicates the file does not exist. |
| [isFolderDoesNotExistError(error)](./node-core-library.filesystem.isfolderdoesnotexisterror.md) | <code>static</code> | Returns true if the error provided indicates the folder does not exist. |
| [isNotExistError(error)](./node-core-library.filesystem.isnotexisterror.md) | <code>static</code> | Returns true if the error provided indicates the file or folder does not exist. |
| [move(options)](./node-core-library.filesystem.move.md) | <code>static</code> | Moves a file. The folder must exist, unless the <code>ensureFolderExists</code> option is provided. Behind the scenes it uses <code>fs-extra.moveSync()</code> |
| [moveAsync(options)](./node-core-library.filesystem.moveasync.md) | <code>static</code> | An async version of [FileSystem.move()](./node-core-library.filesystem.move.md)<!-- -->. |
| [readFile(filePath, options)](./node-core-library.filesystem.readfile.md) | <code>static</code> | Reads the contents of a file into a string. Behind the scenes it uses <code>fs.readFileSync()</code>. |
| [readFileAsync(filePath, options)](./node-core-library.filesystem.readfileasync.md) | <code>static</code> | An async version of [FileSystem.readFile()](./node-core-library.filesystem.readfile.md)<!-- -->. |
| [readFileToBuffer(filePath)](./node-core-library.filesystem.readfiletobuffer.md) | <code>static</code> | Reads the contents of a file into a buffer. Behind the scenes is uses <code>fs.readFileSync()</code>. |
| [readFileToBufferAsync(filePath)](./node-core-library.filesystem.readfiletobufferasync.md) | <code>static</code> | An async version of [FileSystem.readFileToBuffer()](./node-core-library.filesystem.readfiletobuffer.md)<!-- -->. |
| [readFolder(folderPath, options)](./node-core-library.filesystem.readfolder.md) | <code>static</code> | Reads the contents of the folder, not including "." or "..". Behind the scenes it uses <code>fs.readdirSync()</code>. |
| [readFolderAsync(folderPath, options)](./node-core-library.filesystem.readfolderasync.md) | <code>static</code> | An async version of [FileSystem.readFolder()](./node-core-library.filesystem.readfolder.md)<!-- -->. |
| [readLink(path)](./node-core-library.filesystem.readlink.md) | <code>static</code> | If <code>path</code> refers to a symbolic link, this returns the path of the link target, which may be an absolute or relative path. |
| [readLinkAsync(path)](./node-core-library.filesystem.readlinkasync.md) | <code>static</code> | An async version of [FileSystem.readLink()](./node-core-library.filesystem.readlink.md)<!-- -->. |
| [updateTimes(path, times)](./node-core-library.filesystem.updatetimes.md) | <code>static</code> | Updates the accessed and modified timestamps of the filesystem object referenced by path. Behind the scenes it uses <code>fs.utimesSync()</code>. The caller should specify both times in the <code>times</code> parameter. |
| [updateTimesAsync(path, times)](./node-core-library.filesystem.updatetimesasync.md) | <code>static</code> | An async version of [FileSystem.updateTimes()](./node-core-library.filesystem.updatetimes.md)<!-- -->. |
| [writeFile(filePath, contents, options)](./node-core-library.filesystem.writefile.md) | <code>static</code> | Writes a text string to a file on disk, overwriting the file if it already exists. Behind the scenes it uses <code>fs.writeFileSync()</code>. |
| [writeFileAsync(filePath, contents, options)](./node-core-library.filesystem.writefileasync.md) | <code>static</code> | An async version of [FileSystem.writeFile()](./node-core-library.filesystem.writefile.md)<!-- -->. |

29
pages/api/node-core-library.filesystem.moveasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [moveAsync](./node-core-library.filesystem.moveasync.md)
## FileSystem.moveAsync() method
An async version of [FileSystem.move()](./node-core-library.filesystem.move.md)<!-- -->.
<b>Signature:</b>
```typescript
static moveAsync(options: IFileSystemMoveOptions): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| options | [IFileSystemMoveOptions](./node-core-library.ifilesystemmoveoptions.md) | |
<b>Returns:</b>
Promise&lt;void&gt;

30
pages/api/node-core-library.filesystem.readfileasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [readFileAsync](./node-core-library.filesystem.readfileasync.md)
## FileSystem.readFileAsync() method
An async version of [FileSystem.readFile()](./node-core-library.filesystem.readfile.md)<!-- -->.
<b>Signature:</b>
```typescript
static readFileAsync(filePath: string, options?: IFileSystemReadFileOptions): Promise<string>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | string | |
| options | [IFileSystemReadFileOptions](./node-core-library.ifilesystemreadfileoptions.md) | |
<b>Returns:</b>
Promise&lt;string&gt;

29
pages/api/node-core-library.filesystem.readfiletobufferasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [readFileToBufferAsync](./node-core-library.filesystem.readfiletobufferasync.md)
## FileSystem.readFileToBufferAsync() method
An async version of [FileSystem.readFileToBuffer()](./node-core-library.filesystem.readfiletobuffer.md)<!-- -->.
<b>Signature:</b>
```typescript
static readFileToBufferAsync(filePath: string): Promise<Buffer>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | string | |
<b>Returns:</b>
Promise&lt;Buffer&gt;

30
pages/api/node-core-library.filesystem.readfolderasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [readFolderAsync](./node-core-library.filesystem.readfolderasync.md)
## FileSystem.readFolderAsync() method
An async version of [FileSystem.readFolder()](./node-core-library.filesystem.readfolder.md)<!-- -->.
<b>Signature:</b>
```typescript
static readFolderAsync(folderPath: string, options?: IFileSystemReadFolderOptions): Promise<string[]>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| folderPath | string | |
| options | [IFileSystemReadFolderOptions](./node-core-library.ifilesystemreadfolderoptions.md) | |
<b>Returns:</b>
Promise&lt;string\[\]&gt;

35
pages/api/node-core-library.filesystem.readlink.md Normal file
Просмотреть файл

@ -0,0 +1,35 @@
---
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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [readLink](./node-core-library.filesystem.readlink.md)
## FileSystem.readLink() method
If `path` refers to a symbolic link, this returns the path of the link target, which may be an absolute or relative path.
<b>Signature:</b>
```typescript
static readLink(path: string): string;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| path | string | The absolute or relative path to the symbolic link. |
<b>Returns:</b>
string
the path of the link target
## Remarks
If `path` refers to a filesystem object that is not a symbolic link, then an `ErrnoException` is thrown with code 'UNKNOWN'. If `path` does not exist, then an `ErrnoException` is thrown with code `ENOENT`<!-- -->.

29
pages/api/node-core-library.filesystem.readlinkasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [readLinkAsync](./node-core-library.filesystem.readlinkasync.md)
## FileSystem.readLinkAsync() method
An async version of [FileSystem.readLink()](./node-core-library.filesystem.readlink.md)<!-- -->.
<b>Signature:</b>
```typescript
static readLinkAsync(path: string): Promise<string>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| path | string | |
<b>Returns:</b>
Promise&lt;string&gt;

30
pages/api/node-core-library.filesystem.updatetimesasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [updateTimesAsync](./node-core-library.filesystem.updatetimesasync.md)
## FileSystem.updateTimesAsync() method
An async version of [FileSystem.updateTimes()](./node-core-library.filesystem.updatetimes.md)<!-- -->.
<b>Signature:</b>
```typescript
static updateTimesAsync(path: string, times: IFileSystemUpdateTimeParameters): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| path | string | |
| times | [IFileSystemUpdateTimeParameters](./node-core-library.ifilesystemupdatetimeparameters.md) | |
<b>Returns:</b>
Promise&lt;void&gt;

31
pages/api/node-core-library.filesystem.writefileasync.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/node-core-library](./node-core-library.md) &gt; [FileSystem](./node-core-library.filesystem.md) &gt; [writeFileAsync](./node-core-library.filesystem.writefileasync.md)
## FileSystem.writeFileAsync() method
An async version of [FileSystem.writeFile()](./node-core-library.filesystem.writefile.md)<!-- -->.
<b>Signature:</b>
```typescript
static writeFileAsync(filePath: string, contents: string | Buffer, options?: IFileSystemWriteFileOptions): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| filePath | string | |
| contents | string \| Buffer | |
| options | [IFileSystemWriteFileOptions](./node-core-library.ifilesystemwritefileoptions.md) | |
<b>Returns:</b>
Promise&lt;void&gt;

18
pages/api/node-core-library.filesystemcopyfilesasyncfilter.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/node-core-library](./node-core-library.md) &gt; [FileSystemCopyFilesAsyncFilter](./node-core-library.filesystemcopyfilesasyncfilter.md)
## FileSystemCopyFilesAsyncFilter type
Callback function type for [IFileSystemCopyFilesAsyncOptions.filter](./node-core-library.ifilesystemcopyfilesasyncoptions.filter.md)
<b>Signature:</b>
```typescript
export declare type FileSystemCopyFilesAsyncFilter = (sourcePath: string, destinationPath: string) => Promise<boolean>;
```

18
pages/api/node-core-library.filesystemcopyfilesfilter.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/node-core-library](./node-core-library.md) &gt; [FileSystemCopyFilesFilter](./node-core-library.filesystemcopyfilesfilter.md)
## FileSystemCopyFilesFilter type
Callback function type for [IFileSystemCopyFilesOptions.filter](./node-core-library.ifilesystemcopyfilesoptions.filter.md)
<b>Signature:</b>
```typescript
export declare type FileSystemCopyFilesFilter = (sourcePath: string, destinationPath: string) => boolean;
```

23
pages/api/node-core-library.filesystemstats.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; [@rushstack/node-core-library](./node-core-library.md) &gt; [FileSystemStats](./node-core-library.filesystemstats.md)
## FileSystemStats type
An alias for the Node.js `fs.Stats` object.
<b>Signature:</b>
```typescript
export declare type FileSystemStats = fs.Stats;
```
## Remarks
This avoids the need to import the `fs` package when using the [FileSystem](./node-core-library.filesystem.md) API.

18
pages/api/node-core-library.ifilesystemcopyfileoptions.alreadyexistsbehavior.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/node-core-library](./node-core-library.md) &gt; [IFileSystemCopyFileOptions](./node-core-library.ifilesystemcopyfileoptions.md) &gt; [alreadyExistsBehavior](./node-core-library.ifilesystemcopyfileoptions.alreadyexistsbehavior.md)
## IFileSystemCopyFileOptions.alreadyExistsBehavior property
Specifies what to do if the target object already exists.
<b>Signature:</b>
```typescript
alreadyExistsBehavior?: AlreadyExistsBehavior;
```

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

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemCopyFileOptions interface
The options for FileSystem.copyFile()
The options for [FileSystem.copyFile()](./node-core-library.filesystem.copyfile.md)
<b>Signature:</b>
@ -21,6 +21,7 @@ export interface IFileSystemCopyFileOptions
| Property | Type | Description |
| --- | --- | --- |
| [alreadyExistsBehavior](./node-core-library.ifilesystemcopyfileoptions.alreadyexistsbehavior.md) | [AlreadyExistsBehavior](./node-core-library.alreadyexistsbehavior.md) | Specifies what to do if the target object already exists. |
| [destinationPath](./node-core-library.ifilesystemcopyfileoptions.destinationpath.md) | string | The path that the object will be copied to. The path may be absolute or relative. |
| [sourcePath](./node-core-library.ifilesystemcopyfileoptions.sourcepath.md) | string | The path of the existing object to be copied. The path may be absolute or relative. |

18
pages/api/node-core-library.ifilesystemcopyfilesasyncoptions.alreadyexistsbehavior.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/node-core-library](./node-core-library.md) &gt; [IFileSystemCopyFilesAsyncOptions](./node-core-library.ifilesystemcopyfilesasyncoptions.md) &gt; [alreadyExistsBehavior](./node-core-library.ifilesystemcopyfilesasyncoptions.alreadyexistsbehavior.md)
## IFileSystemCopyFilesAsyncOptions.alreadyExistsBehavior property
Specifies what to do if the target object already exists.
<b>Signature:</b>
```typescript
alreadyExistsBehavior?: AlreadyExistsBehavior;
```

18
pages/api/node-core-library.ifilesystemcopyfilesasyncoptions.dereferencesymlinks.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/node-core-library](./node-core-library.md) &gt; [IFileSystemCopyFilesAsyncOptions](./node-core-library.ifilesystemcopyfilesasyncoptions.md) &gt; [dereferenceSymlinks](./node-core-library.ifilesystemcopyfilesasyncoptions.dereferencesymlinks.md)
## IFileSystemCopyFilesAsyncOptions.dereferenceSymlinks property
If true, then when copying symlinks, copy the target object instead of copying the link.
<b>Signature:</b>
```typescript
dereferenceSymlinks?: boolean;
```

18
pages/api/node-core-library.ifilesystemcopyfilesasyncoptions.destinationpath.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/node-core-library](./node-core-library.md) &gt; [IFileSystemCopyFilesAsyncOptions](./node-core-library.ifilesystemcopyfilesasyncoptions.md) &gt; [destinationPath](./node-core-library.ifilesystemcopyfilesasyncoptions.destinationpath.md)
## IFileSystemCopyFilesAsyncOptions.destinationPath property
The path that the files will be copied to. The path may be absolute or relative.
<b>Signature:</b>
```typescript
destinationPath: string;
```

18
pages/api/node-core-library.ifilesystemcopyfilesasyncoptions.filter.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/node-core-library](./node-core-library.md) &gt; [IFileSystemCopyFilesAsyncOptions](./node-core-library.ifilesystemcopyfilesasyncoptions.md) &gt; [filter](./node-core-library.ifilesystemcopyfilesasyncoptions.filter.md)
## IFileSystemCopyFilesAsyncOptions.filter property
A callback that will be invoked for each path that is copied. The callback can return `false` to cause the object to be excluded from the operation.
<b>Signature:</b>
```typescript
filter?: FileSystemCopyFilesAsyncFilter | FileSystemCopyFilesFilter;
```

30
pages/api/node-core-library.ifilesystemcopyfilesasyncoptions.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/node-core-library](./node-core-library.md) &gt; [IFileSystemCopyFilesAsyncOptions](./node-core-library.ifilesystemcopyfilesasyncoptions.md)
## IFileSystemCopyFilesAsyncOptions interface
The options for [FileSystem.copyFilesAsync()](./node-core-library.filesystem.copyfilesasync.md)
<b>Signature:</b>
```typescript
export interface IFileSystemCopyFilesAsyncOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [alreadyExistsBehavior](./node-core-library.ifilesystemcopyfilesasyncoptions.alreadyexistsbehavior.md) | [AlreadyExistsBehavior](./node-core-library.alreadyexistsbehavior.md) | Specifies what to do if the target object already exists. |
| [dereferenceSymlinks](./node-core-library.ifilesystemcopyfilesasyncoptions.dereferencesymlinks.md) | boolean | If true, then when copying symlinks, copy the target object instead of copying the link. |
| [destinationPath](./node-core-library.ifilesystemcopyfilesasyncoptions.destinationpath.md) | string | The path that the files will be copied to. The path may be absolute or relative. |
| [filter](./node-core-library.ifilesystemcopyfilesasyncoptions.filter.md) | [FileSystemCopyFilesAsyncFilter](./node-core-library.filesystemcopyfilesasyncfilter.md) \| [FileSystemCopyFilesFilter](./node-core-library.filesystemcopyfilesfilter.md) | A callback that will be invoked for each path that is copied. The callback can return <code>false</code> to cause the object to be excluded from the operation. |
| [preserveTimestamps](./node-core-library.ifilesystemcopyfilesasyncoptions.preservetimestamps.md) | boolean | If true, then the target object will be assigned "last modification" and "last access" timestamps that are the same as the source. Otherwise, the OS default timestamps are assigned. |
| [sourcePath](./node-core-library.ifilesystemcopyfilesasyncoptions.sourcepath.md) | string | The starting path of the file or folder to be copied. The path may be absolute or relative. |

18
pages/api/node-core-library.ifilesystemcopyfilesasyncoptions.preservetimestamps.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/node-core-library](./node-core-library.md) &gt; [IFileSystemCopyFilesAsyncOptions](./node-core-library.ifilesystemcopyfilesasyncoptions.md) &gt; [preserveTimestamps](./node-core-library.ifilesystemcopyfilesasyncoptions.preservetimestamps.md)
## IFileSystemCopyFilesAsyncOptions.preserveTimestamps property
If true, then the target object will be assigned "last modification" and "last access" timestamps that are the same as the source. Otherwise, the OS default timestamps are assigned.
<b>Signature:</b>
```typescript
preserveTimestamps?: boolean;
```

18
pages/api/node-core-library.ifilesystemcopyfilesasyncoptions.sourcepath.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/node-core-library](./node-core-library.md) &gt; [IFileSystemCopyFilesAsyncOptions](./node-core-library.ifilesystemcopyfilesasyncoptions.md) &gt; [sourcePath](./node-core-library.ifilesystemcopyfilesasyncoptions.sourcepath.md)
## IFileSystemCopyFilesAsyncOptions.sourcePath property
The starting path of the file or folder to be copied. The path may be absolute or relative.
<b>Signature:</b>
```typescript
sourcePath: string;
```

18
pages/api/node-core-library.ifilesystemcopyfilesoptions.filter.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/node-core-library](./node-core-library.md) &gt; [IFileSystemCopyFilesOptions](./node-core-library.ifilesystemcopyfilesoptions.md) &gt; [filter](./node-core-library.ifilesystemcopyfilesoptions.filter.md)
## IFileSystemCopyFilesOptions.filter property
A callback that will be invoked for each path that is copied. The callback can return `false` to cause the object to be excluded from the operation.
<b>Signature:</b>
```typescript
filter?: FileSystemCopyFilesFilter;
```

25
pages/api/node-core-library.ifilesystemcopyfilesoptions.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/node-core-library](./node-core-library.md) &gt; [IFileSystemCopyFilesOptions](./node-core-library.ifilesystemcopyfilesoptions.md)
## IFileSystemCopyFilesOptions interface
The options for [FileSystem.copyFiles()](./node-core-library.filesystem.copyfiles.md)
<b>Signature:</b>
```typescript
export interface IFileSystemCopyFilesOptions extends IFileSystemCopyFilesAsyncOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [filter](./node-core-library.ifilesystemcopyfilesoptions.filter.md) | [FileSystemCopyFilesFilter](./node-core-library.filesystemcopyfilesfilter.md) | A callback that will be invoked for each path that is copied. The callback can return <code>false</code> to cause the object to be excluded from the operation. |

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

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemCreateLinkOptions interface
The options for `FileSystem.createSymbolicLinkJunction()`<!-- -->, `createSymbolicLinkFile()`<!-- -->, `createSymbolicLinkFolder()`<!-- -->, and `createHardLink()`<!-- -->.
The options for [FileSystem.createSymbolicLinkJunction()](./node-core-library.filesystem.createsymboliclinkjunction.md)<!-- -->, [FileSystem.createSymbolicLinkFile()](./node-core-library.filesystem.createsymboliclinkfile.md)<!-- -->, [FileSystem.createSymbolicLinkFolder()](./node-core-library.filesystem.createsymboliclinkfolder.md)<!-- -->, and [FileSystem.createHardLink()](./node-core-library.filesystem.createhardlink.md)<!-- -->.
<b>Signature:</b>

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

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemDeleteFileOptions interface
The options for FileSystem.deleteFile()
The options for [FileSystem.deleteFile()](./node-core-library.filesystem.deletefile.md)
<b>Signature:</b>

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

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemMoveOptions interface
The options for FileSystem.move()
The options for [FileSystem.move()](./node-core-library.filesystem.move.md)
<b>Signature:</b>

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

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemReadFileOptions interface
The options for FileSystem.readFile()
The options for [FileSystem.readFile()](./node-core-library.filesystem.readfile.md)
<b>Signature:</b>

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

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemReadFolderOptions interface
The options for FileSystem.readFolder()
The options for [FileSystem.readFolder()](./node-core-library.filesystem.readfolder.md)
<b>Signature:</b>

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

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemUpdateTimeParameters interface
The parameters for `updateTimes()`<!-- -->. Both times must be specified.
The options for [FileSystem.updateTimes()](./node-core-library.filesystem.updatetimes.md) Both times must be specified.
<b>Signature:</b>

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

@ -9,7 +9,7 @@ improve_this_button: false
## IFileSystemWriteFileOptions interface
The options for FileSystem.writeFile()
The options for [FileSystem.writeFile()](./node-core-library.filesystem.writefile.md)
<b>Signature:</b>

18
pages/api/node-core-library.ipackagenameparseroptions.allowuppercase.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/node-core-library](./node-core-library.md) &gt; [IPackageNameParserOptions](./node-core-library.ipackagenameparseroptions.md) &gt; [allowUpperCase](./node-core-library.ipackagenameparseroptions.allowuppercase.md)
## IPackageNameParserOptions.allowUpperCase property
If true, allows upper-case letters in package names. This improves compatibility with some legacy private registries that still allow that.
<b>Signature:</b>
```typescript
allowUpperCase?: boolean;
```

37
pages/api/node-core-library.ipackagenameparseroptions.md Normal file
Просмотреть файл

@ -0,0 +1,37 @@
---
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/node-core-library](./node-core-library.md) &gt; [IPackageNameParserOptions](./node-core-library.ipackagenameparseroptions.md)
## IPackageNameParserOptions interface
Options that configure the validation rules used by a [PackageNameParser](./node-core-library.packagenameparser.md) instance.
<b>Signature:</b>
```typescript
export interface IPackageNameParserOptions
```
## Remarks
The default validation is based on the npmjs.com registry's policy for published packages, and includes these restrictions:
- The package name cannot be longer than 214 characters.
- The package name must not be empty.
- Other than the `@` and `/` delimiters used for scopes, the only allowed characters are letters, numbers, `-`<!-- -->, `_`<!-- -->, and `.`<!-- -->.
- The name must not start with a `.` or `_`<!-- -->.
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [allowUpperCase](./node-core-library.ipackagenameparseroptions.allowuppercase.md) | boolean | If true, allows upper-case letters in package names. This improves compatibility with some legacy private registries that still allow that. |

31
pages/api/node-core-library.jsonfile.loadandvalidateasync.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/node-core-library](./node-core-library.md) &gt; [JsonFile](./node-core-library.jsonfile.md) &gt; [loadAndValidateAsync](./node-core-library.jsonfile.loadandvalidateasync.md)
## JsonFile.loadAndValidateAsync() method
An async version of [JsonFile.loadAndValidate()](./node-core-library.jsonfile.loadandvalidate.md)<!-- -->.
<b>Signature:</b>
```typescript
static loadAndValidateAsync(jsonFilename: string, jsonSchema: JsonSchema, options?: IJsonSchemaValidateOptions): Promise<JsonObject>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| jsonFilename | string | |
| jsonSchema | [JsonSchema](./node-core-library.jsonschema.md) | |
| options | [IJsonSchemaValidateOptions](./node-core-library.ijsonschemavalidateoptions.md) | |
<b>Returns:</b>
Promise&lt;[JsonObject](./node-core-library.jsonobject.md)<!-- -->&gt;

31
pages/api/node-core-library.jsonfile.loadandvalidatewithcallbackasync.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/node-core-library](./node-core-library.md) &gt; [JsonFile](./node-core-library.jsonfile.md) &gt; [loadAndValidateWithCallbackAsync](./node-core-library.jsonfile.loadandvalidatewithcallbackasync.md)
## JsonFile.loadAndValidateWithCallbackAsync() method
An async version of [JsonFile.loadAndValidateWithCallback()](./node-core-library.jsonfile.loadandvalidatewithcallback.md)<!-- -->.
<b>Signature:</b>
```typescript
static loadAndValidateWithCallbackAsync(jsonFilename: string, jsonSchema: JsonSchema, errorCallback: (errorInfo: IJsonSchemaErrorInfo) => void): Promise<JsonObject>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| jsonFilename | string | |
| jsonSchema | [JsonSchema](./node-core-library.jsonschema.md) | |
| errorCallback | (errorInfo: [IJsonSchemaErrorInfo](./node-core-library.ijsonschemaerrorinfo.md)<!-- -->) =&gt; void | |
<b>Returns:</b>
Promise&lt;[JsonObject](./node-core-library.jsonobject.md)<!-- -->&gt;

29
pages/api/node-core-library.jsonfile.loadasync.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/node-core-library](./node-core-library.md) &gt; [JsonFile](./node-core-library.jsonfile.md) &gt; [loadAsync](./node-core-library.jsonfile.loadasync.md)
## JsonFile.loadAsync() method
An async version of [JsonFile.load()](./node-core-library.jsonfile.load.md)<!-- -->.
<b>Signature:</b>
```typescript
static loadAsync(jsonFilename: string): Promise<JsonObject>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| jsonFilename | string | |
<b>Returns:</b>
Promise&lt;[JsonObject](./node-core-library.jsonobject.md)<!-- -->&gt;

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

@ -23,8 +23,13 @@ export declare class JsonFile
| --- | --- | --- |
| [load(jsonFilename)](./node-core-library.jsonfile.load.md) | <code>static</code> | Loads a JSON file. |
| [loadAndValidate(jsonFilename, jsonSchema, options)](./node-core-library.jsonfile.loadandvalidate.md) | <code>static</code> | Loads a JSON file and validate its schema. |
| [loadAndValidateAsync(jsonFilename, jsonSchema, options)](./node-core-library.jsonfile.loadandvalidateasync.md) | <code>static</code> | An async version of [JsonFile.loadAndValidate()](./node-core-library.jsonfile.loadandvalidate.md)<!-- -->. |
| [loadAndValidateWithCallback(jsonFilename, jsonSchema, errorCallback)](./node-core-library.jsonfile.loadandvalidatewithcallback.md) | <code>static</code> | Loads a JSON file and validate its schema, reporting errors using a callback |
| [loadAndValidateWithCallbackAsync(jsonFilename, jsonSchema, errorCallback)](./node-core-library.jsonfile.loadandvalidatewithcallbackasync.md) | <code>static</code> | An async version of [JsonFile.loadAndValidateWithCallback()](./node-core-library.jsonfile.loadandvalidatewithcallback.md)<!-- -->. |
| [loadAsync(jsonFilename)](./node-core-library.jsonfile.loadasync.md) | <code>static</code> | An async version of [JsonFile.load()](./node-core-library.jsonfile.load.md)<!-- -->. |
| [parseString(jsonContents)](./node-core-library.jsonfile.parsestring.md) | <code>static</code> | Parses a JSON file's contents. |
| [save(jsonObject, jsonFilename, options)](./node-core-library.jsonfile.save.md) | <code>static</code> | Saves the file to disk. Returns false if nothing was written due to options.onlyIfChanged. |
| [saveAsync(jsonObject, jsonFilename, options)](./node-core-library.jsonfile.saveasync.md) | <code>static</code> | An async version of [JsonFile.loadAndValidateWithCallback()](./node-core-library.jsonfile.loadandvalidatewithcallback.md)<!-- -->. |
| [stringify(jsonObject, options)](./node-core-library.jsonfile.stringify.md) | <code>static</code> | Serializes the specified JSON object to a string buffer. |
| [updateString(previousJson, newJsonObject, options)](./node-core-library.jsonfile.updatestring.md) | <code>static</code> | Serializes the specified JSON object to a string buffer. |
| [validateNoUndefinedMembers(jsonObject)](./node-core-library.jsonfile.validatenoundefinedmembers.md) | <code>static</code> | Used to validate a data structure before writing. Reports an error if there are any undefined members. |

29
pages/api/node-core-library.jsonfile.parsestring.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/node-core-library](./node-core-library.md) &gt; [JsonFile](./node-core-library.jsonfile.md) &gt; [parseString](./node-core-library.jsonfile.parsestring.md)
## JsonFile.parseString() method
Parses a JSON file's contents.
<b>Signature:</b>
```typescript
static parseString(jsonContents: string): JsonObject;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| jsonContents | string | |
<b>Returns:</b>
[JsonObject](./node-core-library.jsonobject.md)

31
pages/api/node-core-library.jsonfile.saveasync.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/node-core-library](./node-core-library.md) &gt; [JsonFile](./node-core-library.jsonfile.md) &gt; [saveAsync](./node-core-library.jsonfile.saveasync.md)
## JsonFile.saveAsync() method
An async version of [JsonFile.loadAndValidateWithCallback()](./node-core-library.jsonfile.loadandvalidatewithcallback.md)<!-- -->.
<b>Signature:</b>
```typescript
static saveAsync(jsonObject: JsonObject, jsonFilename: string, options?: IJsonFileSaveOptions): Promise<boolean>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| jsonObject | [JsonObject](./node-core-library.jsonobject.md) | |
| jsonFilename | string | |
| options | [IJsonFileSaveOptions](./node-core-library.ijsonfilesaveoptions.md) | |
<b>Returns:</b>
Promise&lt;boolean&gt;

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

@ -27,7 +27,8 @@ Core libraries that every NodeJS toolchain project should use.
| [LockFile](./node-core-library.lockfile.md) | A helper utility for working with file-based locks. This class should only be used for locking resources across processes, but should not be used for attempting to lock a resource in the same process. |
| [MapExtensions](./node-core-library.mapextensions.md) | Helper functions for working with the <code>Map&lt;K, V&gt;</code> data type. |
| [PackageJsonLookup](./node-core-library.packagejsonlookup.md) | This class provides methods for finding the nearest "package.json" for a folder and retrieving the name of the package. The results are cached. |
| [PackageName](./node-core-library.packagename.md) | Various functions for working with package names that may include scopes. |
| [PackageName](./node-core-library.packagename.md) | Provides basic operations for validating and manipulating NPM package names such as <code>my-package</code> or <code>@scope/my-package</code>. |
| [PackageNameParser](./node-core-library.packagenameparser.md) | A configurable parser for validating and manipulating NPM package names such as <code>my-package</code> or <code>@scope/my-package</code>. |
| [Path](./node-core-library.path.md) | Common operations for manipulating file and directory paths. |
| [ProtectableMap](./node-core-library.protectablemap.md) | The ProtectableMap provides an easy way for an API to expose a <code>Map&lt;K, V&gt;</code> property while intercepting and validating any write operations that are performed by consumers of the API. |
| [Sort](./node-core-library.sort.md) | Operations for sorting collections. |
@ -40,6 +41,7 @@ Core libraries that every NodeJS toolchain project should use.
| Enumeration | Description |
| --- | --- |
| [AlreadyExistsBehavior](./node-core-library.alreadyexistsbehavior.md) | Specifies the behavior of [FileSystem.copyFiles()](./node-core-library.filesystem.copyfiles.md) in a situation where the target object already exists. |
| [ColorValue](./node-core-library.colorvalue.md) | <b><i>(BETA)</i></b> Colors used with [IColorableSequence](./node-core-library.icolorablesequence.md)<!-- -->. |
| [Encoding](./node-core-library.encoding.md) | The allowed types of encodings, as supported by Node.js |
| [FileConstants](./node-core-library.fileconstants.md) | String constants for common filenames and parts of filenames. |
@ -57,14 +59,16 @@ Core libraries that every NodeJS toolchain project should use.
| [IConsoleTerminalProviderOptions](./node-core-library.iconsoleterminalprovideroptions.md) | <b><i>(BETA)</i></b> Options to be provided to a [ConsoleTerminalProvider](./node-core-library.consoleterminalprovider.md) |
| [IExecutableResolveOptions](./node-core-library.iexecutableresolveoptions.md) | Options for Executable.tryResolve(). |
| [IExecutableSpawnSyncOptions](./node-core-library.iexecutablespawnsyncoptions.md) | Options for Executable.execute(). |
| [IFileSystemCopyFileOptions](./node-core-library.ifilesystemcopyfileoptions.md) | The options for FileSystem.copyFile() |
| [IFileSystemCreateLinkOptions](./node-core-library.ifilesystemcreatelinkoptions.md) | The options for <code>FileSystem.createSymbolicLinkJunction()</code>, <code>createSymbolicLinkFile()</code>, <code>createSymbolicLinkFolder()</code>, and <code>createHardLink()</code>. |
| [IFileSystemDeleteFileOptions](./node-core-library.ifilesystemdeletefileoptions.md) | The options for FileSystem.deleteFile() |
| [IFileSystemMoveOptions](./node-core-library.ifilesystemmoveoptions.md) | The options for FileSystem.move() |
| [IFileSystemReadFileOptions](./node-core-library.ifilesystemreadfileoptions.md) | The options for FileSystem.readFile() |
| [IFileSystemReadFolderOptions](./node-core-library.ifilesystemreadfolderoptions.md) | The options for FileSystem.readFolder() |
| [IFileSystemUpdateTimeParameters](./node-core-library.ifilesystemupdatetimeparameters.md) | The parameters for <code>updateTimes()</code>. Both times must be specified. |
| [IFileSystemWriteFileOptions](./node-core-library.ifilesystemwritefileoptions.md) | The options for FileSystem.writeFile() |
| [IFileSystemCopyFileOptions](./node-core-library.ifilesystemcopyfileoptions.md) | The options for [FileSystem.copyFile()](./node-core-library.filesystem.copyfile.md) |
| [IFileSystemCopyFilesAsyncOptions](./node-core-library.ifilesystemcopyfilesasyncoptions.md) | The options for [FileSystem.copyFilesAsync()](./node-core-library.filesystem.copyfilesasync.md) |
| [IFileSystemCopyFilesOptions](./node-core-library.ifilesystemcopyfilesoptions.md) | The options for [FileSystem.copyFiles()](./node-core-library.filesystem.copyfiles.md) |
| [IFileSystemCreateLinkOptions](./node-core-library.ifilesystemcreatelinkoptions.md) | The options for [FileSystem.createSymbolicLinkJunction()](./node-core-library.filesystem.createsymboliclinkjunction.md)<!-- -->, [FileSystem.createSymbolicLinkFile()](./node-core-library.filesystem.createsymboliclinkfile.md)<!-- -->, [FileSystem.createSymbolicLinkFolder()](./node-core-library.filesystem.createsymboliclinkfolder.md)<!-- -->, and [FileSystem.createHardLink()](./node-core-library.filesystem.createhardlink.md)<!-- -->. |
| [IFileSystemDeleteFileOptions](./node-core-library.ifilesystemdeletefileoptions.md) | The options for [FileSystem.deleteFile()](./node-core-library.filesystem.deletefile.md) |
| [IFileSystemMoveOptions](./node-core-library.ifilesystemmoveoptions.md) | The options for [FileSystem.move()](./node-core-library.filesystem.move.md) |
| [IFileSystemReadFileOptions](./node-core-library.ifilesystemreadfileoptions.md) | The options for [FileSystem.readFile()](./node-core-library.filesystem.readfile.md) |
| [IFileSystemReadFolderOptions](./node-core-library.ifilesystemreadfolderoptions.md) | The options for [FileSystem.readFolder()](./node-core-library.filesystem.readfolder.md) |
| [IFileSystemUpdateTimeParameters](./node-core-library.ifilesystemupdatetimeparameters.md) | The options for [FileSystem.updateTimes()](./node-core-library.filesystem.updatetimes.md) Both times must be specified. |
| [IFileSystemWriteFileOptions](./node-core-library.ifilesystemwritefileoptions.md) | The options for [FileSystem.writeFile()](./node-core-library.filesystem.writefile.md) |
| [IFileWriterFlags](./node-core-library.ifilewriterflags.md) | Interface which represents the flags about which mode the file should be opened in. |
| [IJsonFileSaveOptions](./node-core-library.ijsonfilesaveoptions.md) | Options for JsonFile.saveJsonFile() |
| [IJsonFileStringifyOptions](./node-core-library.ijsonfilestringifyoptions.md) | Options for JsonFile.stringify() |
@ -76,6 +80,7 @@ Core libraries that every NodeJS toolchain project should use.
| [IPackageJsonDependencyTable](./node-core-library.ipackagejsondependencytable.md) | This interface is part of the IPackageJson file format. It is used for the "dependencies", "optionalDependencies", and "devDependencies" fields. |
| [IPackageJsonLookupParameters](./node-core-library.ipackagejsonlookupparameters.md) | Constructor parameters for [PackageJsonLookup](./node-core-library.packagejsonlookup.md) |
| [IPackageJsonScriptTable](./node-core-library.ipackagejsonscripttable.md) | This interface is part of the IPackageJson file format. It is used for the "scripts" field. |
| [IPackageNameParserOptions](./node-core-library.ipackagenameparseroptions.md) | Options that configure the validation rules used by a [PackageNameParser](./node-core-library.packagenameparser.md) instance. |
| [IParsedPackageName](./node-core-library.iparsedpackagename.md) | A package name that has been separated into its scope and unscoped name. |
| [IParsedPackageNameOrError](./node-core-library.iparsedpackagenameorerror.md) | Result object returned by [PackageName.tryParse()](./node-core-library.packagename.tryparse.md) |
| [IProtectableMapParameters](./node-core-library.iprotectablemapparameters.md) | Constructor parameters for [ProtectableMap](./node-core-library.protectablemap.md) |
@ -88,6 +93,9 @@ Core libraries that every NodeJS toolchain project should use.
| --- | --- |
| [ExecutableStdioMapping](./node-core-library.executablestdiomapping.md) | Typings for IExecutableSpawnSyncOptions.stdio. |
| [ExecutableStdioStreamMapping](./node-core-library.executablestdiostreammapping.md) | Typings for one of the streams inside IExecutableSpawnSyncOptions.stdio. |
| [FileSystemCopyFilesAsyncFilter](./node-core-library.filesystemcopyfilesasyncfilter.md) | Callback function type for [IFileSystemCopyFilesAsyncOptions.filter](./node-core-library.ifilesystemcopyfilesasyncoptions.filter.md) |
| [FileSystemCopyFilesFilter](./node-core-library.filesystemcopyfilesfilter.md) | Callback function type for [IFileSystemCopyFilesOptions.filter](./node-core-library.ifilesystemcopyfilesoptions.filter.md) |
| [FileSystemStats](./node-core-library.filesystemstats.md) | An alias for the Node.js <code>fs.Stats</code> object. |
| [JsonObject](./node-core-library.jsonobject.md) | Represents a JSON-serializable object whose type has not been determined yet. |
| [LegacyCallback](./node-core-library.legacycallback.md) | Callback used by [LegacyAdapters](./node-core-library.legacyadapters.md)<!-- -->. |

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

@ -9,7 +9,7 @@ improve_this_button: false
## PackageName class
Various functions for working with package names that may include scopes.
Provides basic operations for validating and manipulating NPM package names such as `my-package` or `@scope/my-package`<!-- -->.
<b>Signature:</b>
@ -17,6 +17,10 @@ Various functions for working with package names that may include scopes.
export declare class PackageName
```
## Remarks
This is the default implementation of [PackageNameParser](./node-core-library.packagenameparser.md)<!-- -->, exposed as a convenient static class. If you need to configure the parsing rules, use `PackageNameParser` instead.
## Methods
| Method | Modifiers | Description |

25
pages/api/node-core-library.packagenameparser._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/node-core-library](./node-core-library.md) &gt; [PackageNameParser](./node-core-library.packagenameparser.md) &gt; [(constructor)](./node-core-library.packagenameparser._constructor_.md)
## PackageNameParser.(constructor)
Constructs a new instance of the `PackageNameParser` class
<b>Signature:</b>
```typescript
constructor(options?: IPackageNameParserOptions);
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| options | [IPackageNameParserOptions](./node-core-library.ipackagenameparseroptions.md) | |

32
pages/api/node-core-library.packagenameparser.combineparts.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/node-core-library](./node-core-library.md) &gt; [PackageNameParser](./node-core-library.packagenameparser.md) &gt; [combineParts](./node-core-library.packagenameparser.combineparts.md)
## PackageNameParser.combineParts() method
Combines an optional package scope with an unscoped root name.
<b>Signature:</b>
```typescript
combineParts(scope: string, unscopedName: string): string;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| scope | string | Must be either an empty string, or a scope name such as "<!-- -->@<!-- -->example" |
| unscopedName | string | Must be a nonempty package name that does not contain a scope |
<b>Returns:</b>
string
A full package name such as "<!-- -->@<!-- -->example/some-library".

33
pages/api/node-core-library.packagenameparser.getscope.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/node-core-library](./node-core-library.md) &gt; [PackageNameParser](./node-core-library.packagenameparser.md) &gt; [getScope](./node-core-library.packagenameparser.getscope.md)
## PackageNameParser.getScope() method
The parsed NPM scope, or an empty string if there was no scope. The scope value will always include the at-sign.
<b>Signature:</b>
```typescript
getScope(packageName: string): string;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| packageName | string | |
<b>Returns:</b>
string
## Remarks
For example, if the parsed input was "<!-- -->@<!-- -->scope/example", then scope would be "<!-- -->@<!-- -->scope".

33
pages/api/node-core-library.packagenameparser.getunscopedname.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/node-core-library](./node-core-library.md) &gt; [PackageNameParser](./node-core-library.packagenameparser.md) &gt; [getUnscopedName](./node-core-library.packagenameparser.getunscopedname.md)
## PackageNameParser.getUnscopedName() method
The parsed NPM package name without the scope.
<b>Signature:</b>
```typescript
getUnscopedName(packageName: string): string;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| packageName | string | |
<b>Returns:</b>
string
## Remarks
For example, if the parsed input was "<!-- -->@<!-- -->scope/example", then the name would be "example".

33
pages/api/node-core-library.packagenameparser.isvalidname.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/node-core-library](./node-core-library.md) &gt; [PackageNameParser](./node-core-library.packagenameparser.md) &gt; [isValidName](./node-core-library.packagenameparser.isvalidname.md)
## PackageNameParser.isValidName() method
Returns true if the specified package name is valid, or false otherwise.
<b>Signature:</b>
```typescript
isValidName(packageName: string): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| packageName | string | |
<b>Returns:</b>
boolean
## Remarks
This function will not throw an exception.

41
pages/api/node-core-library.packagenameparser.md Normal file
Просмотреть файл

@ -0,0 +1,41 @@
---
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/node-core-library](./node-core-library.md) &gt; [PackageNameParser](./node-core-library.packagenameparser.md)
## PackageNameParser class
A configurable parser for validating and manipulating NPM package names such as `my-package` or `@scope/my-package`<!-- -->.
<b>Signature:</b>
```typescript
export declare class PackageNameParser
```
## Remarks
If you do not need to customize the parser configuration, it is recommended to use [PackageName](./node-core-library.packagename.md) which exposes these operations as a simple static class.
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(options)](./node-core-library.packagenameparser._constructor_.md) | | Constructs a new instance of the <code>PackageNameParser</code> class |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [combineParts(scope, unscopedName)](./node-core-library.packagenameparser.combineparts.md) | | Combines an optional package scope with an unscoped root name. |
| [getScope(packageName)](./node-core-library.packagenameparser.getscope.md) | | The parsed NPM scope, or an empty string if there was no scope. The scope value will always include the at-sign. |
| [getUnscopedName(packageName)](./node-core-library.packagenameparser.getunscopedname.md) | | The parsed NPM package name without the scope. |
| [isValidName(packageName)](./node-core-library.packagenameparser.isvalidname.md) | | Returns true if the specified package name is valid, or false otherwise. |
| [parse(packageName)](./node-core-library.packagenameparser.parse.md) | | Same as [PackageName.tryParse()](./node-core-library.packagename.tryparse.md)<!-- -->, except this throws an exception if the input cannot be parsed. |
| [tryParse(packageName)](./node-core-library.packagenameparser.tryparse.md) | | This attempts to parse a package name that may include a scope component. The packageName must not be an empty string. |
| [validate(packageName)](./node-core-library.packagenameparser.validate.md) | | Throws an exception if the specified name is not a valid package name. The packageName must not be an empty string. |

33
pages/api/node-core-library.packagenameparser.parse.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/node-core-library](./node-core-library.md) &gt; [PackageNameParser](./node-core-library.packagenameparser.md) &gt; [parse](./node-core-library.packagenameparser.parse.md)
## PackageNameParser.parse() method
Same as [PackageName.tryParse()](./node-core-library.packagename.tryparse.md)<!-- -->, except this throws an exception if the input cannot be parsed.
<b>Signature:</b>
```typescript
parse(packageName: string): IParsedPackageName;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| packageName | string | |
<b>Returns:</b>
[IParsedPackageName](./node-core-library.iparsedpackagename.md)
## Remarks
The packageName must not be an empty string.

35
pages/api/node-core-library.packagenameparser.tryparse.md Normal file
Просмотреть файл

@ -0,0 +1,35 @@
---
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/node-core-library](./node-core-library.md) &gt; [PackageNameParser](./node-core-library.packagenameparser.md) &gt; [tryParse](./node-core-library.packagenameparser.tryparse.md)
## PackageNameParser.tryParse() method
This attempts to parse a package name that may include a scope component. The packageName must not be an empty string.
<b>Signature:</b>
```typescript
tryParse(packageName: string): IParsedPackageNameOrError;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| packageName | string | |
<b>Returns:</b>
[IParsedPackageNameOrError](./node-core-library.iparsedpackagenameorerror.md)
an [IParsedPackageNameOrError](./node-core-library.iparsedpackagenameorerror.md) structure whose `error` property will be nonempty if the string could not be parsed.
## Remarks
This function will not throw an exception.

29
pages/api/node-core-library.packagenameparser.validate.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/node-core-library](./node-core-library.md) &gt; [PackageNameParser](./node-core-library.packagenameparser.md) &gt; [validate](./node-core-library.packagenameparser.validate.md)
## PackageNameParser.validate() method
Throws an exception if the specified name is not a valid package name. The packageName must not be an empty string.
<b>Signature:</b>
```typescript
validate(packageName: string): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| packageName | string | |
<b>Returns:</b>
void

3
pages/api/rush-lib.environmentvariablenames.md
Просмотреть файл

@ -23,8 +23,9 @@ export declare const enum EnvironmentVariableNames
| --- | --- | --- |
| RUSH\_ABSOLUTE\_SYMLINKS | <code>&quot;RUSH_ABSOLUTE_SYMLINKS&quot;</code> | If this variable is set to "true", Rush will create symlinks with absolute paths instead of relative paths. This can be necessary when a repository is moved during a build or if parts of a repository are moved into a sandbox. |
| RUSH\_ALLOW\_UNSUPPORTED\_NODEJS | <code>&quot;RUSH_ALLOW_UNSUPPORTED_NODEJS&quot;</code> | If this variable is set to "true", Rush will not fail the build when running a version of Node that does not match the criteria specified in the "nodeSupportedVersionRange" field from rush.json. |
| RUSH\_PARALLELISM | <code>&quot;RUSH_PARALLELISM&quot;</code> | Specifies the maximum number of concurrent processes to launch during a build. For more information, see the command-line help for the <code>--parallelism</code> parameter for "rush build". |
| RUSH\_PNPM\_STORE\_PATH | <code>&quot;RUSH_PNPM_STORE_PATH&quot;</code> | When using PNPM as the package manager, this variable can be used to configure the path that PNPM will use as the store directory.<!-- -->If a relative path is used, then the store path will be resolved relative to the process's current working directory. An absolute path is recommended. |
| RUSH\_PREVIEW\_VERSION | <code>&quot;RUSH_PREVIEW_VERSION&quot;</code> | This variable overrides the version of Rush that will be installed by the version selector. The default value is determined by the "rushVersion" field from rush.json. |
| RUSH\_TEMP\_FOLDER | <code>&quot;RUSH_TEMP_FOLDER&quot;</code> | This variable overrides the temporary folder used by Rush. The default value is "common/temp" under the repository root. |
| RUSH\_VARIANT | <code>&quot;RUSH_VARIANT&quot;</code> | This variable selects a specific installation variant for Rush to use when installing and linking package dependencies. For more information, see this article: https://rushjs.io/pages/advanced/installation\_variants/ |
| RUSH\_VARIANT | <code>&quot;RUSH_VARIANT&quot;</code> | This variable selects a specific installation variant for Rush to use when installing and linking package dependencies. For more information, see the command-line help for the <code>--variant</code> parameter and this article: https://rushjs.io/pages/advanced/installation\_variants/ |

1
pages/api/rush-lib.iexperimentsjson.md
Просмотреть файл

@ -26,4 +26,5 @@ export interface IExperimentsJson
| --- | --- | --- |
| [legacyIncrementalBuildDependencyDetection](./rush-lib.iexperimentsjson.legacyincrementalbuilddependencydetection.md) | boolean | <b><i>(BETA)</i></b> If this setting is enabled, incremental builds should use repo-wide dependency tracking instead of project-specific tracking. |
| [noChmodFieldInTarHeaderNormalization](./rush-lib.iexperimentsjson.nochmodfieldintarheadernormalization.md) | boolean | <b><i>(BETA)</i></b> If true, the chmod field in temporary project tar headers will not be normalized. This normalization can help ensure consistent tarball integrity across platforms. |
| [usePnpmFrozenLockfileForRushInstall](./rush-lib.iexperimentsjson.usepnpmfrozenlockfileforrushinstall.md) | boolean | <b><i>(BETA)</i></b> By default, rush passes --no-prefer-frozen-lockfile to 'pnpm install'. Set this option to true to pass '--frozen-lockfile' instead. |

21
pages/api/rush-lib.iexperimentsjson.usepnpmfrozenlockfileforrushinstall.md Normal file
Просмотреть файл

@ -0,0 +1,21 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@microsoft/rush-lib](./rush-lib.md) &gt; [IExperimentsJson](./rush-lib.iexperimentsjson.md) &gt; [usePnpmFrozenLockfileForRushInstall](./rush-lib.iexperimentsjson.usepnpmfrozenlockfileforrushinstall.md)
## IExperimentsJson.usePnpmFrozenLockfileForRushInstall property
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
>
By default, rush passes --no-prefer-frozen-lockfile to 'pnpm install'. Set this option to true to pass '--frozen-lockfile' instead.
<b>Signature:</b>
```typescript
usePnpmFrozenLockfileForRushInstall?: boolean;
```

20
pages/api/rush-lib.rushconfiguration.allowmostlystandardpackagenames.md Normal file
Просмотреть файл

@ -0,0 +1,20 @@
---
layout: page
navigation_source: api_nav
improve_this_button: false
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@microsoft/rush-lib](./rush-lib.md) &gt; [RushConfiguration](./rush-lib.rushconfiguration.md) &gt; [allowMostlyStandardPackageNames](./rush-lib.rushconfiguration.allowmostlystandardpackagenames.md)
## RushConfiguration.allowMostlyStandardPackageNames property
Today the npmjs.com registry enforces fairly strict naming rules for packages, but in the early days there was no standard and hardly any enforcement. A few large legacy projects are still using nonstandard package names, and private registries sometimes allow it. Set "allowMostlyStandardPackageNames" to true to relax Rush's enforcement of package names. This allows upper case letters and in the future may relax other rules, however we want to minimize these exceptions. Many popular tools use certain punctuation characters as delimiters, based on the assumption that they will never appear in a package name; thus if we relax the rules too much it is likely to cause very confusing malfunctions.
The default value is false.
<b>Signature:</b>
```typescript
readonly allowMostlyStandardPackageNames: boolean;
```

2
pages/api/rush-lib.rushconfiguration.md
Просмотреть файл

@ -21,6 +21,7 @@ export declare class RushConfiguration
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [allowMostlyStandardPackageNames](./rush-lib.rushconfiguration.allowmostlystandardpackagenames.md) | | boolean | Today the npmjs.com registry enforces fairly strict naming rules for packages, but in the early days there was no standard and hardly any enforcement. A few large legacy projects are still using nonstandard package names, and private registries sometimes allow it. Set "allowMostlyStandardPackageNames" to true to relax Rush's enforcement of package names. This allows upper case letters and in the future may relax other rules, however we want to minimize these exceptions. Many popular tools use certain punctuation characters as delimiters, based on the assumption that they will never appear in a package name; thus if we relax the rules too much it is likely to cause very confusing malfunctions.<!-- -->The default value is false. |
| [approvedPackagesPolicy](./rush-lib.rushconfiguration.approvedpackagespolicy.md) | | [ApprovedPackagesPolicy](./rush-lib.approvedpackagespolicy.md) | The "approvedPackagesPolicy" settings. |
| [changesFolder](./rush-lib.rushconfiguration.changesfolder.md) | | string | The folder that contains all change files. |
| [committedShrinkwrapFilename](./rush-lib.rushconfiguration.committedshrinkwrapfilename.md) | | string | The full path of the shrinkwrap file that is tracked by Git. (The "rush install" command uses a temporary copy, whose path is tempShrinkwrapFilename.) |
@ -46,6 +47,7 @@ export declare class RushConfiguration
| [packageManagerToolFilename](./rush-lib.rushconfiguration.packagemanagertoolfilename.md) | | string | The absolute path to the locally installed NPM tool. If "rush install" has not been run, then this file may not exist yet. Example: <code>C:\MyRepo\common\temp\npm-local\node_modules\.bin\npm</code> |
| [packageManagerToolVersion](./rush-lib.rushconfiguration.packagemanagertoolversion.md) | | string | The version of the locally installed NPM tool. (Example: "1.2.3") |
| [packageManagerWrapper](./rush-lib.rushconfiguration.packagemanagerwrapper.md) | | [PackageManager](./rush-lib.packagemanager.md) | <b><i>(BETA)</i></b> An abstraction for controlling the supported package managers: PNPM, NPM, and Yarn. |
| [packageNameParser](./rush-lib.rushconfiguration.packagenameparser.md) | | [PackageNameParser](./node-core-library.packagenameparser.md) | The rush hooks. It allows customized scripts to run at the specified point. |
| [pnpmOptions](./rush-lib.rushconfiguration.pnpmoptions.md) | | [PnpmOptionsConfiguration](./rush-lib.pnpmoptionsconfiguration.md) | Options that are only used when the PNPM package manager is selected. |
| [projectFolderMaxDepth](./rush-lib.rushconfiguration.projectfoldermaxdepth.md) | | number | The maximum allowable folder depth for the projectFolder field in the rush.json file. This setting provides a way for repository maintainers to discourage nesting of project folders that makes the directory tree more difficult to navigate. The default value is 2, which implements on a standard convention of <categoryFolder>/<projectFolder>/package.json. |
| [projectFolderMinDepth](./rush-lib.rushconfiguration.projectfoldermindepth.md) | | number | The minimum allowable folder depth for the projectFolder field in the rush.json file. This setting provides a way for repository maintainers to discourage nesting of project folders that makes the directory tree more difficult to navigate. The default value is 2, which implements a standard 2-level hierarchy of <categoryFolder>/<projectFolder>/package.json. |

18
pages/api/rush-lib.rushconfiguration.packagenameparser.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/rush-lib](./rush-lib.md) &gt; [RushConfiguration](./rush-lib.rushconfiguration.md) &gt; [packageNameParser](./rush-lib.rushconfiguration.packagenameparser.md)
## RushConfiguration.packageNameParser property
The rush hooks. It allows customized scripts to run at the specified point.
<b>Signature:</b>
```typescript
readonly packageNameParser: PackageNameParser;
```

2
pages/api/ts-command-line.commandlineparameter.description.md
Просмотреть файл

@ -9,7 +9,7 @@ improve_this_button: false
## CommandLineParameter.description property
Documentation for the flag, that will be shown when invoking the tool with "--help"
Documentation for the parameter that will be shown when invoking the tool with "--help"
<b>Signature:</b>

12
pages/api/ts-command-line.commandlineparameter.environmentvariable.md
Просмотреть файл

@ -23,3 +23,15 @@ The environment variable name must consist only of upper-case letters, numbers,
This feature cannot be used when [IBaseCommandLineDefinition.required](./ts-command-line.ibasecommandlinedefinition.required.md) is true, because in that case the environmentVariable would never be used.
Syntax notes for environment variable values:
- Choice Parameter: The value must match one of the defined choices, otherwise a validation error is reported. An empty string causes the environment variable to be ignored.
- Flag Parameter: The value must be `1` for true, or `0` for false, otherwise a validation error is reported. An empty string causes the environment variable to be ignored.
- Integer Parameter: The value must be an integer number, otherwise a validation error is reported. An empty string causes the environment variable to be ignored.
- String Parameter: Any value is accepted, including an empty string.
- String List Parameter: If the string starts with `[` (ignoring whitespace) then it will be parsed as a JSON array, whose elements must be strings, numbers, or boolean values. If the string does not start with `[`<!-- -->, then it behaves like an ordinary String Parameter: Any value is accepted, including an empty string.

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