# egg-spark

**Repository Path**: mirrors_eggjs/egg-spark

## Basic Information

- **Project Name**: egg-spark
- **Description**: Streaming rendering plugin for eggjs.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-02-23
- **Last Updated**: 2026-03-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# egg-spark

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-spark.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-spark
[travis-image]: https://img.shields.io/travis/eggjs/egg-spark.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-spark
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-spark.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-spark?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-spark.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-spark
[snyk-image]: https://snyk.io/test/npm/egg-spark/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-spark
[download-image]: https://img.shields.io/npm/dm/egg-spark.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-spark

egg 流式渲染插件。

## 依赖说明

### 依赖的 egg 版本

egg-spark 版本 | egg 1.x
--- | ---
1.x | 😁
0.x | ❌

### 依赖的插件
无

## 开启插件

```js
// {app_root}/config/plugin.js
exports.spark = {
  enable: true,
  package: 'egg-spark',
};
```

## 使用场景

- 对于后端渲染的页面，开启流式渲染来减少 ttfb 以获取首屏性能的提升
- 如何使用：
    ```js
    // {app_root}/controller/admin.js
    module.exports = app => class AdminController extends app.Controller {
      async index() {
        // 调用 spark.render 方法，传入要渲染的模板地址
        this.ctx.spark.render('admin/index.nj', {
          // regList 是一个用来切分页面的正则列表，根据 regList 的长度将页面切分为 regList.length+1 份
          regList: [/<!--\s*?spark:split\s*?-->/],
          // dataList：根据 regList 切分的页面块，来传入对应的渲染模板需要的数据。可以传入数据 object ，也可以传入同步或者异步的数据方法
          dataList: [
            mergerCommonContext({}, this.ctx),
            async () => getPageData.call(this),
          ],
        });
    
        async function getPageData() {
          const { id, ...others } = this.ctx.query || {};
          const userInfo = await this.service.getUserInfo(id);
          // Your Business logic 
          const pageData = {
            userInfo,
            ...others
          };
          return mergerCommonContext({ pageData }, this.ctx);
        }
      }
    };
    ```

## 详细配置

请到 [config/config.default.js](config/config.default.js) 查看详细配置项说明。


## License

[MIT](LICENSE)