Commit 74d64d8

authored

Update README.md

1 parent 0a146eb commit 74d64d8Copy full SHA for 74d64d8

File tree

1 file changed

+13

-3

lines changed

README.md

1 file changed

+13

-3

lines changed

`‎README.md‎`

Lines changed: 13 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -59,6 +59,16 @@ export default class App extends Component {`
`59`	`59`	`}`
`60`	`60`	`// ...`
`61`	`61`	```
	`62`	`+## Streaming HTML Markup`
	`63`	`+To use streaming on the server side, use either the renderToStaticNodeStream or renderToNodeStream. Both streaming option works with caching, but not yet compatible with templatization. To use the streaming functions, simply pass in these 5 arguments:`
	`64`	`+(`
	`65`	+`component`: The React component being rendered
	`66`	+`cache`: The component cache object
	`67`	+`res`: The response object that Express provides
	`68`	+`htmlStart`: Start of html markup in string form
	`69`	+`htmlEnd`: End of html markup in string form
	`70`	`+).`
	`71`	`+The benefit that comes with streaming is faster time to first byte, which translates to faster viewing of page content.`
`62`	`72`
`63`	`73`	`## Cache Options`
`64`	`74`	`React Component Caching provides its own cache implementation as well as support for Redis and Memcached. Simply create your preferred cache and pass it into one of the rendering methods.`
`@@ -98,7 +108,7 @@ ReactCC.renderToString(<App />, cache, 1000);`
`98`	`108`
`99`	`109`	`## API`
`100`	`110`
`101`		`-### ReactCC`
	`111`	`+### React Component Caching`
`102`	`112`	`React Component Caching gives you access to all four of React 16's server-side rendering methods, as well as additional functionality. Available methods are described below.`
`103`	`113`
`104`	`114`	`### ComponentCache`
`@@ -131,7 +141,7 @@ ReactCC.renderToStaticMarkup(<App />, cache);`
`131`	`141`
`132`	`142`	`### renderToNodeStream`
`133`	`143`	- `component`: The React component being rendered
`134`		-- `cache`: The component cache
	`144`	+- `cache`: The component cache object
`135`	`145`	- `res`: The response object that Express provides
`136`	`146`	- `htmlStart`: Start of html markup in string form
`137`	`147`	- `htmlEnd`: End of html markup in string form
`@@ -146,7 +156,7 @@ ReactCC.renderToNodeStream(<App />, cache, res, htmlStart, htmlEnd);`
`146`	`156`
`147`	`157`	`### renderToStaticNodeStream`
`148`	`158`	- `component`: The React component being rendered
`149`		-- `cache`: The component cache
	`159`	+- `cache`: The component cache object
`150`	`160`	- `res`: The response object that Express provides
`151`	`161`	- `htmlStart`: Start of html markup in string form
`152`	`162`	- `htmlEnd`: End of html markup in string form

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 74d64d8

File tree

1 file changed

1 file changed

`‎README.md‎`

0 commit comments