Add stream package with drain & waitUntilFinished (#19)

packages/stream/.npmignore

@@ -0,0 +1,3 @@
+src/
+**/__tests__/
+tsconfig.json

packages/stream/README.md

@@ -0,0 +1,27 @@
+# @kanziw/stream
+
+[![npm version](https://img.shields.io/npm/v/@kanziw/stream)](https://www.npmjs.com/package/@kanziw/stream)
+[![license](https://img.shields.io/npm/l/@kanziw/stream)](https://www.npmjs.com/package/@kanziw/stream)
+[![npm downloads](https://img.shields.io/npm/dt/@kanziw/stream)](https://www.npmjs.com/package/@kanziw/stream)
+
+
+## drain
+
+Drain stream
+
+```ts
+import { drain } from '@kanziw/stream'
+
+const buf = await drain(someStream)
+```
+
+
+## waitUntilFinished
+
+Wait until stream finished
+
+```ts
+import { waitUntilFinished } from '@kanziw/stream'
+
+await waitUntilFinished(someStream)
+```

packages/stream/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@kanziw/stream",
+  "version": "0.1.0",
+  "description": "A collection of utility libraries about stream",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kanziw/kanziwjs.git",
+    "directory": "packages/stream"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/kanziw/kanziwjs/tree/main/packages/stream#readme",
+  "keywords": [
+    "stream",
+    "kanziw",
+    "drain"
+  ],
+  "author": {
+    "name": "Jiwoong Jung",
+    "email": "kanziwoong@gmail.com"
+  },
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "packageManager": "yarn@3.2.0",
+  "scripts": {
+    "lint": "yarn workspace kanziwjs eslint packages/stream",
+    "clean": "rimraf lib",
+    "build": "yarn clean && yarn tsc",
+    "publish": "yarn build && yarn publish-if-not-published"
+  },
+  "devDependencies": {
+    "@types/node": "^17.0.25",
+    "publish-if-not-published": "^3.1.2",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.6.3"
+  },
+  "license": "MIT"
+}

packages/stream/src/drain.ts

@@ -0,0 +1,10 @@
+import { Stream } from 'stream'
+
+export const drain = async(stream: Stream): Promise<Buffer> => {
+  const bufs: Uint8Array[] = []
+
+  return new Promise<Buffer>(resolve => {
+    stream.on('data', chunk => bufs.push(chunk))
+    stream.on('end', () => resolve(Buffer.concat(bufs)))
+  })
+}

packages/stream/src/index.ts

@@ -0,0 +1,2 @@
+export * from './drain'
+export * from './waitUntilFinished'

packages/stream/src/waitUntilFinished.ts

@@ -0,0 +1,8 @@
+import { Stream } from 'stream'
+
+export const waitUntilFinished = (stream: Stream) => (
+  new Promise((resolve, reject) => {
+    stream.on('finish', resolve)
+    stream.on('error', reject)
+  })
+)

packages/stream/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "lib",
+  },
+  "include": [
+    "src"
+  ]
+}

yarn.lock

@@ -2010,6 +2010,17 @@ __metadata:
   languageName: unknown
   linkType: soft
 
+"@kanziw/stream@workspace:packages/stream":
+  version: 0.0.0-use.local
+  resolution: "@kanziw/stream@workspace:packages/stream"
+  dependencies:
+    "@types/node": ^17.0.25
+    publish-if-not-published: ^3.1.2
+    rimraf: ^3.0.2
+    typescript: ^4.6.3
+  languageName: unknown
+  linkType: soft
+
 "@kanziw/time@workspace:packages/time":
   version: 0.0.0-use.local
   resolution: "@kanziw/time@workspace:packages/time"