Merge pull request #38 from DenisFrezzato/stream

DenisFrezzato · Jun 2, 2021 · 48adfbf · 48adfbf
2 parents ddcf62e + 4f9b54f
commit 48adfbf
Show file tree

Hide file tree

Showing 8 changed files with 736 additions and 57 deletions.
diff --git a/docs/modules/express.ts.md b/docs/modules/express.ts.md
@@ -27,6 +27,7 @@ Added in v0.5.0
     - [setHeader (method)](#setheader-method)
     - [setStatus (method)](#setstatus-method)
     - [setBody (method)](#setbody-method)
+    - [pipeStream (method)](#pipestream-method)
     - [endResponse (method)](#endresponse-method)
     - [\_S (property)](#_s-property)
   - [fromRequestHandler](#fromrequesthandler)
@@ -184,6 +185,16 @@ setBody(body: unknown): ExpressConnection<ResponseEnded>
 
 Added in v0.5.0
 
+### pipeStream (method)
+
+**Signature**
+
+```ts
+pipeStream(stream: Readable): ExpressConnection<ResponseEnded>
+```
+
+Added in v0.6.2
+
 ### endResponse (method)
 
 **Signature**

diff --git a/docs/modules/index.ts.md b/docs/modules/index.ts.md
@@ -72,6 +72,7 @@ Added in v0.5.0
   - [middleware](#middleware)
   - [modifyConnection](#modifyconnection)
   - [orElse](#orelse)
+  - [pipeStream](#pipestream)
   - [redirect](#redirect)
   - [right](#right)
   - [rightIO](#rightio)
@@ -129,6 +130,7 @@ export interface Connection<S> {
   readonly setHeader: (this: Connection<HeadersOpen>, name: string, value: string) => Connection<HeadersOpen>
   readonly setStatus: (this: Connection<StatusOpen>, status: Status) => Connection<HeadersOpen>
   readonly setBody: (this: Connection<BodyOpen>, body: unknown) => Connection<ResponseEnded>
+  readonly pipeStream: (this: Connection<BodyOpen>, stream: Readable) => Connection<ResponseEnded>
   readonly endResponse: (this: Connection<BodyOpen>) => Connection<ResponseEnded>
 }
 ```
@@ -908,6 +910,18 @@ export declare function orElse<E, I, O, M, A>(
 
 Added in v0.5.0
 
+## pipeStream
+
+Returns a middleware that pipes a stream to the response object.
+
+**Signature**
+
+```ts
+export declare function pipeStream<E>(stream: Readable): Middleware<BodyOpen, ResponseEnded, E, void>
+```
+
+Added in v0.6.2
+
 ## redirect
 
 Returns a middleware that sends a redirect to `uri`