@prairielearn/csv 1.0.0

package/README.md

@@ -0,0 +1,50 @@
+# `@prairielearn/csv`
+
+A few helpful wrappers on top of the functionality from [`csv-stringify`](https://www.npmjs.com/package/csv-stringify).
+
+## Usage
+
+Here's an example taking data from `@prairielearn/postgres#queryCursor()` and writing it to a file, though this should be applicable to any source and destination streams:
+
+```ts
+import { stringifyStream } from '@prairielearn/csv';
+import { queryCursor } from '@prairielearn/postgres';
+import { pipeline } from 'node:stream/promises';
+import { createWriteStream } from 'node:fs';
+
+const cursor = await queryCursor('SELECT id FROM workspaces;', {});
+const output = createWriteStream('workspaces.csv');
+
+const stringifier = stringifyStream({
+  header: true,
+  columns: [{ key: 'id', header: 'ID' }],
+  // Optionally provide a function to transform each item in the stream.
+  transform(record) {
+    return {
+      id: `workspace-${id}`,
+    };
+  },
+});
+
+await pipeline(cursor.stream(100), stringifier, output);
+```
+
+Note that this works best when the source stream is producing data asynchronously, such as though an async iterator. If you use a synchronous data source like `Readable.from([...])`, the conversion will still occur synchronously. If you have a large array of data in memory and want to convert it to a CSV, you can use `stringifyNonblocking`:
+
+```ts
+import { stringifyNonblocking } from '@prairielearn/csv';
+import { createWriteStream } from 'node:fs';
+
+const data = Array.from(new Array(100_000), (_, i) => ({ id: i }));
+const output = createWriteStream('numbers.csv');
+stringifyNonblocking(data, {
+  header: true,
+  columns: [{ key: 'id', header: 'ID' }],
+}).pipe(output);
+```
+
+For lower-level usage, `stringify` and `Stringifier` are also re-exported from `csv-stringify`:
+
+```ts
+import { stringify, Stringifier } from '@prairielearn/csv';
+```

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="node" />
+import { stringify, Stringifier, Options as StringifierOptions } from 'csv-stringify';
+import { Handler as TransformHandler } from 'stream-transform';
+export { stringify, Stringifier };
+export interface StringifyNonblockingOptions extends StringifierOptions {
+    batchSize?: number;
+}
+/**
+ * Streaming transform from an array of objects to a CSV that doesn't
+ * block the event loop.
+ */
+export declare function stringifyNonblocking(data: any[], options?: StringifyNonblockingOptions): Stringifier;
+interface StringifyOptions<T = any, U = any> extends Pick<StringifierOptions, 'columns' | 'header'> {
+    transform?: TransformHandler<T, U>;
+}
+/**
+ * Transforms an object stream into a CSV stream.
+ *
+ * This is a thin wrapper around `stringify` from the `csv-stringify` package
+ * with added support for transforming the input stream.
+ *
+ * Works best when combined with the `pipeline` function from
+ * `node:stream/promises`, which will help ensure that errors are handled properly.
+ */
+export declare function stringifyStream<T = any, U = any>(options?: StringifyOptions<T, U>): NodeJS.ReadWriteStream;

package/dist/index.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringifyStream = exports.stringifyNonblocking = exports.Stringifier = exports.stringify = void 0;
+const csv_stringify_1 = require("csv-stringify");
+Object.defineProperty(exports, "stringify", { enumerable: true, get: function () { return csv_stringify_1.stringify; } });
+Object.defineProperty(exports, "Stringifier", { enumerable: true, get: function () { return csv_stringify_1.Stringifier; } });
+const stream_transform_1 = require("stream-transform");
+const multipipe_1 = __importDefault(require("multipipe"));
+/**
+ * Streaming transform from an array of objects to a CSV that doesn't
+ * block the event loop.
+ */
+function stringifyNonblocking(data, options = {}) {
+    const { batchSize = 100, ...stringifierOptions } = options;
+    const stringifier = new csv_stringify_1.Stringifier(stringifierOptions);
+    process.nextTick(function () {
+        let j = 0;
+        function loop() {
+            for (let i = 0; i < batchSize; i++) {
+                if (j < data.length) {
+                    stringifier.write(data[j]);
+                    j += 1;
+                }
+                else {
+                    stringifier.end();
+                    return;
+                }
+            }
+            setImmediate(loop);
+        }
+        loop();
+    });
+    return stringifier;
+}
+exports.stringifyNonblocking = stringifyNonblocking;
+/**
+ * Transforms an object stream into a CSV stream.
+ *
+ * This is a thin wrapper around `stringify` from the `csv-stringify` package
+ * with added support for transforming the input stream.
+ *
+ * Works best when combined with the `pipeline` function from
+ * `node:stream/promises`, which will help ensure that errors are handled properly.
+ */
+function stringifyStream(options = {}) {
+    const { transform: _transform, ...stringifierOptions } = options;
+    const stringifier = new csv_stringify_1.Stringifier(stringifierOptions);
+    if (!_transform)
+        return stringifier;
+    // TODO: use native `node:stream#compose` once it's stable.
+    return (0, multipipe_1.default)((0, stream_transform_1.transform)(_transform), stringifier);
+}
+exports.stringifyStream = stringifyStream;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,iDAAsF;AAI7E,0FAJA,yBAAS,OAIA;AAAE,4FAJA,2BAAW,OAIA;AAH/B,uDAA0E;AAC1E,0DAAkC;AAQlC;;;GAGG;AACH,SAAgB,oBAAoB,CAClC,IAAW,EACX,UAAuC,EAAE;IAEzC,MAAM,EAAE,SAAS,GAAG,GAAG,EAAE,GAAG,kBAAkB,EAAE,GAAG,OAAO,CAAC;IAC3D,MAAM,WAAW,GAAG,IAAI,2BAAW,CAAC,kBAAkB,CAAC,CAAC;IAExD,OAAO,CAAC,QAAQ,CAAC;QACf,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,SAAS,IAAI;YACX,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,EAAE,EAAE;gBAClC,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE;oBACnB,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC3B,CAAC,IAAI,CAAC,CAAC;iBACR;qBAAM;oBACL,WAAW,CAAC,GAAG,EAAE,CAAC;oBAClB,OAAO;iBACR;aACF;YACD,YAAY,CAAC,IAAI,CAAC,CAAC;QACrB,CAAC;QACD,IAAI,EAAE,CAAC;IACT,CAAC,CAAC,CAAC;IAEH,OAAO,WAAW,CAAC;AACrB,CAAC;AAzBD,oDAyBC;AAOD;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAC7B,UAAkC,EAAE;IAEpC,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,kBAAkB,EAAE,GAAG,OAAO,CAAC;IACjE,MAAM,WAAW,GAAG,IAAI,2BAAW,CAAC,kBAAkB,CAAC,CAAC;IACxD,IAAI,CAAC,UAAU;QAAE,OAAO,WAAW,CAAC;IACpC,2DAA2D;IAC3D,OAAO,IAAA,mBAAS,EAAC,IAAA,4BAAS,EAAC,UAAU,CAAC,EAAE,WAAW,CAAC,CAAC;AACvD,CAAC;AARD,0CAQC"}

package/dist/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.test.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_stream_1 = require("node:stream");
+const chai_1 = require("chai");
+const index_1 = require("./index");
+function streamToString(stream) {
+    const chunks = [];
+    return new Promise((resolve, reject) => {
+        stream.on('data', (chunk) => chunks.push(Buffer.from(chunk)));
+        stream.on('error', reject);
+        stream.on('end', () => resolve(Buffer.concat(chunks).toString('utf8')));
+    });
+}
+describe('stringifyStream', () => {
+    it('stringifies a stream of objects', async () => {
+        const stream = node_stream_1.Readable.from([
+            { a: 1, b: 1 },
+            { a: 2, b: 2 },
+            { a: 3, b: 3 },
+        ]);
+        const csvStream = stream.pipe((0, index_1.stringifyStream)());
+        const csv = await streamToString(csvStream);
+        chai_1.assert.equal(csv, '1,1\n2,2\n3,3\n');
+    });
+    it('stringifies a stream of arrays', async () => {
+        const stream = node_stream_1.Readable.from([
+            ['1', '1'],
+            ['2', '2'],
+            ['3', '3'],
+        ]);
+        const csvStream = stream.pipe((0, index_1.stringifyStream)());
+        const csv = await streamToString(csvStream);
+        chai_1.assert.equal(csv, '1,1\n2,2\n3,3\n');
+    });
+    it('stringifies a stream with a transform', async () => {
+        const stream = node_stream_1.Readable.from([
+            { a: 1, b: 1 },
+            { a: 2, b: 2 },
+            { a: 3, b: 3 },
+        ]);
+        const csvStream = stream.pipe((0, index_1.stringifyStream)({ transform: (row) => [row.a + 1, row.b + 2] }));
+        const csv = await streamToString(csvStream);
+        chai_1.assert.equal(csv, '2,3\n3,4\n4,5\n');
+    });
+    it('stringifies a stream with keyed columns and a transform', async () => {
+        const stream = node_stream_1.Readable.from([
+            { a: 1, b: 1 },
+            { a: 2, b: 2 },
+            { a: 3, b: 3 },
+        ]);
+        const stringifier = (0, index_1.stringifyStream)({
+            header: true,
+            columns: [
+                { key: 'a', header: 'first' },
+                { key: 'b', header: 'second' },
+            ],
+            transform: (row) => [row.a + 1, row.b + 2],
+        });
+        const csv = await streamToString(stream.pipe(stringifier));
+        chai_1.assert.equal(csv, 'first,second\n2,3\n3,4\n4,5\n');
+    });
+    it('stringifies a stream with named columns and a transform', async () => {
+        const stream = node_stream_1.Readable.from([
+            { a: 1, b: 1 },
+            { a: 2, b: 2 },
+            { a: 3, b: 3 },
+        ]);
+        const stringifier = (0, index_1.stringifyStream)({
+            header: true,
+            columns: ['first', 'second'],
+            transform: (row) => [row.a + 1, row.b + 2],
+        });
+        const csv = await streamToString(stream.pipe(stringifier));
+        chai_1.assert.equal(csv, 'first,second\n2,3\n3,4\n4,5\n');
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/dist/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":";;AAAA,6CAAuC;AACvC,+BAA8B;AAE9B,mCAA0C;AAE1C,SAAS,cAAc,CAAC,MAA6B;IACnD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC9D,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC3B,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;AACL,CAAC;AAED,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC/C,MAAM,MAAM,GAAG,sBAAQ,CAAC,IAAI,CAAC;YAC3B,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;YACd,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;YACd,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;SACf,CAAC,CAAC;QACH,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAA,uBAAe,GAAE,CAAC,CAAC;QACjD,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,SAAS,CAAC,CAAC;QAC5C,aAAM,CAAC,KAAK,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC9C,MAAM,MAAM,GAAG,sBAAQ,CAAC,IAAI,CAAC;YAC3B,CAAC,GAAG,EAAE,GAAG,CAAC;YACV,CAAC,GAAG,EAAE,GAAG,CAAC;YACV,CAAC,GAAG,EAAE,GAAG,CAAC;SACX,CAAC,CAAC;QACH,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAA,uBAAe,GAAE,CAAC,CAAC;QACjD,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,SAAS,CAAC,CAAC;QAC5C,aAAM,CAAC,KAAK,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,MAAM,GAAG,sBAAQ,CAAC,IAAI,CAAC;YAC3B,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;YACd,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;YACd,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;SACf,CAAC,CAAC;QACH,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAA,uBAAe,EAAC,EAAE,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC/F,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,SAAS,CAAC,CAAC;QAC5C,aAAM,CAAC,KAAK,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACvE,MAAM,MAAM,GAAG,sBAAQ,CAAC,IAAI,CAAC;YAC3B,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;YACd,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;YACd,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;SACf,CAAC,CAAC;QACH,MAAM,WAAW,GAAG,IAAA,uBAAe,EAAC;YAClC,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE;gBACP,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE;gBAC7B,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE;aAC/B;YACD,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;SAC3C,CAAC,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAC3D,aAAM,CAAC,KAAK,CAAC,GAAG,EAAE,+BAA+B,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACvE,MAAM,MAAM,GAAG,sBAAQ,CAAC,IAAI,CAAC;YAC3B,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;YACd,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;YACd,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;SACf,CAAC,CAAC;QACH,MAAM,WAAW,GAAG,IAAA,uBAAe,EAAC;YAClC,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;YAC5B,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;SAC3C,CAAC,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAC3D,aAAM,CAAC,KAAK,CAAC,GAAG,EAAE,+BAA+B,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@prairielearn/csv",
+  "version": "1.0.0",
+  "main": "./dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch --preserveWatchOutput",
+    "test": "mocha --no-config --require ts-node/register src/*.test.ts"
+  },
+  "devDependencies": {
+    "@prairielearn/tsconfig": "*",
+    "@types/mocha": "^10.0.1",
+    "@types/multipipe": "^3.0.1",
+    "@types/node": "^18.14.2",
+    "mocha": "^10.2.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.4"
+  },
+  "dependencies": {
+    "csv-stringify": "^6.3.0",
+    "multipipe": "^4.0.0",
+    "stream-transform": "^3.2.2"
+  }
+}

package/src/index.test.ts

@@ -0,0 +1,81 @@
+import { Readable } from 'node:stream';
+import { assert } from 'chai';
+
+import { stringifyStream } from './index';
+
+function streamToString(stream: NodeJS.ReadableStream): Promise<string> {
+  const chunks: Buffer[] = [];
+  return new Promise((resolve, reject) => {
+    stream.on('data', (chunk) => chunks.push(Buffer.from(chunk)));
+    stream.on('error', reject);
+    stream.on('end', () => resolve(Buffer.concat(chunks).toString('utf8')));
+  });
+}
+
+describe('stringifyStream', () => {
+  it('stringifies a stream of objects', async () => {
+    const stream = Readable.from([
+      { a: 1, b: 1 },
+      { a: 2, b: 2 },
+      { a: 3, b: 3 },
+    ]);
+    const csvStream = stream.pipe(stringifyStream());
+    const csv = await streamToString(csvStream);
+    assert.equal(csv, '1,1\n2,2\n3,3\n');
+  });
+
+  it('stringifies a stream of arrays', async () => {
+    const stream = Readable.from([
+      ['1', '1'],
+      ['2', '2'],
+      ['3', '3'],
+    ]);
+    const csvStream = stream.pipe(stringifyStream());
+    const csv = await streamToString(csvStream);
+    assert.equal(csv, '1,1\n2,2\n3,3\n');
+  });
+
+  it('stringifies a stream with a transform', async () => {
+    const stream = Readable.from([
+      { a: 1, b: 1 },
+      { a: 2, b: 2 },
+      { a: 3, b: 3 },
+    ]);
+    const csvStream = stream.pipe(stringifyStream({ transform: (row) => [row.a + 1, row.b + 2] }));
+    const csv = await streamToString(csvStream);
+    assert.equal(csv, '2,3\n3,4\n4,5\n');
+  });
+
+  it('stringifies a stream with keyed columns and a transform', async () => {
+    const stream = Readable.from([
+      { a: 1, b: 1 },
+      { a: 2, b: 2 },
+      { a: 3, b: 3 },
+    ]);
+    const stringifier = stringifyStream({
+      header: true,
+      columns: [
+        { key: 'a', header: 'first' },
+        { key: 'b', header: 'second' },
+      ],
+      transform: (row) => [row.a + 1, row.b + 2],
+    });
+    const csv = await streamToString(stream.pipe(stringifier));
+    assert.equal(csv, 'first,second\n2,3\n3,4\n4,5\n');
+  });
+
+  it('stringifies a stream with named columns and a transform', async () => {
+    const stream = Readable.from([
+      { a: 1, b: 1 },
+      { a: 2, b: 2 },
+      { a: 3, b: 3 },
+    ]);
+    const stringifier = stringifyStream({
+      header: true,
+      columns: ['first', 'second'],
+      transform: (row) => [row.a + 1, row.b + 2],
+    });
+    const csv = await streamToString(stream.pipe(stringifier));
+    assert.equal(csv, 'first,second\n2,3\n3,4\n4,5\n');
+  });
+});

package/src/index.ts

@@ -0,0 +1,64 @@
+import { stringify, Stringifier, Options as StringifierOptions } from 'csv-stringify';
+import { transform, Handler as TransformHandler } from 'stream-transform';
+import multipipe from 'multipipe';
+
+export { stringify, Stringifier };
+
+export interface StringifyNonblockingOptions extends StringifierOptions {
+  batchSize?: number;
+}
+
+/**
+ * Streaming transform from an array of objects to a CSV that doesn't
+ * block the event loop.
+ */
+export function stringifyNonblocking(
+  data: any[],
+  options: StringifyNonblockingOptions = {}
+): Stringifier {
+  const { batchSize = 100, ...stringifierOptions } = options;
+  const stringifier = new Stringifier(stringifierOptions);
+
+  process.nextTick(function () {
+    let j = 0;
+    function loop() {
+      for (let i = 0; i < batchSize; i++) {
+        if (j < data.length) {
+          stringifier.write(data[j]);
+          j += 1;
+        } else {
+          stringifier.end();
+          return;
+        }
+      }
+      setImmediate(loop);
+    }
+    loop();
+  });
+
+  return stringifier;
+}
+
+interface StringifyOptions<T = any, U = any>
+  extends Pick<StringifierOptions, 'columns' | 'header'> {
+  transform?: TransformHandler<T, U>;
+}
+
+/**
+ * Transforms an object stream into a CSV stream.
+ *
+ * This is a thin wrapper around `stringify` from the `csv-stringify` package
+ * with added support for transforming the input stream.
+ *
+ * Works best when combined with the `pipeline` function from
+ * `node:stream/promises`, which will help ensure that errors are handled properly.
+ */
+export function stringifyStream<T = any, U = any>(
+  options: StringifyOptions<T, U> = {}
+): NodeJS.ReadWriteStream {
+  const { transform: _transform, ...stringifierOptions } = options;
+  const stringifier = new Stringifier(stringifierOptions);
+  if (!_transform) return stringifier;
+  // TODO: use native `node:stream#compose` once it's stable.
+  return multipipe(transform(_transform), stringifier);
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@prairielearn/tsconfig",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "types": ["mocha", "node"],
+  }
+}