Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,16 @@ app.get('/api/users', (req, res, next) => {
});
```

## Practical Example with Koa + Koa Router + Mongoose

```javascript
app.get('/api/users', (ctx) => {
ctx.type = 'json'; // Required for proper handling by test frameworks and some clients
ctx.body = new JsonStreamStringify(Users.find().stream());
});
```


### Why do I not get proper typings? (Missing .on(...), etc.)

install ``@types/readable-stream`` or ``@types/node`` or create your own ``stream.d.ts`` that exports a ``Readable`` class.
Expand Down