feat(utils): export some useful pipe-related util functions

README.md

@@ -174,6 +174,16 @@ for inline documentation and types.
 -   `async geDisk(name: string, options: DiskManagerOptions): Disk` to get a disk by name (allowing
     for aliases in config).
 
+### Utils
+
+This library also exports some helper methods:
+
+-   `async pipeStreams(readable: Readable, writable: Writable): Promise<string>` pipes a readable stream into a
+    writable stream and waits until it completes. It will reject if the pipe stream emits an error and will otherwise
+    resolve with the name of the event that the stream closed with (i.e. `'close'` or `'finish'`).
+-   `async streamToBuffer(stream: Readable): Promise<Buffer>` pipes a readable stream into a single buffer. Rejects if
+    the stream emits an error.
+
 ## TODO
 
 -   [ ] Make the `MemoryDisk` test generic to run on any `Disk` and figure out how to run it safely with `LocalDisk`

src/index.ts

@@ -5,13 +5,13 @@ export * from './lib/types';
 export * from './lib/fs/types';
 export * from './lib/DiskManager';
 export * from './lib/Disk';
+export { pipeStreams, streamToBuffer } from './lib/utils';
 export * from './drivers/s3/S3Disk';
 export * from './drivers/s3/types';
 export * from './drivers/local/LocalDisk';
 export * from './drivers/local/types';
 export * from './drivers/memory/MemoryDisk';
 export * from './errors'
-export * from './'
 
 // Kept around for backwards compatibility.
 export const errors = allErrors;