Skip to content

Commit bef9d6e

Browse files
rushbotrushbot
committed
docs: update API documentation
1 parent cf5079b commit bef9d6e

30 files changed

Lines changed: 1170 additions & 126 deletions

‎websites/api.rushstack.io/data/api_nav.json‎

Lines changed: 110 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10278,6 +10278,32 @@
1027810278
}
1027910279
]
1028010280
},
10281+
{
10282+
"type": "category",
10283+
"label": "ILookupByPathJson",
10284+
"items": [
10285+
{
10286+
"type": "doc",
10287+
"label": "(members)",
10288+
"id": "pages/lookup-by-path.ilookupbypathjson"
10289+
},
10290+
{
10291+
"type": "doc",
10292+
"label": "delimiter",
10293+
"id": "pages/lookup-by-path.ilookupbypathjson.delimiter"
10294+
},
10295+
{
10296+
"type": "doc",
10297+
"label": "tree",
10298+
"id": "pages/lookup-by-path.ilookupbypathjson.tree"
10299+
},
10300+
{
10301+
"type": "doc",
10302+
"label": "values",
10303+
"id": "pages/lookup-by-path.ilookupbypathjson.values"
10304+
}
10305+
]
10306+
},
1028110307
{
1028210308
"type": "category",
1028310309
"label": "IPrefixMatch",
@@ -10357,6 +10383,11 @@
1035710383
"type": "doc",
1035810384
"label": "has",
1035910385
"id": "pages/lookup-by-path.ireadonlylookupbypath.has"
10386+
},
10387+
{
10388+
"type": "doc",
10389+
"label": "toJson",
10390+
"id": "pages/lookup-by-path.ireadonlylookupbypath.tojson"
1036010391
}
1036110392
]
1036210393
},
@@ -10381,6 +10412,27 @@
1038110412
}
1038210413
]
1038310414
},
10415+
{
10416+
"type": "category",
10417+
"label": "ISerializedPathTrieNode",
10418+
"items": [
10419+
{
10420+
"type": "doc",
10421+
"label": "(members)",
10422+
"id": "pages/lookup-by-path.iserializedpathtrienode"
10423+
},
10424+
{
10425+
"type": "doc",
10426+
"label": "children",
10427+
"id": "pages/lookup-by-path.iserializedpathtrienode.children"
10428+
},
10429+
{
10430+
"type": "doc",
10431+
"label": "valueIndex",
10432+
"id": "pages/lookup-by-path.iserializedpathtrienode.valueindex"
10433+
}
10434+
]
10435+
},
1038410436
{
1038510437
"type": "category",
1038610438
"label": "LookupByPath",
@@ -10440,6 +10492,11 @@
1044010492
"label": "findLongestPrefixMatch",
1044110493
"id": "pages/lookup-by-path.lookupbypath.findlongestprefixmatch"
1044210494
},
10495+
{
10496+
"type": "doc",
10497+
"label": "fromJson",
10498+
"id": "pages/lookup-by-path.lookupbypath.fromjson"
10499+
},
1044310500
{
1044410501
"type": "doc",
1044510502
"label": "get",
@@ -10480,6 +10537,11 @@
1048010537
"label": "size",
1048110538
"id": "pages/lookup-by-path.lookupbypath.size"
1048210539
},
10540+
{
10541+
"type": "doc",
10542+
"label": "toJson",
10543+
"id": "pages/lookup-by-path.lookupbypath.tojson"
10544+
},
1048310545
{
1048410546
"type": "doc",
1048510547
"label": "tree",
@@ -11377,6 +11439,11 @@
1137711439
"label": "createHardLinkAsync",
1137811440
"id": "pages/node-core-library.filesystem.createhardlinkasync"
1137911441
},
11442+
{
11443+
"type": "doc",
11444+
"label": "createReadStream",
11445+
"id": "pages/node-core-library.filesystem.createreadstream"
11446+
},
1138011447
{
1138111448
"type": "doc",
1138211449
"label": "createSymbolicLinkFile",
@@ -11407,6 +11474,16 @@
1140711474
"label": "createSymbolicLinkJunctionAsync",
1140811475
"id": "pages/node-core-library.filesystem.createsymboliclinkjunctionasync"
1140911476
},
11477+
{
11478+
"type": "doc",
11479+
"label": "createWriteStream",
11480+
"id": "pages/node-core-library.filesystem.createwritestream"
11481+
},
11482+
{
11483+
"type": "doc",
11484+
"label": "createWriteStreamAsync",
11485+
"id": "pages/node-core-library.filesystem.createwritestreamasync"
11486+
},
1141011487
{
1141111488
"type": "doc",
1141211489
"label": "deleteFile",
@@ -11644,11 +11721,21 @@
1164411721
"label": "FileSystemCopyFilesFilter",
1164511722
"id": "pages/node-core-library.filesystemcopyfilesfilter"
1164611723
},
11724+
{
11725+
"type": "doc",
11726+
"label": "FileSystemReadStream",
11727+
"id": "pages/node-core-library.filesystemreadstream"
11728+
},
1164711729
{
1164811730
"type": "doc",
1164911731
"label": "FileSystemStats",
1165011732
"id": "pages/node-core-library.filesystemstats"
1165111733
},
11734+
{
11735+
"type": "doc",
11736+
"label": "FileSystemWriteStream",
11737+
"id": "pages/node-core-library.filesystemwritestream"
11738+
},
1165211739
{
1165311740
"type": "category",
1165411741
"label": "FileWriter",
@@ -11987,6 +12074,11 @@
1198712074
}
1198812075
]
1198912076
},
12077+
{
12078+
"type": "doc",
12079+
"label": "IFileSystemCreateWriteStreamOptions",
12080+
"id": "pages/node-core-library.ifilesystemcreatewritestreamoptions"
12081+
},
1199012082
{
1199112083
"type": "category",
1199212084
"label": "IFileSystemDeleteFileOptions",
@@ -12017,11 +12109,6 @@
1201712109
"label": "destinationPath",
1201812110
"id": "pages/node-core-library.ifilesystemmoveoptions.destinationpath"
1201912111
},
12020-
{
12021-
"type": "doc",
12022-
"label": "ensureFolderExists",
12023-
"id": "pages/node-core-library.ifilesystemmoveoptions.ensurefolderexists"
12024-
},
1202512112
{
1202612113
"type": "doc",
1202712114
"label": "overwrite",
@@ -12093,20 +12180,9 @@
1209312180
]
1209412181
},
1209512182
{
12096-
"type": "category",
12183+
"type": "doc",
1209712184
"label": "IFileSystemWriteBinaryFileOptions",
12098-
"items": [
12099-
{
12100-
"type": "doc",
12101-
"label": "(members)",
12102-
"id": "pages/node-core-library.ifilesystemwritebinaryfileoptions"
12103-
},
12104-
{
12105-
"type": "doc",
12106-
"label": "ensureFolderExists",
12107-
"id": "pages/node-core-library.ifilesystemwritebinaryfileoptions.ensurefolderexists"
12108-
}
12109-
]
12185+
"id": "pages/node-core-library.ifilesystemwritebinaryfileoptions"
1211012186
},
1211112187
{
1211212188
"type": "category",
@@ -12129,6 +12205,22 @@
1212912205
}
1213012206
]
1213112207
},
12208+
{
12209+
"type": "category",
12210+
"label": "IFileSystemWriteFileOptionsBase",
12211+
"items": [
12212+
{
12213+
"type": "doc",
12214+
"label": "(members)",
12215+
"id": "pages/node-core-library.ifilesystemwritefileoptionsbase"
12216+
},
12217+
{
12218+
"type": "doc",
12219+
"label": "ensureFolderExists",
12220+
"id": "pages/node-core-library.ifilesystemwritefileoptionsbase.ensurefolderexists"
12221+
}
12222+
]
12223+
},
1213212224
{
1213312225
"type": "category",
1213412226
"label": "IFileWriterFlags",

‎websites/api.rushstack.io/docs/pages/lookup-by-path.ilookupbypathjson.delimiter.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
hide_title: true
3+
custom_edit_url: null
4+
pagination_prev: null
5+
pagination_next: null
6+
---
7+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
8+
9+
[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)
10+
11+
## ILookupByPathJson.delimiter property
12+
13+
> 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.
14+
>
15+
16+
The path delimiter used by the serialized trie.
17+
18+
**Signature:**
19+
20+
```typescript
21+
delimiter: string;
22+
```

‎websites/api.rushstack.io/docs/pages/lookup-by-path.ilookupbypathjson.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
hide_title: true
3+
custom_edit_url: null
4+
pagination_prev: null
5+
pagination_next: null
6+
---
7+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
8+
9+
[Home](./index.md) &gt; [@rushstack/lookup-by-path](./lookup-by-path.md) &gt; [ILookupByPathJson](./lookup-by-path.ilookupbypathjson.md)
10+
11+
## ILookupByPathJson interface
12+
13+
> 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.
14+
>
15+
16+
JSON-serializable representation of a [LookupByPath](./lookup-by-path.lookupbypath.md) instance.
17+
18+
**Signature:**
19+
20+
```typescript
21+
export interface ILookupByPathJson<TSerialized>
22+
```
23+
24+
## Remarks
25+
26+
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.
27+
28+
## Properties
29+
30+
<table><thead><tr><th>
31+
32+
Property
33+
34+
35+
</th><th>
36+
37+
Modifiers
38+
39+
40+
</th><th>
41+
42+
Type
43+
44+
45+
</th><th>
46+
47+
Description
48+
49+
50+
</th></tr></thead>
51+
<tbody><tr><td>
52+
53+
[delimiter](./lookup-by-path.ilookupbypathjson.delimiter.md)
54+
55+
56+
</td><td>
57+
58+
59+
</td><td>
60+
61+
string
62+
63+
64+
</td><td>
65+
66+
**_(BETA)_** The path delimiter used by the serialized trie.
67+
68+
69+
</td></tr>
70+
<tr><td>
71+
72+
[tree](./lookup-by-path.ilookupbypathjson.tree.md)
73+
74+
75+
</td><td>
76+
77+
78+
</td><td>
79+
80+
[ISerializedPathTrieNode](./lookup-by-path.iserializedpathtrienode.md)
81+
82+
83+
</td><td>
84+
85+
**_(BETA)_** The serialized tree structure.
86+
87+
88+
</td></tr>
89+
<tr><td>
90+
91+
[values](./lookup-by-path.ilookupbypathjson.values.md)
92+
93+
94+
</td><td>
95+
96+
97+
</td><td>
98+
99+
TSerialized\[\]
100+
101+
102+
</td><td>
103+
104+
**_(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.
105+
106+
107+
</td></tr>
108+
</tbody></table>
109+

‎websites/api.rushstack.io/docs/pages/lookup-by-path.ilookupbypathjson.tree.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
hide_title: true
3+
custom_edit_url: null
4+
pagination_prev: null
5+
pagination_next: null
6+
---
7+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
8+
9+
[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)
10+
11+
## ILookupByPathJson.tree property
12+
13+
> 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.
14+
>
15+
16+
The serialized tree structure.
17+
18+
**Signature:**
19+
20+
```typescript
21+
tree: ISerializedPathTrieNode;
22+
```

‎websites/api.rushstack.io/docs/pages/lookup-by-path.ilookupbypathjson.values.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
hide_title: true
3+
custom_edit_url: null
4+
pagination_prev: null
5+
pagination_next: null
6+
---
7+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
8+
9+
[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)
10+
11+
## ILookupByPathJson.values property
12+
13+
> 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.
14+
>
15+
16+
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.
17+
18+
**Signature:**
19+
20+
```typescript
21+
values: TSerialized[];
22+
```

0 commit comments

Comments
 (0)