RenderToNodeStream docs don't match actual API

rookLab / react-component-caching

Speedier server-side rendering with component caching in React 16

388 stars 26 forks source link

RenderToNodeStream docs don't match actual API #42

Closed kylepotts closed 5 years ago

kylepotts commented 6 years ago

renderToNodeStream

component: The React component being rendered
cache: The component cache object
res: The response object that Express provides
htmlStart: Start of html markup in string form
htmlEnd: End of html markup in string form
memLife: (Only if using Memcached) An integer representing the lifetime (in seconds) of each Memcached entry. Defaults to 0.

https://github.com/rookLab/react-component-caching/blob/master/src/server/ReactDOMNodeStreamRenderer.js#L102

Any plans to update that? I've got custom html properties I want to inject instead of what is being added now.

daviddt commented 6 years ago

Hi @kylepotts, i'm not sure if the author is still active but I created a pull request to fix this

https://github.com/rookLab/react-component-caching/pull/45

mejincodes commented 6 years ago

Thanks for taking care of this, David. You're right that most of us haven't been active anymore - we've talked about coming back to it but other priorities have pulled us in other directions, so it's likely it won't happen anytime soon. Happy to pass the baton to whoever is up to it.

daviddt commented 6 years ago

Thank you! I love the library, and you and the team did a great job already. I’m currently working on implementing this as a proof of concept within our application. If it’s a success you’ll definitely see more contributions coming from our side :) we are a team of about 20 front end developers! So I’m pretty sure we can collaborate to bring some value to this cool project.