Skip to content

Commit

Permalink
Documentation: added info about streaming character encoding. (#10039)
Browse files Browse the repository at this point in the history
  • Loading branch information
aickin authored and gaearon committed Jun 26, 2017
1 parent c01d306 commit 167f54c
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/docs/reference-react-dom-node-stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Render a React element to its initial HTML. This should only be used in Node.js;

If you call [`ReactDOM.render()`](/react/docs/react-dom.html#render) on a node that already has this server-rendered markup, React will preserve it and only attach event handlers, allowing you to have a very performant first-load experience.

Note that the stream returned from this method will return a byte stream encoded in utf-8. If you need a stream in another encoding, take a look a project like [iconv-lite](https://www.npmjs.com/package/iconv-lite), which provides transform streams for transcoding text.

* * *

### `renderToStaticStream()`
Expand All @@ -40,3 +42,5 @@ ReactDOMNodeStream.renderToStaticStream(element)
```

Similar to [`renderToStream`](#rendertostream), except this doesn't create extra DOM attributes such as `data-reactid`, that React uses internally. This is useful if you want to use React as a simple static page generator, as stripping away the extra attributes can save lots of bytes.

Note that the stream returned from this method will return a byte stream encoded in utf-8. If you need a stream in another encoding, take a look a project like [iconv-lite](https://www.npmjs.com/package/iconv-lite), which provides transform streams for transcoding text.

0 comments on commit 167f54c

Please sign in to comment.