diff --git a/websites/api.rushstack.io/data/api_nav.json b/websites/api.rushstack.io/data/api_nav.json index d74280396..5453c9c12 100644 --- a/websites/api.rushstack.io/data/api_nav.json +++ b/websites/api.rushstack.io/data/api_nav.json @@ -10278,6 +10278,32 @@ } ] }, + { + "type": "category", + "label": "ILookupByPathJson", + "items": [ + { + "type": "doc", + "label": "(members)", + "id": "pages/lookup-by-path.ilookupbypathjson" + }, + { + "type": "doc", + "label": "delimiter", + "id": "pages/lookup-by-path.ilookupbypathjson.delimiter" + }, + { + "type": "doc", + "label": "tree", + "id": "pages/lookup-by-path.ilookupbypathjson.tree" + }, + { + "type": "doc", + "label": "values", + "id": "pages/lookup-by-path.ilookupbypathjson.values" + } + ] + }, { "type": "category", "label": "IPrefixMatch", @@ -10357,6 +10383,11 @@ "type": "doc", "label": "has", "id": "pages/lookup-by-path.ireadonlylookupbypath.has" + }, + { + "type": "doc", + "label": "toJson", + "id": "pages/lookup-by-path.ireadonlylookupbypath.tojson" } ] }, @@ -10381,6 +10412,27 @@ } ] }, + { + "type": "category", + "label": "ISerializedPathTrieNode", + "items": [ + { + "type": "doc", + "label": "(members)", + "id": "pages/lookup-by-path.iserializedpathtrienode" + }, + { + "type": "doc", + "label": "children", + "id": "pages/lookup-by-path.iserializedpathtrienode.children" + }, + { + "type": "doc", + "label": "valueIndex", + "id": "pages/lookup-by-path.iserializedpathtrienode.valueindex" + } + ] + }, { "type": "category", "label": "LookupByPath", @@ -10440,6 +10492,11 @@ "label": "findLongestPrefixMatch", "id": "pages/lookup-by-path.lookupbypath.findlongestprefixmatch" }, + { + "type": "doc", + "label": "fromJson", + "id": "pages/lookup-by-path.lookupbypath.fromjson" + }, { "type": "doc", "label": "get", @@ -10480,6 +10537,11 @@ "label": "size", "id": "pages/lookup-by-path.lookupbypath.size" }, + { + "type": "doc", + "label": "toJson", + "id": "pages/lookup-by-path.lookupbypath.tojson" + }, { "type": "doc", "label": "tree", @@ -11377,6 +11439,11 @@ "label": "createHardLinkAsync", "id": "pages/node-core-library.filesystem.createhardlinkasync" }, + { + "type": "doc", + "label": "createReadStream", + "id": "pages/node-core-library.filesystem.createreadstream" + }, { "type": "doc", "label": "createSymbolicLinkFile", @@ -11407,6 +11474,16 @@ "label": "createSymbolicLinkJunctionAsync", "id": "pages/node-core-library.filesystem.createsymboliclinkjunctionasync" }, + { + "type": "doc", + "label": "createWriteStream", + "id": "pages/node-core-library.filesystem.createwritestream" + }, + { + "type": "doc", + "label": "createWriteStreamAsync", + "id": "pages/node-core-library.filesystem.createwritestreamasync" + }, { "type": "doc", "label": "deleteFile", @@ -11644,11 +11721,21 @@ "label": "FileSystemCopyFilesFilter", "id": "pages/node-core-library.filesystemcopyfilesfilter" }, + { + "type": "doc", + "label": "FileSystemReadStream", + "id": "pages/node-core-library.filesystemreadstream" + }, { "type": "doc", "label": "FileSystemStats", "id": "pages/node-core-library.filesystemstats" }, + { + "type": "doc", + "label": "FileSystemWriteStream", + "id": "pages/node-core-library.filesystemwritestream" + }, { "type": "category", "label": "FileWriter", @@ -11987,6 +12074,11 @@ } ] }, + { + "type": "doc", + "label": "IFileSystemCreateWriteStreamOptions", + "id": "pages/node-core-library.ifilesystemcreatewritestreamoptions" + }, { "type": "category", "label": "IFileSystemDeleteFileOptions", @@ -12017,11 +12109,6 @@ "label": "destinationPath", "id": "pages/node-core-library.ifilesystemmoveoptions.destinationpath" }, - { - "type": "doc", - "label": "ensureFolderExists", - "id": "pages/node-core-library.ifilesystemmoveoptions.ensurefolderexists" - }, { "type": "doc", "label": "overwrite", @@ -12093,20 +12180,9 @@ ] }, { - "type": "category", + "type": "doc", "label": "IFileSystemWriteBinaryFileOptions", - "items": [ - { - "type": "doc", - "label": "(members)", - "id": "pages/node-core-library.ifilesystemwritebinaryfileoptions" - }, - { - "type": "doc", - "label": "ensureFolderExists", - "id": "pages/node-core-library.ifilesystemwritebinaryfileoptions.ensurefolderexists" - } - ] + "id": "pages/node-core-library.ifilesystemwritebinaryfileoptions" }, { "type": "category", @@ -12129,6 +12205,22 @@ } ] }, + { + "type": "category", + "label": "IFileSystemWriteFileOptionsBase", + "items": [ + { + "type": "doc", + "label": "(members)", + "id": "pages/node-core-library.ifilesystemwritefileoptionsbase" + }, + { + "type": "doc", + "label": "ensureFolderExists", + "id": "pages/node-core-library.ifilesystemwritefileoptionsbase.ensurefolderexists" + } + ] + }, { "type": "category", "label": "IFileWriterFlags", diff --git a/websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.includeforgottenexports.md b/websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.includeforgottenexports.md index c475e4941..e1ebec53c 100644 --- a/websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.includeforgottenexports.md +++ b/websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.includeforgottenexports.md @@ -18,6 +18,10 @@ Whether "forgotten exports" should be included in the API report file. includeForgottenExports?: boolean; ``` +## Default Value + +`false` + ## Remarks Forgotten exports are declarations flagged with `ae-forgotten-export` warnings. See https://api-extractor.com/pages/messages/ae-forgotten-export/ to learn more. diff --git a/websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.reportfilename.md b/websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.reportfilename.md index fe42fa241..202e55bf1 100644 --- a/websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.reportfilename.md +++ b/websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.reportfilename.md @@ -18,6 +18,10 @@ The base filename for the API report files, to be combined with [IConfigApiRepor reportFileName?: string; ``` +## Default Value + +`` + ## Remarks The `reportFileName` should not include any path separators such as `\` or `/`<>. The `reportFileName` should not include a file extension, since API Extractor will automatically append an appropriate file extension such as `.api.md`<>. If the [IConfigApiReport.reportVariants](./api-extractor.iconfigapireport.reportvariants.md) setting is used, then the file extension includes the variant name, for example `my-report.public.api.md` or `my-report.beta.api.md`<>. The `complete` variant always uses the simple extension `my-report.api.md`<>. diff --git a/websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.reportvariants.md b/websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.reportvariants.md index ae27405d1..da2cd42e8 100644 --- a/websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.reportvariants.md +++ b/websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.reportvariants.md @@ -18,6 +18,10 @@ The set of report variants to generate. reportVariants?: ApiReportVariant[]; ``` +## Default Value + +`[ "complete" ]` + ## Remarks To support different approval requirements for different API levels, multiple "variants" of the API report can be generated. The `reportVariants` setting specifies a list of variants to be generated. If omitted, by default only the `complete` variant will be generated, which includes all `@internal`<>, `@alpha`<>, `@beta`<>, and `@public` items. Other possible variants are `alpha` (`@alpha` + `@beta` + `@public`<>), `beta` (`@beta` + `@public`<>), and `public` (`@public only`<>). diff --git a/websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.tagstoreport.md b/websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.tagstoreport.md index a02790c84..e759d48b1 100644 --- a/websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.tagstoreport.md +++ b/websites/api.rushstack.io/docs/pages/api-extractor.iconfigapireport.tagstoreport.md @@ -18,6 +18,10 @@ Specifies a list of [TSDoc](https://tsdoc.org/) tags that should be reported in tagsToReport?: Readonly>; ``` +## Default Value + +`@sealed`<>, `@virtual`<>, `@override`<>, `@eventProperty`<>, and `@deprecated` + ## Remarks Tag names must begin with `@`<>. diff --git a/websites/api.rushstack.io/docs/pages/api-extractor.iconfigdocmodel.includeforgottenexports.md b/websites/api.rushstack.io/docs/pages/api-extractor.iconfigdocmodel.includeforgottenexports.md index b51074946..00ba07a6a 100644 --- a/websites/api.rushstack.io/docs/pages/api-extractor.iconfigdocmodel.includeforgottenexports.md +++ b/websites/api.rushstack.io/docs/pages/api-extractor.iconfigdocmodel.includeforgottenexports.md @@ -18,6 +18,10 @@ Whether "forgotten exports" should be included in the doc model file. includeForgottenExports?: boolean; ``` +## Default Value + +`false` + ## Remarks Forgotten exports are declarations flagged with `ae-forgotten-export` warnings. See https://api-extractor.com/pages/messages/ae-forgotten-export/ to learn more. diff --git a/websites/api.rushstack.io/docs/pages/api-extractor.iconfigdocmodel.releasetagstotrim.md b/websites/api.rushstack.io/docs/pages/api-extractor.iconfigdocmodel.releasetagstotrim.md index 0e3621c1c..35512cc8b 100644 --- a/websites/api.rushstack.io/docs/pages/api-extractor.iconfigdocmodel.releasetagstotrim.md +++ b/websites/api.rushstack.io/docs/pages/api-extractor.iconfigdocmodel.releasetagstotrim.md @@ -17,3 +17,8 @@ Specifies a list of release tags that will be trimmed from the doc model. ```typescript releaseTagsToTrim?: ReleaseTagForTrim[]; ``` + +## Default Value + +`["@internal"]` + diff --git a/websites/api.rushstack.io/docs/pages/api-extractor.iconfigfile.enummemberorder.md b/websites/api.rushstack.io/docs/pages/api-extractor.iconfigfile.enummemberorder.md index ec5d2aa61..bfdfcb215 100644 --- a/websites/api.rushstack.io/docs/pages/api-extractor.iconfigfile.enummemberorder.md +++ b/websites/api.rushstack.io/docs/pages/api-extractor.iconfigfile.enummemberorder.md @@ -18,6 +18,10 @@ Specifies how API Extractor sorts members of an enum when generating the .api.js enumMemberOrder?: EnumMemberOrder; ``` +## Default Value + +`by-name` + ## Remarks By default, the output files will be sorted alphabetically, which is "by-name". To keep the ordering in the source code, specify "preserve". diff --git a/websites/api.rushstack.io/docs/pages/heft.igloboptions.absolute.md b/websites/api.rushstack.io/docs/pages/heft.igloboptions.absolute.md index aa7394a24..a9bc40715 100644 --- a/websites/api.rushstack.io/docs/pages/heft.igloboptions.absolute.md +++ b/websites/api.rushstack.io/docs/pages/heft.igloboptions.absolute.md @@ -17,3 +17,8 @@ Whether or not the returned file paths should be absolute. ```typescript absolute?: boolean; ``` + +## Default Value + +false + diff --git a/websites/api.rushstack.io/docs/pages/heft.igloboptions.dot.md b/websites/api.rushstack.io/docs/pages/heft.igloboptions.dot.md index 5d2e68d47..7ddbff2de 100644 --- a/websites/api.rushstack.io/docs/pages/heft.igloboptions.dot.md +++ b/websites/api.rushstack.io/docs/pages/heft.igloboptions.dot.md @@ -17,3 +17,8 @@ Whether or not to include dot files when globbing. ```typescript dot?: boolean; ``` + +## Default Value + +false + diff --git a/websites/api.rushstack.io/docs/pages/lookup-by-path.igetfirstdifferenceincommonnodesoptions.delimiter.md b/websites/api.rushstack.io/docs/pages/lookup-by-path.igetfirstdifferenceincommonnodesoptions.delimiter.md index 276a9420e..c790e0a58 100644 --- a/websites/api.rushstack.io/docs/pages/lookup-by-path.igetfirstdifferenceincommonnodesoptions.delimiter.md +++ b/websites/api.rushstack.io/docs/pages/lookup-by-path.igetfirstdifferenceincommonnodesoptions.delimiter.md @@ -20,3 +20,8 @@ The delimiter used to join path segments. ```typescript delimiter?: string; ``` + +## Default Value + +'/' + diff --git a/websites/api.rushstack.io/docs/pages/lookup-by-path.igetfirstdifferenceincommonnodesoptions.prefix.md b/websites/api.rushstack.io/docs/pages/lookup-by-path.igetfirstdifferenceincommonnodesoptions.prefix.md index 50d9bbb8e..4844145f7 100644 --- a/websites/api.rushstack.io/docs/pages/lookup-by-path.igetfirstdifferenceincommonnodesoptions.prefix.md +++ b/websites/api.rushstack.io/docs/pages/lookup-by-path.igetfirstdifferenceincommonnodesoptions.prefix.md @@ -20,3 +20,8 @@ The path prefix to the current node. ```typescript prefix?: string; ``` + +## Default Value + +'' + diff --git a/websites/api.rushstack.io/docs/pages/lookup-by-path.ilookupbypathjson.delimiter.md b/websites/api.rushstack.io/docs/pages/lookup-by-path.ilookupbypathjson.delimiter.md new file mode 100644 index 000000000..1d598ce78 --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/lookup-by-path.ilookupbypathjson.delimiter.md @@ -0,0 +1,22 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/lookup-by-path](./lookup-by-path.md) > [ILookupByPathJson](./lookup-by-path.ilookupbypathjson.md) > [delimiter](./lookup-by-path.ilookupbypathjson.delimiter.md) + +## ILookupByPathJson.delimiter property + +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> + +The path delimiter used by the serialized trie. + +**Signature:** + +```typescript +delimiter: string; +``` diff --git a/websites/api.rushstack.io/docs/pages/lookup-by-path.ilookupbypathjson.md b/websites/api.rushstack.io/docs/pages/lookup-by-path.ilookupbypathjson.md new file mode 100644 index 000000000..a57108f49 --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/lookup-by-path.ilookupbypathjson.md @@ -0,0 +1,109 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/lookup-by-path](./lookup-by-path.md) > [ILookupByPathJson](./lookup-by-path.ilookupbypathjson.md) + +## ILookupByPathJson interface + +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> + +JSON-serializable representation of a [LookupByPath](./lookup-by-path.lookupbypath.md) instance. + +**Signature:** + +```typescript +export interface ILookupByPathJson +``` + +## Remarks + +The `values` array stores each unique value exactly once (by reference identity). Nodes in the tree reference values by their index in this array, which ensures that reference equality is preserved across serialization and deserialization. + +## Properties + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[delimiter](./lookup-by-path.ilookupbypathjson.delimiter.md) + + + + + + + +string + + + + +**_(BETA)_** The path delimiter used by the serialized trie. + + +
+ +[tree](./lookup-by-path.ilookupbypathjson.tree.md) + + + + + + + +[ISerializedPathTrieNode](./lookup-by-path.iserializedpathtrienode.md) + + + + +**_(BETA)_** The serialized tree structure. + + +
+ +[values](./lookup-by-path.ilookupbypathjson.values.md) + + + + + + + +TSerialized\[\] + + + + +**_(BETA)_** Array of serialized values. Nodes in the tree reference values by their index in this array. Using an array with index-based references preserves reference equality: if multiple nodes share the same value (by reference), they will reference the same index. + + +
+ diff --git a/websites/api.rushstack.io/docs/pages/lookup-by-path.ilookupbypathjson.tree.md b/websites/api.rushstack.io/docs/pages/lookup-by-path.ilookupbypathjson.tree.md new file mode 100644 index 000000000..176f47b3a --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/lookup-by-path.ilookupbypathjson.tree.md @@ -0,0 +1,22 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/lookup-by-path](./lookup-by-path.md) > [ILookupByPathJson](./lookup-by-path.ilookupbypathjson.md) > [tree](./lookup-by-path.ilookupbypathjson.tree.md) + +## ILookupByPathJson.tree property + +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> + +The serialized tree structure. + +**Signature:** + +```typescript +tree: ISerializedPathTrieNode; +``` diff --git a/websites/api.rushstack.io/docs/pages/lookup-by-path.ilookupbypathjson.values.md b/websites/api.rushstack.io/docs/pages/lookup-by-path.ilookupbypathjson.values.md new file mode 100644 index 000000000..2aa4b3e53 --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/lookup-by-path.ilookupbypathjson.values.md @@ -0,0 +1,22 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/lookup-by-path](./lookup-by-path.md) > [ILookupByPathJson](./lookup-by-path.ilookupbypathjson.md) > [values](./lookup-by-path.ilookupbypathjson.values.md) + +## ILookupByPathJson.values property + +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> + +Array of serialized values. Nodes in the tree reference values by their index in this array. Using an array with index-based references preserves reference equality: if multiple nodes share the same value (by reference), they will reference the same index. + +**Signature:** + +```typescript +values: TSerialized[]; +``` diff --git a/websites/api.rushstack.io/docs/pages/lookup-by-path.ireadonlylookupbypath.md b/websites/api.rushstack.io/docs/pages/lookup-by-path.ireadonlylookupbypath.md index 3ee147638..81932dbca 100644 --- a/websites/api.rushstack.io/docs/pages/lookup-by-path.ireadonlylookupbypath.md +++ b/websites/api.rushstack.io/docs/pages/lookup-by-path.ireadonlylookupbypath.md @@ -133,6 +133,17 @@ Description **_(BETA)_** Determines if an entry exists exactly at the specified path. + + + +[toJson(serializeValue)](./lookup-by-path.ireadonlylookupbypath.tojson.md) + + + + +**_(BETA)_** Serializes this `LookupByPath` instance to a JSON-compatible representation. + + diff --git a/websites/api.rushstack.io/docs/pages/lookup-by-path.ireadonlylookupbypath.tojson.md b/websites/api.rushstack.io/docs/pages/lookup-by-path.ireadonlylookupbypath.tojson.md new file mode 100644 index 000000000..86e31855b --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/lookup-by-path.ireadonlylookupbypath.tojson.md @@ -0,0 +1,69 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/lookup-by-path](./lookup-by-path.md) > [IReadonlyLookupByPath](./lookup-by-path.ireadonlylookupbypath.md) > [toJson](./lookup-by-path.ireadonlylookupbypath.tojson.md) + +## IReadonlyLookupByPath.toJson() method + +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> + +Serializes this `LookupByPath` instance to a JSON-compatible representation. + +**Signature:** + +```typescript +toJson(serializeValue: (value: TItem) => TSerialized): ILookupByPathJson; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +serializeValue + + + + +(value: TItem) => TSerialized + + + + +A function that converts a value of type `TItem` to a JSON-serializable form. + + +
+ +**Returns:** + +[ILookupByPathJson](./lookup-by-path.ilookupbypathjson.md)<><TSerialized> + +A JSON-serializable representation of this trie. + +## Remarks + +Values that are reference-equal will be serialized once and referenced by index, ensuring that reference equality is preserved when deserialized via [LookupByPath.fromJson()](./lookup-by-path.lookupbypath.fromjson.md)<>. + diff --git a/websites/api.rushstack.io/docs/pages/lookup-by-path.iserializedpathtrienode.children.md b/websites/api.rushstack.io/docs/pages/lookup-by-path.iserializedpathtrienode.children.md new file mode 100644 index 000000000..2019312ab --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/lookup-by-path.iserializedpathtrienode.children.md @@ -0,0 +1,22 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/lookup-by-path](./lookup-by-path.md) > [ISerializedPathTrieNode](./lookup-by-path.iserializedpathtrienode.md) > [children](./lookup-by-path.iserializedpathtrienode.children.md) + +## ISerializedPathTrieNode.children property + +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> + +Child nodes keyed by path segment. + +**Signature:** + +```typescript +children?: Record; +``` diff --git a/websites/api.rushstack.io/docs/pages/lookup-by-path.iserializedpathtrienode.md b/websites/api.rushstack.io/docs/pages/lookup-by-path.iserializedpathtrienode.md new file mode 100644 index 000000000..2474b50a5 --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/lookup-by-path.iserializedpathtrienode.md @@ -0,0 +1,86 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/lookup-by-path](./lookup-by-path.md) > [ISerializedPathTrieNode](./lookup-by-path.iserializedpathtrienode.md) + +## ISerializedPathTrieNode interface + +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> + +JSON-serializable representation of a node in a [LookupByPath](./lookup-by-path.lookupbypath.md) trie. + +**Signature:** + +```typescript +export interface ISerializedPathTrieNode +``` + +## Properties + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[children?](./lookup-by-path.iserializedpathtrienode.children.md) + + + + + + + +Record<string, [ISerializedPathTrieNode](./lookup-by-path.iserializedpathtrienode.md)<>> + + + + +**_(BETA)_** _(Optional)_ Child nodes keyed by path segment. + + +
+ +[valueIndex?](./lookup-by-path.iserializedpathtrienode.valueindex.md) + + + + + + + +number + + + + +**_(BETA)_** _(Optional)_ Index into the `values` array of the containing [ILookupByPathJson](./lookup-by-path.ilookupbypathjson.md)<>. If `undefined`<>, this node has no associated value. + + +
+ diff --git a/websites/api.rushstack.io/docs/pages/lookup-by-path.iserializedpathtrienode.valueindex.md b/websites/api.rushstack.io/docs/pages/lookup-by-path.iserializedpathtrienode.valueindex.md new file mode 100644 index 000000000..a8e157786 --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/lookup-by-path.iserializedpathtrienode.valueindex.md @@ -0,0 +1,22 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/lookup-by-path](./lookup-by-path.md) > [ISerializedPathTrieNode](./lookup-by-path.iserializedpathtrienode.md) > [valueIndex](./lookup-by-path.iserializedpathtrienode.valueindex.md) + +## ISerializedPathTrieNode.valueIndex property + +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> + +Index into the `values` array of the containing [ILookupByPathJson](./lookup-by-path.ilookupbypathjson.md)<>. If `undefined`<>, this node has no associated value. + +**Signature:** + +```typescript +valueIndex?: number; +``` diff --git a/websites/api.rushstack.io/docs/pages/lookup-by-path.lookupbypath.fromjson.md b/websites/api.rushstack.io/docs/pages/lookup-by-path.lookupbypath.fromjson.md new file mode 100644 index 000000000..cc52f1af6 --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/lookup-by-path.lookupbypath.fromjson.md @@ -0,0 +1,85 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/lookup-by-path](./lookup-by-path.md) > [LookupByPath](./lookup-by-path.lookupbypath.md) > [fromJson](./lookup-by-path.lookupbypath.fromjson.md) + +## LookupByPath.fromJson() method + +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> + +Deserializes a `LookupByPath` instance from a JSON representation previously created by [LookupByPath.toJson()](./lookup-by-path.lookupbypath.tojson.md)<>. + +**Signature:** + +```typescript +static fromJson(json: ILookupByPathJson, deserializeValue: (serialized: TSerialized) => TItem): LookupByPath; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +json + + + + +[ILookupByPathJson](./lookup-by-path.ilookupbypathjson.md)<><TSerialized> + + + + +The JSON representation to deserialize. + + +
+ +deserializeValue + + + + +(serialized: TSerialized) => TItem + + + + +A function that converts a serialized value back to its original type. + + +
+ +**Returns:** + +[LookupByPath](./lookup-by-path.lookupbypath.md)<><TItem> + +A new `LookupByPath` instance. + +## Remarks + +Reference equality is preserved: if multiple nodes in the serialized trie pointed at the same value (i.e., the same index in the `values` array), the deserialized nodes will share the same object reference. + diff --git a/websites/api.rushstack.io/docs/pages/lookup-by-path.lookupbypath.md b/websites/api.rushstack.io/docs/pages/lookup-by-path.lookupbypath.md index 4c04d69e4..8ed6fb06f 100644 --- a/websites/api.rushstack.io/docs/pages/lookup-by-path.lookupbypath.md +++ b/websites/api.rushstack.io/docs/pages/lookup-by-path.lookupbypath.md @@ -289,6 +289,22 @@ Description **_(BETA)_** The readonly component of `LookupByPath`<>, to simplify unit testing. + + + +[fromJson(json, deserializeValue)](./lookup-by-path.lookupbypath.fromjson.md) + + + + +`static` + + + + +**_(BETA)_** Deserializes a `LookupByPath` instance from a JSON representation previously created by [LookupByPath.toJson()](./lookup-by-path.lookupbypath.tojson.md)<>. + + @@ -389,6 +405,20 @@ Description **_(BETA)_** Associates the value with the specified path. If a value is already associated, will overwrite. + + + +[toJson(serializeValue)](./lookup-by-path.lookupbypath.tojson.md) + + + + + + + +**_(BETA)_** Serializes this `LookupByPath` instance to a JSON-compatible representation. + + diff --git a/websites/api.rushstack.io/docs/pages/lookup-by-path.lookupbypath.tojson.md b/websites/api.rushstack.io/docs/pages/lookup-by-path.lookupbypath.tojson.md new file mode 100644 index 000000000..38199e6cc --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/lookup-by-path.lookupbypath.tojson.md @@ -0,0 +1,69 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/lookup-by-path](./lookup-by-path.md) > [LookupByPath](./lookup-by-path.lookupbypath.md) > [toJson](./lookup-by-path.lookupbypath.tojson.md) + +## LookupByPath.toJson() method + +> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. +> + +Serializes this `LookupByPath` instance to a JSON-compatible representation. + +**Signature:** + +```typescript +toJson(serializeValue: (value: TItem) => TSerialized): ILookupByPathJson; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +serializeValue + + + + +(value: TItem) => TSerialized + + + + +A function that converts a value of type `TItem` to a JSON-serializable form. + + +
+ +**Returns:** + +[ILookupByPathJson](./lookup-by-path.ilookupbypathjson.md)<><TSerialized> + +A JSON-serializable representation of this trie. + +## Remarks + +Values that are reference-equal will be serialized once and referenced by index, ensuring that reference equality is preserved when deserialized via [LookupByPath.fromJson()](./lookup-by-path.lookupbypath.fromjson.md)<>. + diff --git a/websites/api.rushstack.io/docs/pages/lookup-by-path.md b/websites/api.rushstack.io/docs/pages/lookup-by-path.md index 405eb1d66..627eb1d15 100644 --- a/websites/api.rushstack.io/docs/pages/lookup-by-path.md +++ b/websites/api.rushstack.io/docs/pages/lookup-by-path.md @@ -91,6 +91,17 @@ Description **_(BETA)_** Options for the getFirstDifferenceInCommonNodes function. + + + +[ILookupByPathJson](./lookup-by-path.ilookupbypathjson.md) + + + + +**_(BETA)_** JSON-serializable representation of a [LookupByPath](./lookup-by-path.lookupbypath.md) instance. + + @@ -124,6 +135,17 @@ Description **_(BETA)_** Readonly view of a node in the path trie used in LookupByPath + + + +[ISerializedPathTrieNode](./lookup-by-path.iserializedpathtrienode.md) + + + + +**_(BETA)_** JSON-serializable representation of a node in a [LookupByPath](./lookup-by-path.lookupbypath.md) trie. + + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.appendtofile.md b/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.appendtofile.md index 52584ff35..6d2376ca4 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.appendtofile.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.appendtofile.md @@ -80,7 +80,7 @@ options -_(Optional)_ Optional settings that can change the behavior. Type: `IWriteFileOptions` +_(Optional)_ Optional settings that can change the behavior. @@ -92,5 +92,5 @@ void ## Remarks -Throws an error if the folder doesn't exist, unless ensureFolder=true. +Throws an error if the folder doesn't exist, unless [IFileSystemWriteFileOptionsBase.ensureFolderExists](./node-core-library.ifilesystemwritefileoptionsbase.ensurefolderexists.md) is set to `true`<>. diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.createreadstream.md b/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.createreadstream.md new file mode 100644 index 000000000..c11366dbb --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.createreadstream.md @@ -0,0 +1,62 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [createReadStream](./node-core-library.filesystem.createreadstream.md) + +## FileSystem.createReadStream() method + +Creates a readable stream for an existing file. Behind the scenes it uses `fs.createReadStream()`<>. + +**Signature:** + +```typescript +static createReadStream(filePath: string): FileSystemReadStream; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +filePath + + + + +string + + + + +The path to the file. The path may be absolute or relative. + + +
+ +**Returns:** + +[FileSystemReadStream](./node-core-library.filesystemreadstream.md) + +A new readable stream for the file. + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.createwritestream.md b/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.createwritestream.md new file mode 100644 index 000000000..3e86114a2 --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.createwritestream.md @@ -0,0 +1,82 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [createWriteStream](./node-core-library.filesystem.createwritestream.md) + +## FileSystem.createWriteStream() method + +Creates a writable stream for writing to a file. Behind the scenes it uses `fs.createWriteStream()`<>. + +**Signature:** + +```typescript +static createWriteStream(filePath: string, options?: IFileSystemCreateWriteStreamOptions): FileSystemWriteStream; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +filePath + + + + +string + + + + +The path to the file. The path may be absolute or relative. + + +
+ +options + + + + +[IFileSystemCreateWriteStreamOptions](./node-core-library.ifilesystemcreatewritestreamoptions.md) + + + + +_(Optional)_ Optional settings that can change the behavior. + + +
+ +**Returns:** + +[FileSystemWriteStream](./node-core-library.filesystemwritestream.md) + +A new writable stream for the file. + +## Remarks + +Throws an error if the folder doesn't exist, unless [IFileSystemWriteFileOptionsBase.ensureFolderExists](./node-core-library.ifilesystemwritefileoptionsbase.ensurefolderexists.md) is set to `true`<>. + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.createwritestreamasync.md b/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.createwritestreamasync.md new file mode 100644 index 000000000..d5758120b --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.createwritestreamasync.md @@ -0,0 +1,74 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/node-core-library](./node-core-library.md) > [FileSystem](./node-core-library.filesystem.md) > [createWriteStreamAsync](./node-core-library.filesystem.createwritestreamasync.md) + +## FileSystem.createWriteStreamAsync() method + +An async version of [FileSystem.createWriteStream()](./node-core-library.filesystem.createwritestream.md)<>. + +**Signature:** + +```typescript +static createWriteStreamAsync(filePath: string, options?: IFileSystemCreateWriteStreamOptions): Promise; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +filePath + + + + +string + + + + + +
+ +options + + + + +[IFileSystemCreateWriteStreamOptions](./node-core-library.ifilesystemcreatewritestreamoptions.md) + + + + +_(Optional)_ + + +
+ +**Returns:** + +Promise<[FileSystemWriteStream](./node-core-library.filesystemwritestream.md)<>> + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.md b/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.md index 809079c57..cb6c01a52 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.md @@ -201,6 +201,22 @@ Creates a hard link. The link target must be a file, not a folder. Behind the sc An async version of [FileSystem.createHardLink()](./node-core-library.filesystem.createhardlink.md)<>. + + + +[createReadStream(filePath)](./node-core-library.filesystem.createreadstream.md) + + + + +`static` + + + + +Creates a readable stream for an existing file. Behind the scenes it uses `fs.createReadStream()`<>. + + @@ -297,6 +313,38 @@ Creates an NTFS "directory junction" on Windows operating systems; for other ope An async version of [FileSystem.createSymbolicLinkJunction()](./node-core-library.filesystem.createsymboliclinkjunction.md)<>. + + + +[createWriteStream(filePath, options)](./node-core-library.filesystem.createwritestream.md) + + + + +`static` + + + + +Creates a writable stream for writing to a file. Behind the scenes it uses `fs.createWriteStream()`<>. + + + + + +[createWriteStreamAsync(filePath, options)](./node-core-library.filesystem.createwritestreamasync.md) + + + + +`static` + + + + +An async version of [FileSystem.createWriteStream()](./node-core-library.filesystem.createwritestream.md)<>. + + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.writebufferstofile.md b/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.writebufferstofile.md index 27732197f..82298dcdb 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.writebufferstofile.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.writebufferstofile.md @@ -94,5 +94,5 @@ void ## Remarks -Throws an error if the folder doesn't exist, unless ensureFolder=true. +Throws an error if the folder doesn't exist, unless [IFileSystemWriteFileOptionsBase.ensureFolderExists](./node-core-library.ifilesystemwritefileoptionsbase.ensurefolderexists.md) is set to `true`<>. diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.writefile.md b/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.writefile.md index b96fa4d5a..33f751ace 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.writefile.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.filesystem.writefile.md @@ -80,7 +80,7 @@ options -_(Optional)_ Optional settings that can change the behavior. Type: `IWriteFileOptions` +_(Optional)_ Optional settings that can change the behavior. @@ -92,5 +92,5 @@ void ## Remarks -Throws an error if the folder doesn't exist, unless ensureFolder=true. +Throws an error if the folder doesn't exist, unless [IFileSystemWriteFileOptionsBase.ensureFolderExists](./node-core-library.ifilesystemwritefileoptionsbase.ensurefolderexists.md) is set to `true`<>. diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.filesystemreadstream.md b/websites/api.rushstack.io/docs/pages/node-core-library.filesystemreadstream.md new file mode 100644 index 000000000..b3e059349 --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/node-core-library.filesystemreadstream.md @@ -0,0 +1,24 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/node-core-library](./node-core-library.md) > [FileSystemReadStream](./node-core-library.filesystemreadstream.md) + +## FileSystemReadStream type + +An alias for the Node.js `fs.ReadStream` object. + +**Signature:** + +```typescript +export type FileSystemReadStream = fs.ReadStream; +``` + +## Remarks + +This avoids the need to import the `fs` package when using the [FileSystem](./node-core-library.filesystem.md) API. + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.filesystemwritestream.md b/websites/api.rushstack.io/docs/pages/node-core-library.filesystemwritestream.md new file mode 100644 index 000000000..af329c88d --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/node-core-library.filesystemwritestream.md @@ -0,0 +1,24 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/node-core-library](./node-core-library.md) > [FileSystemWriteStream](./node-core-library.filesystemwritestream.md) + +## FileSystemWriteStream type + +An alias for the Node.js `fs.WriteStream` object. + +**Signature:** + +```typescript +export type FileSystemWriteStream = fs.WriteStream; +``` + +## Remarks + +This avoids the need to import the `fs` package when using the [FileSystem](./node-core-library.filesystem.md) API. + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.iasyncparallelismoptions.allowoversubscription.md b/websites/api.rushstack.io/docs/pages/node-core-library.iasyncparallelismoptions.allowoversubscription.md index 27de07e60..bd7c29e3e 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.iasyncparallelismoptions.allowoversubscription.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.iasyncparallelismoptions.allowoversubscription.md @@ -18,6 +18,10 @@ This option affects the handling of task weights, applying a softer policy that allowOversubscription?: boolean; ``` +## Default Value + +false + ## Remarks By default, a new task cannot start executing if doing so would push the total weight above the concurrency limit. Set `allowOversubscription` to true to relax this rule, allowing a new task to start as long as the current total weight is below the concurrency limit. Either way, a task cannot start if the total weight already equals the concurrency limit; therefore, `allowOversubscription` has no effect when all tasks have weight 1. diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemcopyfilebaseoptions.alreadyexistsbehavior.md b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemcopyfilebaseoptions.alreadyexistsbehavior.md index 068d65e82..f4fc4f4d0 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemcopyfilebaseoptions.alreadyexistsbehavior.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemcopyfilebaseoptions.alreadyexistsbehavior.md @@ -17,3 +17,8 @@ Specifies what to do if the destination path already exists. ```typescript alreadyExistsBehavior?: AlreadyExistsBehavior; ``` + +## Default Value + +[AlreadyExistsBehavior.Overwrite](./node-core-library.alreadyexistsbehavior.md) + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemcreatewritestreamoptions.md b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemcreatewritestreamoptions.md new file mode 100644 index 000000000..73223b903 --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemcreatewritestreamoptions.md @@ -0,0 +1,21 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/node-core-library](./node-core-library.md) > [IFileSystemCreateWriteStreamOptions](./node-core-library.ifilesystemcreatewritestreamoptions.md) + +## IFileSystemCreateWriteStreamOptions interface + +The options for [FileSystem.createWriteStream()](./node-core-library.filesystem.createwritestream.md) + +**Signature:** + +```typescript +export interface IFileSystemCreateWriteStreamOptions extends IFileSystemWriteFileOptionsBase +``` +**Extends:** [IFileSystemWriteFileOptionsBase](./node-core-library.ifilesystemwritefileoptionsbase.md) + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemdeletefileoptions.throwifnotexists.md b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemdeletefileoptions.throwifnotexists.md index bb831bcfd..f1534e560 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemdeletefileoptions.throwifnotexists.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemdeletefileoptions.throwifnotexists.md @@ -17,3 +17,8 @@ If true, will throw an exception if the file did not exist before `deleteFile()` ```typescript throwIfNotExists?: boolean; ``` + +## Default Value + +false + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemmoveoptions.ensurefolderexists.md b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemmoveoptions.ensurefolderexists.md deleted file mode 100644 index d00692a44..000000000 --- a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemmoveoptions.ensurefolderexists.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -hide_title: true -custom_edit_url: null -pagination_prev: null -pagination_next: null ---- - - -[Home](./index.md) > [@rushstack/node-core-library](./node-core-library.md) > [IFileSystemMoveOptions](./node-core-library.ifilesystemmoveoptions.md) > [ensureFolderExists](./node-core-library.ifilesystemmoveoptions.ensurefolderexists.md) - -## IFileSystemMoveOptions.ensureFolderExists property - -If true, will ensure the folder is created before writing the file. - -**Signature:** - -```typescript -ensureFolderExists?: boolean; -``` diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemmoveoptions.md b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemmoveoptions.md index e6f48a4fc..32a1cb5b9 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemmoveoptions.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemmoveoptions.md @@ -15,8 +15,9 @@ The options for [FileSystem.move()](./node-core-library.filesystem.move.md) **Signature:** ```typescript -export interface IFileSystemMoveOptions +export interface IFileSystemMoveOptions extends IFileSystemWriteFileOptionsBase ``` +**Extends:** [IFileSystemWriteFileOptionsBase](./node-core-library.ifilesystemwritefileoptionsbase.md) ## Properties @@ -59,25 +60,6 @@ string The new path for the object. The path may be absolute or relative. - - - -[ensureFolderExists?](./node-core-library.ifilesystemmoveoptions.ensurefolderexists.md) - - - - - - - -boolean - - - - -_(Optional)_ If true, will ensure the folder is created before writing the file. - - diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemmoveoptions.overwrite.md b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemmoveoptions.overwrite.md index c6b8bb969..45e5063f9 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemmoveoptions.overwrite.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemmoveoptions.overwrite.md @@ -17,3 +17,8 @@ If true, will overwrite the file if it already exists. ```typescript overwrite?: boolean; ``` + +## Default Value + +true + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemreadfileoptions.convertlineendings.md b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemreadfileoptions.convertlineendings.md index 5053bc384..693e0ed9a 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemreadfileoptions.convertlineendings.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemreadfileoptions.convertlineendings.md @@ -17,3 +17,8 @@ If specified, will normalize line endings to the specified style of newline. ```typescript convertLineEndings?: NewlineKind; ``` + +## Default Value + +`undefined` which means no conversion will be performed + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemreadfileoptions.encoding.md b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemreadfileoptions.encoding.md index 84e853e1b..4b9174ee3 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemreadfileoptions.encoding.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemreadfileoptions.encoding.md @@ -17,3 +17,8 @@ If specified, will change the encoding of the file that will be written. ```typescript encoding?: Encoding; ``` + +## Default Value + +Encoding.Utf8 + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemreadfolderoptions.absolutepaths.md b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemreadfolderoptions.absolutepaths.md index 11851f0f4..7c6069e41 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemreadfolderoptions.absolutepaths.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemreadfolderoptions.absolutepaths.md @@ -17,3 +17,8 @@ If true, returns the absolute paths of the files in the folder. ```typescript absolutePaths?: boolean; ``` + +## Default Value + +false + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritebinaryfileoptions.md b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritebinaryfileoptions.md index 30bab79fa..7a9178e3f 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritebinaryfileoptions.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritebinaryfileoptions.md @@ -15,50 +15,7 @@ The options for [FileSystem.writeBuffersToFile()](./node-core-library.filesystem **Signature:** ```typescript -export interface IFileSystemWriteBinaryFileOptions +export interface IFileSystemWriteBinaryFileOptions extends IFileSystemWriteFileOptionsBase ``` - -## Properties - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[ensureFolderExists?](./node-core-library.ifilesystemwritebinaryfileoptions.ensurefolderexists.md) - - - - - - - -boolean - - - - -_(Optional)_ If true, will ensure the folder is created before writing the file. - - -
+**Extends:** [IFileSystemWriteFileOptionsBase](./node-core-library.ifilesystemwritefileoptionsbase.md) diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritefileoptions.convertlineendings.md b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritefileoptions.convertlineendings.md index 6e32df379..ee5051fed 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritefileoptions.convertlineendings.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritefileoptions.convertlineendings.md @@ -17,3 +17,8 @@ If specified, will normalize line endings to the specified style of newline. ```typescript convertLineEndings?: NewlineKind; ``` + +## Default Value + +`undefined` which means no conversion will be performed + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritefileoptions.encoding.md b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritefileoptions.encoding.md index 498e4902e..f7b874e65 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritefileoptions.encoding.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritefileoptions.encoding.md @@ -17,3 +17,8 @@ If specified, will change the encoding of the file that will be written. ```typescript encoding?: Encoding; ``` + +## Default Value + +"utf8" + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritebinaryfileoptions.ensurefolderexists.md b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritefileoptionsbase.ensurefolderexists.md similarity index 55% rename from websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritebinaryfileoptions.ensurefolderexists.md rename to websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritefileoptionsbase.ensurefolderexists.md index bfbb83348..03b346c82 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritebinaryfileoptions.ensurefolderexists.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritefileoptionsbase.ensurefolderexists.md @@ -6,9 +6,9 @@ pagination_next: null --- -[Home](./index.md) > [@rushstack/node-core-library](./node-core-library.md) > [IFileSystemWriteBinaryFileOptions](./node-core-library.ifilesystemwritebinaryfileoptions.md) > [ensureFolderExists](./node-core-library.ifilesystemwritebinaryfileoptions.ensurefolderexists.md) +[Home](./index.md) > [@rushstack/node-core-library](./node-core-library.md) > [IFileSystemWriteFileOptionsBase](./node-core-library.ifilesystemwritefileoptionsbase.md) > [ensureFolderExists](./node-core-library.ifilesystemwritefileoptionsbase.ensurefolderexists.md) -## IFileSystemWriteBinaryFileOptions.ensureFolderExists property +## IFileSystemWriteFileOptionsBase.ensureFolderExists property If true, will ensure the folder is created before writing the file. @@ -17,3 +17,8 @@ If true, will ensure the folder is created before writing the file. ```typescript ensureFolderExists?: boolean; ``` + +## Default Value + +false + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritefileoptionsbase.md b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritefileoptionsbase.md new file mode 100644 index 000000000..6785f1b33 --- /dev/null +++ b/websites/api.rushstack.io/docs/pages/node-core-library.ifilesystemwritefileoptionsbase.md @@ -0,0 +1,63 @@ +--- +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + +[Home](./index.md) > [@rushstack/node-core-library](./node-core-library.md) > [IFileSystemWriteFileOptionsBase](./node-core-library.ifilesystemwritefileoptionsbase.md) + +## IFileSystemWriteFileOptionsBase interface + + +**Signature:** + +```typescript +export interface IFileSystemWriteFileOptionsBase +``` + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[ensureFolderExists?](./node-core-library.ifilesystemwritefileoptionsbase.ensurefolderexists.md) + + + + + + + +boolean + + + + +_(Optional)_ If true, will ensure the folder is created before writing the file. + + +
+ diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ijsonfileparseoptions.jsonsyntax.md b/websites/api.rushstack.io/docs/pages/node-core-library.ijsonfileparseoptions.jsonsyntax.md index e7b119b4a..212931bca 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.ijsonfileparseoptions.jsonsyntax.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.ijsonfileparseoptions.jsonsyntax.md @@ -17,3 +17,10 @@ Specifies the variant of JSON syntax to be used. ```typescript jsonSyntax?: JsonSyntax; ``` + +## Default Value + +[JsonSyntax.Json5](./node-core-library.jsonsyntax.md) + +NOTE: This default will be changed to `JsonSyntax.JsonWithComments` in a future release. + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ijsonschemaloadoptions.rejectvendorextensionkeywords.md b/websites/api.rushstack.io/docs/pages/node-core-library.ijsonschemaloadoptions.rejectvendorextensionkeywords.md index 75a326eeb..44ba5dce4 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.ijsonschemaloadoptions.rejectvendorextensionkeywords.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.ijsonschemaloadoptions.rejectvendorextensionkeywords.md @@ -21,6 +21,10 @@ If true, the AJV validator will reject JSON Schema vendor extension keywords mat rejectVendorExtensionKeywords?: boolean; ``` +## Default Value + +false + ## Remarks The JSON Schema specification allows vendor-specific extensions using the `x-` prefix. For example, `x-tsdoc-release-tag` is used by `@rushstack/heft-json-schema-typings-plugin`<>. Other tools may define their own extensions such as `x-myvendor-html-description`<>. diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.ijsonschemaloadoptions.schemaversion.md b/websites/api.rushstack.io/docs/pages/node-core-library.ijsonschemaloadoptions.schemaversion.md index 1aa0aa5d0..0fd87aeef 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.ijsonschemaloadoptions.schemaversion.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.ijsonschemaloadoptions.schemaversion.md @@ -18,6 +18,10 @@ The json-schema version to target for validation. schemaVersion?: JsonSchemaVersion; ``` +## Default Value + +draft-07 + ## Remarks If the a version is not explicitly set, the schema object's `$schema` property will be inspected to determine the version. If a `$schema` property is not found or does not match an expected URL, the default version will be used. diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.irealnodemodulepathresolveroptions.ignoremissingpaths.md b/websites/api.rushstack.io/docs/pages/node-core-library.irealnodemodulepathresolveroptions.ignoremissingpaths.md index 0535fc08c..d6120bc2f 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.irealnodemodulepathresolveroptions.ignoremissingpaths.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.irealnodemodulepathresolveroptions.ignoremissingpaths.md @@ -17,3 +17,8 @@ If set to true, the resolver will not throw if part of the path does not exist. ```typescript ignoreMissingPaths?: boolean; ``` + +## Default Value + +false + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.iwaitforexitoptions.throwonnonzeroexitcode.md b/websites/api.rushstack.io/docs/pages/node-core-library.iwaitforexitoptions.throwonnonzeroexitcode.md index 0fc7e5dcc..63754e75e 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.iwaitforexitoptions.throwonnonzeroexitcode.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.iwaitforexitoptions.throwonnonzeroexitcode.md @@ -17,3 +17,8 @@ Whether or not to throw when the process completes with a non-zero exit code. De ```typescript throwOnNonZeroExitCode?: boolean; ``` + +## Default Value + +false + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.iwaitforexitoptions.throwonsignal.md b/websites/api.rushstack.io/docs/pages/node-core-library.iwaitforexitoptions.throwonsignal.md index 90267e8b1..c4eb3b9d3 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.iwaitforexitoptions.throwonsignal.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.iwaitforexitoptions.throwonsignal.md @@ -17,3 +17,8 @@ Whether or not to throw when the process is terminated by a signal. Defaults to ```typescript throwOnSignal?: boolean; ``` + +## Default Value + +false + diff --git a/websites/api.rushstack.io/docs/pages/node-core-library.md b/websites/api.rushstack.io/docs/pages/node-core-library.md index d282ec0e0..23d666b96 100644 --- a/websites/api.rushstack.io/docs/pages/node-core-library.md +++ b/websites/api.rushstack.io/docs/pages/node-core-library.md @@ -559,6 +559,17 @@ The options for [FileSystem.copyFiles()](./node-core-library.filesystem.copyfile 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)<>. + + + +[IFileSystemCreateWriteStreamOptions](./node-core-library.ifilesystemcreatewritestreamoptions.md) + + + + +The options for [FileSystem.createWriteStream()](./node-core-library.filesystem.createwritestream.md) + + @@ -636,6 +647,16 @@ The options for [FileSystem.writeBuffersToFile()](./node-core-library.filesystem The options for [FileSystem.writeFile()](./node-core-library.filesystem.writefile.md) + + + +[IFileSystemWriteFileOptionsBase](./node-core-library.ifilesystemwritefileoptionsbase.md) + + + + + + @@ -1276,6 +1297,17 @@ Callback function type for [IFileSystemCopyFilesAsyncOptions.filter](./node-core Callback function type for [IFileSystemCopyFilesOptions.filter](./node-core-library.ifilesystemcopyfilesoptions.filter.md) + + + +[FileSystemReadStream](./node-core-library.filesystemreadstream.md) + + + + +An alias for the Node.js `fs.ReadStream` object. + + @@ -1287,6 +1319,17 @@ Callback function type for [IFileSystemCopyFilesOptions.filter](./node-core-libr An alias for the Node.js `fs.Stats` object. + + + +[FileSystemWriteStream](./node-core-library.filesystemwritestream.md) + + + + +An alias for the Node.js `fs.WriteStream` object. + + diff --git a/websites/api.rushstack.io/docs/pages/rush-lib.ioperationsettings.dependsonnodeversion.md b/websites/api.rushstack.io/docs/pages/rush-lib.ioperationsettings.dependsonnodeversion.md index 779c996e2..b71f37e0f 100644 --- a/websites/api.rushstack.io/docs/pages/rush-lib.ioperationsettings.dependsonnodeversion.md +++ b/websites/api.rushstack.io/docs/pages/rush-lib.ioperationsettings.dependsonnodeversion.md @@ -15,7 +15,7 @@ pagination_next: null Specifies whether and at what granularity the Node.js version should be included in the hash used for the build cache. When enabled, changing the Node.js version at the specified granularity will invalidate cached outputs and cause the operation to be re-executed. This is useful for projects that produce Node.js-version-specific outputs, such as native module builds. -Allowed values: - `true` — alias for `"patch"`<>, includes the full version (e.g. `18.17.1`<>) - `"major"` — includes only the major version (e.g. `18`<>) - `"minor"` — includes the major and minor version (e.g. `18.17`<>) - `"patch"` — includes the full version (e.g. `18.17.1`<>) +Allowed values: - `true` - alias for `"patch"`<>, includes the full version (e.g. `18.17.1`<>) - `"major"` - includes only the major version (e.g. `18`<>) - `"minor"` - includes the major and minor version (e.g. `18.17`<>) - `"patch"` - includes the full version (e.g. `18.17.1`<>) **Signature:** diff --git a/websites/api.rushstack.io/docs/pages/rush-lib.ioperationsettings.md b/websites/api.rushstack.io/docs/pages/rush-lib.ioperationsettings.md index 45722e00e..7943717ac 100644 --- a/websites/api.rushstack.io/docs/pages/rush-lib.ioperationsettings.md +++ b/websites/api.rushstack.io/docs/pages/rush-lib.ioperationsettings.md @@ -121,7 +121,7 @@ boolean \| [NodeVersionGranularity](./rush-lib.nodeversiongranularity.md) **_(ALPHA)_** _(Optional)_ Specifies whether and at what granularity the Node.js version should be included in the hash used for the build cache. When enabled, changing the Node.js version at the specified granularity will invalidate cached outputs and cause the operation to be re-executed. This is useful for projects that produce Node.js-version-specific outputs, such as native module builds. -Allowed values: - `true` — alias for `"patch"`<>, includes the full version (e.g. `18.17.1`<>) - `"major"` — includes only the major version (e.g. `18`<>) - `"minor"` — includes the major and minor version (e.g. `18.17`<>) - `"patch"` — includes the full version (e.g. `18.17.1`<>) +Allowed values: - `true` - alias for `"patch"`<>, includes the full version (e.g. `18.17.1`<>) - `"major"` - includes only the major version (e.g. `18`<>) - `"minor"` - includes the major and minor version (e.g. `18.17`<>) - `"patch"` - includes the full version (e.g. `18.17.1`<>) diff --git a/websites/api.rushstack.io/docs/pages/rush-lib.irushphasesharding.outputfolderargumentformat.md b/websites/api.rushstack.io/docs/pages/rush-lib.irushphasesharding.outputfolderargumentformat.md index 95c13ff8b..425eb3d47 100644 --- a/websites/api.rushstack.io/docs/pages/rush-lib.irushphasesharding.outputfolderargumentformat.md +++ b/websites/api.rushstack.io/docs/pages/rush-lib.irushphasesharding.outputfolderargumentformat.md @@ -20,3 +20,8 @@ An optional argument to pass to the command to indicate the output folder for th ```typescript outputFolderArgumentFormat?: string; ``` + +## Default Value + +`--shard-output-folder=.rush/operations/{phaseName}/shards/{shardIndex}`<>. + diff --git a/websites/api.rushstack.io/docs/pages/rush-lib.irushphasesharding.shardargumentformat.md b/websites/api.rushstack.io/docs/pages/rush-lib.irushphasesharding.shardargumentformat.md index 10a06c5e2..f5b92877b 100644 --- a/websites/api.rushstack.io/docs/pages/rush-lib.irushphasesharding.shardargumentformat.md +++ b/websites/api.rushstack.io/docs/pages/rush-lib.irushphasesharding.shardargumentformat.md @@ -20,3 +20,8 @@ The format of the argument to pass to the command to indicate the shard index an ```typescript shardArgumentFormat?: string; ``` + +## Default Value + +`--shard={shardIndex}/{shardCount}` + diff --git a/websites/api.rushstack.io/docs/pages/rush-lib.md b/websites/api.rushstack.io/docs/pages/rush-lib.md index 5bafc70c6..e4115e186 100644 --- a/websites/api.rushstack.io/docs/pages/rush-lib.md +++ b/websites/api.rushstack.io/docs/pages/rush-lib.md @@ -1251,7 +1251,7 @@ Description **_(ALPHA)_** The granularity at which the Node.js version is included in the build cache hash. -- `"major"` — includes only the major version (e.g. `18`<>) - `"minor"` — includes the major and minor version (e.g. `18.17`<>) - `"patch"` — includes the full version (e.g. `18.17.1`<>) +- `"major"` - includes only the major version (e.g. `18`<>) - `"minor"` - includes the major and minor version (e.g. `18.17`<>) - `"patch"` - includes the full version (e.g. `18.17.1`<>) diff --git a/websites/api.rushstack.io/docs/pages/rush-lib.nodeversiongranularity.md b/websites/api.rushstack.io/docs/pages/rush-lib.nodeversiongranularity.md index 396f02c5d..e604ef2b9 100644 --- a/websites/api.rushstack.io/docs/pages/rush-lib.nodeversiongranularity.md +++ b/websites/api.rushstack.io/docs/pages/rush-lib.nodeversiongranularity.md @@ -15,7 +15,7 @@ pagination_next: null The granularity at which the Node.js version is included in the build cache hash. -- `"major"` — includes only the major version (e.g. `18`<>) - `"minor"` — includes the major and minor version (e.g. `18.17`<>) - `"patch"` — includes the full version (e.g. `18.17.1`<>) +- `"major"` - includes only the major version (e.g. `18`<>) - `"minor"` - includes the major and minor version (e.g. `18.17`<>) - `"patch"` - includes the full version (e.g. `18.17.1`<>) **Signature:** diff --git a/websites/api.rushstack.io/docs/pages/terminal.istdiosummarizeroptions.leadinglines.md b/websites/api.rushstack.io/docs/pages/terminal.istdiosummarizeroptions.leadinglines.md index 3bd5a57d4..5f6bb1458 100644 --- a/websites/api.rushstack.io/docs/pages/terminal.istdiosummarizeroptions.leadinglines.md +++ b/websites/api.rushstack.io/docs/pages/terminal.istdiosummarizeroptions.leadinglines.md @@ -20,3 +20,8 @@ Specifies the maximum number of leading lines to include in the summary. ```typescript leadingLines?: number; ``` + +## Default Value + +`10` + diff --git a/websites/api.rushstack.io/docs/pages/terminal.istdiosummarizeroptions.trailinglines.md b/websites/api.rushstack.io/docs/pages/terminal.istdiosummarizeroptions.trailinglines.md index e3666036f..01d45ffc4 100644 --- a/websites/api.rushstack.io/docs/pages/terminal.istdiosummarizeroptions.trailinglines.md +++ b/websites/api.rushstack.io/docs/pages/terminal.istdiosummarizeroptions.trailinglines.md @@ -20,3 +20,8 @@ Specifies the maximum number of trailing lines to include in the summary. ```typescript trailingLines?: number; ``` + +## Default Value + +`10` + diff --git a/websites/api.rushstack.io/docs/pages/typings-generator.iexportasdefaultoptions.interfacename.md b/websites/api.rushstack.io/docs/pages/typings-generator.iexportasdefaultoptions.interfacename.md index 07736b7af..4f8240b04 100644 --- a/websites/api.rushstack.io/docs/pages/typings-generator.iexportasdefaultoptions.interfacename.md +++ b/websites/api.rushstack.io/docs/pages/typings-generator.iexportasdefaultoptions.interfacename.md @@ -17,3 +17,8 @@ This setting overrides the the interface name for the default wrapped export. ```typescript interfaceName?: string; ``` + +## Default Value + +"IExport" +