Skip to content

Commit

Permalink
fix: support ReadableStream in res.send()
Browse files Browse the repository at this point in the history
  • Loading branch information
cmorten committed Aug 27, 2022
1 parent f976e55 commit b6f175f
Show file tree
Hide file tree
Showing 12 changed files with 40 additions and 32 deletions.
12 changes: 6 additions & 6 deletions .github/API/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The `app` object conventionally denotes the Opine application. Create it by
calling the top-level `opine()` function exported by the Opine module:

```ts
import opine from "https://deno.land/x/opine@2.3.2/mod.ts";
import opine from "https://deno.land/x/opine@2.3.3/mod.ts";

const app = opine();

Expand Down Expand Up @@ -69,7 +69,7 @@ sub-app was mounted.
> to a route.
```ts
import opine from "https://deno.land/x/opine@2.3.2/mod.ts";
import opine from "https://deno.land/x/opine@2.3.3/mod.ts";

const app = opine(); // the main app
const admin = opine(); // the sub app
Expand Down Expand Up @@ -487,7 +487,7 @@ starts listening for requests - this is provided for legacy reasons to aid in
transitions from Express on Node.

```ts
import opine from "https://deno.land/x/opine@2.3.2/mod.ts";
import opine from "https://deno.land/x/opine@2.3.3/mod.ts";

const app = opine();

Expand Down Expand Up @@ -523,7 +523,7 @@ This method is supported for legacy reasons to aid in transitions from Express
on Node.

```ts
import opine from "https://deno.land/x/opine@2.3.2/mod.ts";
import opine from "https://deno.land/x/opine@2.3.3/mod.ts";

const app = opine();
const PORT = 3000;
Expand All @@ -542,7 +542,7 @@ starts listening for requests - this is provided for legacy reasons to aid in
transitions from Express on Node.

```ts
import opine from "https://deno.land/x/opine@2.3.2/mod.ts";
import opine from "https://deno.land/x/opine@2.3.3/mod.ts";

const app = opine();

Expand All @@ -560,7 +560,7 @@ starts listening for requests - this is provided for legacy reasons to aid in
transitions from Express on Node.

```ts
import opine from "https://deno.land/x/opine@2.3.2/mod.ts";
import opine from "https://deno.land/x/opine@2.3.3/mod.ts";

const app = opine();

Expand Down
8 changes: 4 additions & 4 deletions .github/API/middlewares.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ reasons.
> `toString` may not be a function and instead a string or other user-input.
```ts
import { json, opine } from "https://deno.land/x/opine@2.3.2/mod.ts";
import { json, opine } from "https://deno.land/x/opine@2.3.3/mod.ts";

const app = opine();

Expand Down Expand Up @@ -77,7 +77,7 @@ reasons.
> recommended.
```ts
import { opine, raw } from "https://deno.land/x/opine@2.3.2/mod.ts";
import { opine, raw } from "https://deno.land/x/opine@2.3.3/mod.ts";

const app = opine();

Expand Down Expand Up @@ -230,7 +230,7 @@ reasons.
> recommended.
```ts
import { opine, text } from "https://deno.land/x/opine@2.3.2/mod.ts";
import { opine, text } from "https://deno.land/x/opine@2.3.3/mod.ts";

const app = opine();

Expand Down Expand Up @@ -277,7 +277,7 @@ reasons.
> `toString` may not be a function and instead a string or other user-input.
```ts
import { opine, urlencoded } from "https://deno.land/x/opine@2.3.2/mod.ts";
import { opine, urlencoded } from "https://deno.land/x/opine@2.3.3/mod.ts";

const app = opine();

Expand Down
4 changes: 2 additions & 2 deletions .github/API/opine.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ Creates an Opine application. The `opine()` function is a top-level function
exported by the Opine module:

```ts
import opine from "https://deno.land/x/opine@2.3.2/mod.ts";
import opine from "https://deno.land/x/opine@2.3.3/mod.ts";

const app = opine();
```

The `opine()` function is also exported as a named export:

```ts
import { opine } from "https://deno.land/x/opine@2.3.2/mod.ts";
import { opine } from "https://deno.land/x/opine@2.3.3/mod.ts";

const app = opine();
```
4 changes: 2 additions & 2 deletions .github/API/request.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ import {
json,
opine,
urlencoded,
} from "https://deno.land/x/opine@2.3.2/mod.ts";
} from "https://deno.land/x/opine@2.3.3/mod.ts";

const app = opine();

Expand All @@ -118,7 +118,7 @@ The following example shows how to implement your own simple body-parsing
middleware to transform `req.body` into a raw string:

```ts
import opine from "https://deno.land/x/opine@2.3.2/mod.ts";
import opine from "https://deno.land/x/opine@2.3.3/mod.ts";

import { readAll } from "https://deno.land/std@0.120.0/streams/conversion.ts";

Expand Down
4 changes: 2 additions & 2 deletions .github/API/router.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Opine has a top-level named function export `Router()` that creates a new
`router` object.

```ts
import { Router } from "https://deno.land/x/opine@2.3.2/mod.ts";
import { Router } from "https://deno.land/x/opine@2.3.3/mod.ts";

const router = Router(options);
```
Expand Down Expand Up @@ -260,7 +260,7 @@ function defined and work their way "down" the middleware stack processing for
each path they match.

```ts
import opine, { Router } from "https://deno.land/x/opine@2.3.2/mod.ts";
import opine, { Router } from "https://deno.land/x/opine@2.3.3/mod.ts";

const app = opine();
const router = Router();
Expand Down
4 changes: 4 additions & 0 deletions .github/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# ChangeLog

## [2.3.3] - 27-08-2022

- fix: support `ReadableStream` in `res.send()`

## [2.3.2] - 27-08-2022

- fix: replace `Deno.statSync` with `Deno.stat` to allow views to be used on Deno Deploy
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Express not working for you? [Raise an issue on Deno](https://github.com/denolan
## Getting Started

```ts
import { opine } from "https://deno.land/x/opine@2.3.2/mod.ts";
import { opine } from "https://deno.land/x/opine@2.3.3/mod.ts";

const app = opine();

Expand All @@ -75,14 +75,14 @@ Before importing, [download and install Deno](https://deno.land/#installation).
You can then import Opine straight into your project:

```ts
import { opine } from "https://deno.land/x/opine@2.3.2/mod.ts";
import { opine } from "https://deno.land/x/opine@2.3.3/mod.ts";
```

Opine is also available on [nest.land](https://nest.land/package/opine), a
package registry for Deno on the Blockchain.

```ts
import { opine } from "https://x.nest.land/opine@2.3.2/mod.ts";
import { opine } from "https://x.nest.land/opine@2.3.3/mod.ts";
```

## Features
Expand Down
6 changes: 3 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ <h2>Table of Contents</h2>
<a href="#getting-started" id="getting-started" style="color: inherit; text-decoration: none;">
<h2>Getting Started</h2>
</a>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/opine@2.3.2/mod.ts&quot;</span>;
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/opine@2.3.3/mod.ts&quot;</span>;

<span class="hljs-keyword">const</span> app = opine();

Expand All @@ -130,11 +130,11 @@ <h2>Installation</h2>
repo and via the <a href="https://deno.land/x">Deno Registry</a>.</p>
<p>Before importing, <a href="https://deno.land/#installation">download and install Deno</a>.</p>
<p>You can then import Opine straight into your project:</p>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/opine@2.3.2/mod.ts&quot;</span>;
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://deno.land/x/opine@2.3.3/mod.ts&quot;</span>;
</code></pre>
<p>Opine is also available on <a href="https://nest.land/package/opine">nest.land</a>, a
package registry for Deno on the Blockchain.</p>
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://x.nest.land/opine@2.3.2/mod.ts&quot;</span>;
<pre><code class="language-ts"><span class="hljs-keyword">import</span> { opine } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;https://x.nest.land/opine@2.3.3/mod.ts&quot;</span>;
</code></pre>
<a href="#features" id="features" style="color: inherit; text-decoration: none;">
<h2>Features</h2>
Expand Down
2 changes: 1 addition & 1 deletion egg.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "opine",
"description": "Minimalist web framework for Deno ported from ExpressJS.",
"version": "2.3.2",
"version": "2.3.3",
"repository": "https://github.com/cmorten/opine",
"stable": true,
"checkFormat": false,
Expand Down
9 changes: 4 additions & 5 deletions src/response.ts
Original file line number Diff line number Diff line change
Expand Up @@ -244,9 +244,7 @@ export class Response implements OpineResponse {
* @return {Promise<void>}
* @public
*/
async end(
body?: DenoResponseBody,
): Promise<void> {
async end(body?: DenoResponseBody): Promise<void> {
if (body) {
this.body = body;
}
Expand Down Expand Up @@ -678,9 +676,10 @@ export class Response implements OpineResponse {
default:
if (
body instanceof Uint8Array ||
typeof (body as Deno.Reader).read === "function"
typeof (body as Deno.Reader).read === "function" ||
typeof (body as ReadableStream).getReader === "function"
) {
chunk = body as Uint8Array | Deno.Reader;
chunk = body as Uint8Array | Deno.Reader | ReadableStream;

if (!this.get("Content-Type")) {
this.type("bin");
Expand Down
11 changes: 8 additions & 3 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,12 @@ export type HTTPSOptions = Omit<
"transport"
>;

export type DenoResponseBody = undefined | string | Uint8Array | Deno.Reader;
export type DenoResponseBody =
| undefined
| string
| Uint8Array
| Deno.Reader
| ReadableStream;
export type ResponseBody =
| null
| undefined
Expand Down Expand Up @@ -613,7 +618,7 @@ export interface OpineRequest<
status?: number;
statusText?: string;
headers?: Headers;
body?: Uint8Array | Deno.Reader | string;
body?: Uint8Array | Deno.Reader | string | ReadableStream;
trailers?: () => Promise<Headers> | Headers;
}): void;

Expand All @@ -638,7 +643,7 @@ export interface OpineResponse<ResBody = any> extends Opine.Response {
status?: number;
statusText?: string;
headers?: Headers;
body?: Uint8Array | Deno.Reader | string;
body?: Uint8Array | Deno.Reader | string | ReadableStream;

app: Application;

Expand Down
2 changes: 1 addition & 1 deletion version.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* Version of Opine.
*/
export const VERSION = "2.3.2";
export const VERSION = "2.3.3";

/**
* Supported version of Deno.
Expand Down

0 comments on commit b6f175f

Please sign in to comment.