Code Monkey home page Code Monkey logo

egg-spark's Introduction

egg-spark

NPM version build status Test coverage David deps Known Vulnerabilities npm download

Streaming rendering plugin for eggjs.

Install

$ npm i egg-spark --save

Usage

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

Example

    // {app_root}/controller/admin.js
    module.exports = app => class AdminController extends app.Controller {
      async index() {
        // Call the spark.render method and pass in the path of the template to be rendered 
        this.ctx.spark.render('admin/index.nj', {
          // regList is a regular list used to split pages. According to the length of regList, the page is split into regList.length+1 
          regList: [/<!--\s*?spark:split\s*?-->/],
          // dataList:According to the page blocks segmented by regList, the data required by the corresponding rendering template is passed in. 
          // You can pass in a data object, or you can pass in a synchronous or asynchronous data method 
          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);
        }
      }
    };

Questions & Suggestions

Please open an issue here.

License

MIT

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.