Git Product home page Git Product logo

koa2-streaming-react-render's Introduction

Koa2 react 16+ streaming render helper

Very tiny, zero dependencies

Why ?

Because React server side streaming render can be tricky with koa2.

Install

npm i --save koa2-streaming-react-render

Use

const {renderToNodeStream} = require('react-dom/server');
const render = require('koa2-streaming-react-render');

koa.use(async (ctx) => {
  const component = ...;
  const stream = renderToNodeStream(yourComponent);

  return render(
    ctx,
    '<html><head></head><body>', // head of document
    stream, // streaming body of document
    '</body></html>', // document tail
    { // options optional
      onStats: (stats) => {
        // here you can get responseSize, size and render time values
      }
    }
  );
});

Examples

see under "examples" directory

Test

npm install
npm test

Faq

What will happen if an error occurs through react rendering process? How do I handle that?

Don't worry, you are covered. If an error occurs while render, it will follow standard koa2 error handling middleware

koa2-streaming-react-render's People

Contributors

andrewgrachov avatar budarin avatar dependabot[bot] avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

budarin

koa2-streaming-react-render's Issues

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.