Skip to content

fix(stream-transform): honor falsy params in the sync API #528

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wdavidw merged 2 commits into from
Oct 11, 2026
Merged

fix(stream-transform): honor falsy params in the sync API #528

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32757fa
fix(stream-transform): honor falsy params in the sync API
xiehuanyi Oct 11, 2026
7b0f5a0
test(stream-transform): group sync params regressions with option tests
xiehuanyi Oct 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/stream-transform/dist/cjs/sync.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ const transform = function () {
}
// Validate arguments
let expected_handler_length = 1;
if (options.params) {
if (options.params !== undefined && options.params !== null) {
expected_handler_length++;
}
if (handler.length > expected_handler_length) {
Expand Down
2 changes: 1 addition & 1 deletion packages/stream-transform/dist/esm/sync.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5263,7 +5263,7 @@ const transform = function () {
}
// Validate arguments
let expected_handler_length = 1;
if (options.params) {
if (options.params !== undefined && options.params !== null) {
expected_handler_length++;
}
if (handler.length > expected_handler_length) {
Expand Down
2 changes: 1 addition & 1 deletion packages/stream-transform/dist/iife/sync.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5266,7 +5266,7 @@ var stream_transform_sync = (function (exports) {
}
// Validate arguments
let expected_handler_length = 1;
if (options.params) {
if (options.params !== undefined && options.params !== null) {
expected_handler_length++;
}
if (handler.length > expected_handler_length) {
Expand Down
2 changes: 1 addition & 1 deletion packages/stream-transform/dist/umd/sync.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5269,7 +5269,7 @@
}
// Validate arguments
let expected_handler_length = 1;
if (options.params) {
if (options.params !== undefined && options.params !== null) {
expected_handler_length++;
}
if (handler.length > expected_handler_length) {
Expand Down
2 changes: 1 addition & 1 deletion packages/stream-transform/lib/sync.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ const transform = function () {
}
// Validate arguments
let expected_handler_length = 1;
if (options.params) {
if (options.params !== undefined && options.params !== null) {
expected_handler_length++;
}
if (handler.length > expected_handler_length) {
Expand Down
29 changes: 29 additions & 0 deletions packages/stream-transform/test/option.params.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,36 @@
import "should";
import { transform as transformSync } from "../lib/sync.js";
import { generate } from "csv-generate";
import { transform } from "../lib/index.js";

describe("option.params", function () {
describe("sync API", function () {
for (const params of [0, false, ""]) {
it(`honors falsy params ${JSON.stringify(params)}`, function () {
const data = transformSync(
["record"],
{ params },
function (record, value) {
return [record, value];
},
);
data.should.eql([["record", params]]);
});
}

for (const params of [undefined, null]) {
it(`rejects callback handlers with params ${params}`, function () {
(function () {
transformSync(["record"], { params }, function (record, callback) {
callback(null, record);
});
}).should.throw(
"Invalid Handler: only synchronous handlers are supported",
);
});
}
});

it("sync", function (next) {
const generator = generate({ length: 100, objectMode: true, seed: 1 });
const transformer = generator.pipe(
Expand Down