Skip to content

Commit 0e0a1af

Browse files
committed
docs: update API documentation
1 parent cd2d784 commit 0e0a1af

3 files changed

Lines changed: 43 additions & 0 deletions

File tree

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15287,6 +15287,11 @@
1528715287
"label": "pnpmInstallFolder",
1528815288
"id": "pages/package-extractor.iextractorsubspace.pnpminstallfolder"
1528915289
},
15290+
{
15291+
"type": "doc",
15292+
"label": "pnpmNodeModulesHoistingEnabled",
15293+
"id": "pages/package-extractor.iextractorsubspace.pnpmnodemoduleshoistingenabled"
15294+
},
1529015295
{
1529115296
"type": "doc",
1529215297
"label": "subspaceName",

websites/api.rushstack.io/docs/pages/package-extractor.iextractorsubspace.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,25 @@ string
5959
_(Optional)_ The folder where the PNPM "node\_modules" folder is located. This is used to resolve packages linked to the PNPM virtual store.
6060

6161

62+
</td></tr>
63+
<tr><td>
64+
65+
[pnpmNodeModulesHoistingEnabled?](./package-extractor.iextractorsubspace.pnpmnodemoduleshoistingenabled.md)
66+
67+
68+
</td><td>
69+
70+
71+
</td><td>
72+
73+
boolean
74+
75+
76+
</td><td>
77+
78+
_(Optional)_ Whether PNPM hoisting is enabled for this subspace. When set to `false`<></>, the extractor will skip looking for hoisted packages in the PNPM virtual store, since no hoisting symlinks will exist. Default is `true`<></>.
79+
80+
6281
</td></tr>
6382
<tr><td>
6483

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
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/package-extractor](./package-extractor.md) &gt; [IExtractorSubspace](./package-extractor.iextractorsubspace.md) &gt; [pnpmNodeModulesHoistingEnabled](./package-extractor.iextractorsubspace.pnpmnodemoduleshoistingenabled.md)
10+
11+
## IExtractorSubspace.pnpmNodeModulesHoistingEnabled property
12+
13+
Whether PNPM hoisting is enabled for this subspace. When set to `false`<></>, the extractor will skip looking for hoisted packages in the PNPM virtual store, since no hoisting symlinks will exist. Default is `true`<></>.
14+
15+
**Signature:**
16+
17+
```typescript
18+
pnpmNodeModulesHoistingEnabled?: boolean;
19+
```

0 commit comments

Comments
 (0)