# react-asyncmodule-tool

> react asyncmodule tool

Latest version **1.1.0** (published 2020-04-02) · 0 weekly downloads

## Install

```sh
npm install react-asyncmodule-tool
pnpm add react-asyncmodule-tool
yarn add react-asyncmodule-tool
bun add react-asyncmodule-tool
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2020-04-02 |
| First published | 2018-09-10 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6.2.0 |
| Dependencies | 1 |
| Unpacked size | 33.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | caoren |
| Maintainers | caor1987 |
| Keywords | react, asyncmodule, tool |

## Links

- npm: https://www.npmjs.com/package/react-asyncmodule-tool
- Repository: https://github.com/caoren/react-asyncmodule
- Issues: https://github.com/caoren/react-asyncmodule/issues
- npm.io page: https://npm.io/package/react-asyncmodule-tool

## Dependencies (1)

- [react-asyncmodule](https://npm.io/package/react-asyncmodule.md) ^1.1.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2020-04-02
- 1.2.0-beta.6 (beta) — 2021-03-12
- 1.2.0-beta.5 — 2021-03-09
- 1.2.0-beta.4 — 2021-02-02
- 1.2.0-beta.3 — 2021-01-25
- 1.2.0-beta.2 — 2021-01-05
- 1.2.0-beta.1 — 2020-12-30
- 1.2.0-beta.0 — 2020-12-26
- 1.2.0-alpha.5 — 2020-10-25
- 1.2.0-alpha.4 — 2020-05-21
- 1.2.0-alpha.3 — 2020-05-19
- 1.2.0-alpha.2 — 2020-05-14
- 1.2.0-alpha.1 — 2020-05-14
- 1.2.0-alpha.0 — 2020-04-16
- 1.1.0-alpha.2 — 2020-04-01
- … 6 more at https://npm.io/package/react-asyncmodule-tool/versions

## README

# react-asyncmodule-tool

react-asyncmodule related method.

# Installation

```javascript
npm install react-asyncmodule-tool
```

Es6 used.

```javascript
import {
    createCollect,
    createAssets,
    getChunkAssets
} from 'react-asyncmodule-tool';
```


## API

### createCollect(options)

options的属性

| Name           | Type       | Default | Description         |
| -------------- | ---------- | ------- | ------------------- |
| chunkName      | `string` or `array` | -  | 当前 chunk 的名称，根据该值获取对应的资源文件，若为空则返回入口相关资源  |
| stats          | `object`         | -   | 必填，webpack 构建生成的 stats，推荐使用 [webpack-stats-plugin](https://github.com/FormidableLabs/webpack-stats-plugin)提取  |
| outputPath     | `string`              |  stats 的 outputPath | 工程构建后 client 端的资源文件路径 |
| entrypoints    | `string` or `array`   |  工程的 entry           | 入口文件  |
| asyncChunkKey  | `string` |     -      |  client 端获取依赖 chunk 的 domid  |
| runtimeName    |  `string` or `array`  | 'runtime'  | 从入口文件分离出的 runtime js文件 |

```javascript
const collect = createCollect({
    stats,
    chunkName: 'home'
});

collect.getScripts(); // 返回 chunk 所需的脚本，含 async
collect.getStyles(); // 返回 chunk 所需的样式
collect.getInlineStyles().then((data) => { // 返回内联的样式
    console.log(data);
});
```

runtimeName一般不需要配置，使用默认值即可，如果有修改，则需要传入对应的 runtimeChunk 的名称，有多个 runtimeChunk 则传入数组，具体说明详见[webpack runtime](https://webpack.docschina.org/configuration/optimization/#optimization-runtimechunk)。

### createAssets(chunks, publicPath)

Serialized resource path based on the webpack's chunks

```javascript
const assets = createAssets(stats);
// output
{
    a: {
        js: ['/public/a.js'],
        css: ['/public/a.css']
    },
    b: {
        js: ['/public/common.js', '/public/b.js'],
        css: ['/public/common.css', '/public/b.css']
    }
}
```


### getChunkAssets(assets, chunkName)

Output `chunkNames` according to [matchRoutes](https://github.com/ReactTraining/react-router/tree/master/packages/react-router-config#matchroutesroutes-pathname).

```javascript
getChunkAssets({
   a: {
       js: ['/public/a.js'],
       css: ['/public/a.css']
   },
   b: {
       js: ['/public/common.js', '/public/b.js'],
       css: ['/public/common.css', '/public/b.css']
   }
}, 'a');

// output

{
   js: '<script type="text/javascript" src="/public/a.js"></script>',
   css: '<link href="/public/a.css" rel="stylesheet">'
}
```

---
_Source: https://npm.io/package/react-asyncmodule-tool · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._