archive-gh-me/loadable-components
1
0
Fork 0
mirror of https://github.com/gregberge/loadable-components.git synced 2026-01-25 15:24:15 +00:00
Code Issues Projects Releases Wiki Activity

docs: fix webpack api doc

Browse Source
This commit is contained in:
Greg Bergé 2019-01-17 10:16:27 +01:00
parent 4a6f84fe9f
commit b6f4e838a8
2 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
packages/webpack-plugin/README.md
View File

@ -26,12 +26,12 @@ module.exports = {
Create a webpack loadable plugin.
| Arguments | Description |
| --------------------- | ------------------------------------------------- |
| `options` | Optional options |
| `options.filename` | Stats filename (default to `loadable-stats.json`) |
| `options.path` | Stats file path (default to webpack config `output.path`) |
| `options.writeToDisk` | Always write assets to disk (default to `false`) |
| Arguments | Description |
| ------------------------------ | ----------------------------------------------------------------------------------- |
| `options` | Optional options |
| `options.filename` | Stats filename (default to `loadable-stats.json`) |
| `options.writeToDisk` | Accepts `boolean` or `object`. Always write stats file to disk. Default to `false`. |
| `options.writeToDisk.filename` | Write assets to disk at given `filename` location |
```js
new LoadablePlugin({ filename: 'stats.json', writeToDisk: true })

10
website/src/pages/docs/api-loadable-webpack-plugin.mdx
View File

@ -10,10 +10,12 @@ order: 30
Create a webpack loadable plugin.
| Arguments | Description |
| ------------------------------ | ------------------------------------------------- |
| `options` | Optional options |
| `options.writeToDisk.filename` | Write assets to disk at given `filename` location |
| Arguments | Description |
| ------------------------------ | ----------------------------------------------------------------------------------- |
| `options` | Optional options |
| `options.filename` | Stats filename (default to `loadable-stats.json`) |
| `options.writeToDisk` | Accepts `boolean` or `object`. Always write stats file to disk. Default to `false`. |
| `options.writeToDisk.filename` | Write assets to disk at given `filename` location |
```js
new LoadablePlugin({ filename: 'stats.json', writeToDisk: true })