https://github.com/jonathanong/pipe
Streaming and async template rendering for node.js using template strings
https://github.com/jonathanong/pipe
async streaming tagged-template tagged-template-literal tagged-template-literals template-engine
Last synced: 6 months ago
JSON representation
Streaming and async template rendering for node.js using template strings
- Host: GitHub
- URL: https://github.com/jonathanong/pipe
- Owner: jonathanong
- License: mit
- Created: 2020-05-02T08:17:58.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-09-25T01:29:01.000Z (about 2 years ago)
- Last Synced: 2025-03-28T18:50:20.884Z (6 months ago)
- Topics: async, streaming, tagged-template, tagged-template-literal, tagged-template-literals, template-engine
- Language: JavaScript
- Homepage:
- Size: 624 KB
- Stars: 13
- Watchers: 0
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @jongleberry/pipe
[](https://github.com/jonathanong/pipe/actions?query=workflow%3A%22Node.js+CI%22+event%3Apush+branch%3Amaster)
[](https://codecov.io/gh/jonathanong/pipe)
Streaming and async template rendering for node.js using template strings.
Define variables or sections as promises or streams or thunks that return either in your template,
and they will be evaluated at render time.
This allows you to create fast, non-blocking server-side rendered applications while minimizing time-to-first-byte for the user.
## Example
```js
const pipe = require('@jongleberry/pipe')
const render = function ({
currentUser
}) {
return pipe`
Example
${async () => React.renderToNodeStream(React.createElement(App, {
currentUser: await currentUser,
}))}
window.__INITIAL_STATE__ = ${async () => JSON.stringify({
currentUser: await currentUser,
})}
<script src='entrypoint.js>
`
}
// express middleware
function (req, res) {
res.setHeader('content-type', 'text/html; charset=utf-8')
res.flushHeaders()
render({
// pass a promise that resolves to the user
getCurrentUser: services.getCurrentUser(req)
}).pipe(res)
}
```
## API
### stream = pipe`` || pipe(strings, ...values)
`render` is a [tagged template](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#Tagged_templates) that returns a [readable PassThrough stream](https://nodejs.org/api/stream.html#stream_class_stream_passthrough).
### Value Types
- `` - serialize anything that isn't a string yourself as this library will throw.
- `Promise` - a promise that returns a string.
- `Stream` - a binary stream that will be pipe directly into the response. This library does not check its contents, but object streams will throw: pipe it into a stream such as [streaming-json-stringify](https://www.npmjs.com/package/streaming-json-stringify).
- A function or async function that returns either of the above.
### Error Handling
Any section of the template that errors will simply not be rendered.
Streams may partially be rendered, so it's advised that you handle stream errors yourself or pass streams that cannot error (e.g. a passthrough stream).
Listen to any errors on the resulting stream, e.g.:
```js
const stream = pipe`
${async () => React.renderToNodeStream(React.createElement(App, {
currentUser: await currentUser
}))}`
stream.on('error', err => console.error(err.stack))
```
Some frameworks such as Koa automatically handle this when you set the stream as `ctx.body = stream`
Note that because status codes (or should be) flushed to the client before rendering begins, errors in the template cannot affect the response status code.
### Implementation Notes
- You will probably have to set the content type header yourself
- For compression, be sure to use the [zlib.constants.Z_SYNC_FLUSH](https://nodejs.org/api/zlib.html#zlib_zlib_constants) flag
- You may want to [`res.flushHeaders()`](https://nodejs.org/api/http.html#http_request_flushheaders)
## Alternatives
- A cleaner version of https://github.com/almost/stream-template
- `stream-template` recreates a readable stream from scratch whereas this library relies on passthrough streams `.pipe()`.
For simplicity, `pipe` does not support backpressure
- A simpler API of https://github.com/matthewp/flora
- `pipe` does not require any other utilities
- A simpler, reduced-scope version of https://github.com/popeindustries/lit-html-server
- `pipe` does not support arrays - it's not difficult to call `.join('')`
- `pipe` does not require any other utilities
- `pipe` does not provide any helper functions for streams
- `pipe` does not work on the browser
Please let me know if you are aware of any other ones.