Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 110 additions & 18 deletions websites/api.rushstack.io/data/api_nav.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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"
}
]
},
Expand All @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -11987,6 +12074,11 @@
}
]
},
{
"type": "doc",
"label": "IFileSystemCreateWriteStreamOptions",
"id": "pages/node-core-library.ifilesystemcreatewritestreamoptions"
},
{
"type": "category",
"label": "IFileSystemDeleteFileOptions",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -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",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
hide_title: true
custom_edit_url: null
pagination_prev: null
pagination_next: null
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@rushstack/lookup-by-path](./lookup-by-path.md) &gt; [ILookupByPathJson](./lookup-by-path.ilookupbypathjson.md) &gt; [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;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
---
hide_title: true
custom_edit_url: null
pagination_prev: null
pagination_next: null
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@rushstack/lookup-by-path](./lookup-by-path.md) &gt; [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<TSerialized>
```

## 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

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[delimiter](./lookup-by-path.ilookupbypathjson.delimiter.md)


</td><td>


</td><td>

string


</td><td>

**_(BETA)_** The path delimiter used by the serialized trie.


</td></tr>
<tr><td>

[tree](./lookup-by-path.ilookupbypathjson.tree.md)


</td><td>


</td><td>

[ISerializedPathTrieNode](./lookup-by-path.iserializedpathtrienode.md)


</td><td>

**_(BETA)_** The serialized tree structure.


</td></tr>
<tr><td>

[values](./lookup-by-path.ilookupbypathjson.values.md)


</td><td>


</td><td>

TSerialized\[\]


</td><td>

**_(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.


</td></tr>
</tbody></table>

Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
hide_title: true
custom_edit_url: null
pagination_prev: null
pagination_next: null
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@rushstack/lookup-by-path](./lookup-by-path.md) &gt; [ILookupByPathJson](./lookup-by-path.ilookupbypathjson.md) &gt; [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;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
hide_title: true
custom_edit_url: null
pagination_prev: null
pagination_next: null
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@rushstack/lookup-by-path](./lookup-by-path.md) &gt; [ILookupByPathJson](./lookup-by-path.ilookupbypathjson.md) &gt; [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[];
```
Loading
Loading