Skip to content

Commit e768580

Browse files
committed
fix: Correcting getLoaders types + docs
1 parent 6134972 commit e768580

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

docs/webpack-helpers.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,18 @@ Type: [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference
139139
- `rule` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** [rule entry](https://webpack.js.org/configuration/module/#module-rules).
140140
- `index` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** index of rule in config.
141141

142+
## LoadersWrapper
143+
144+
Wrapper around webpack's [loader entry](https://webpack.js.org/configuration/module/#useentry).
145+
146+
Type: [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
147+
148+
**Properties**
149+
150+
- `rule` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** [rule entry](https://webpack.js.org/configuration/module/#module-rules).
151+
- `ruleIndex` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** index of rule in config.
152+
- `loaders` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** [loader entry](https://webpack.js.org/configuration/module/#useentry).
153+
142154
## LoaderWrapper
143155

144156
Wrapper around webpack's [loader entry](https://webpack.js.org/configuration/module/#useentry).

packages/cli/types.d.ts

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,22 @@ type Loader = {
1515
options: Record<string, any>;
1616
};
1717

18+
type LoadersWrapper = {
19+
rule: {
20+
test: RegExp;
21+
[key: string]: any;
22+
};
23+
ruleIndex: number;
24+
loaders: string | (string | Loader)[];
25+
};
26+
1827
type LoaderWrapper = {
1928
rule: {
2029
test: RegExp;
2130
[key: string]: any;
2231
};
2332
ruleIndex: number;
24-
loader: Loader;
33+
loader: string | Loader;
2534
loaderIndex: number;
2635
};
2736

@@ -83,7 +92,7 @@ export type Helpers = {
8392
/**
8493
* Returns wrapper around all loaders from config
8594
*/
86-
getLoaders(config: Config): LoaderWrapper[];
95+
getLoaders(config: Config): LoadersWrapper[];
8796

8897
/**
8998
* Returns wrapper around all loaders that match provided name

0 commit comments

Comments
 (0)