.pipe signature change

[hfhchan-plb]

Previously in 8.1.9, calling .pipe(process.stdout) would return ProcessPromise, now (8.2.2) it returns D & PromiseLike<D>. Is there any way to get the old behaviour?

[hfhchan-plb]

Looks like this broke as part of #921 and #928, where the return type of .pipe() became polymorphic. Shouldn't this have been a major version change instead of minor?

[visnaut]

Looks like this broke as part of #921 and #928, where the return type of .pipe() became polymorphic. Shouldn't this have been a major version change instead of minor?

Agreed. I have a script in CI that broke because of this change.

The docs do not make reference to this change, and I believe the third example in the pipe doc won't work anymore, since I don't think you can chain them anymore.

[antongolub]

@visnaut

The docs do not make reference to this change, and I believe the third example in the pipe doc won't work anymore, since I don't think you can chain them anymore.

We'll update the example:

$`printf "hello"`
  .pipe($`awk '{printf $1", world!"}'`)
  .pipe($`tr '[a-z]' '[A-Z]'`)

// →
$`printf "hello"`
  .pipe`awk '{printf $1", world!"}'`
  .pipe`tr '[a-z]' '[A-Z]'`

[antongolub]

@hfhchan-plb ,

Is there any way to get the old behaviour?

Smth like this maybe, but I'm not sure:

const _pipe = ProcessPromise.prototype.pipe
ProcessPromise.prototype.pipe = function(...args) {
   const result = _pipe(...args)
   return result instanceof ProcessPromise ? result : this
}

[visnaut]

We'll update the example:

$printf "hello"
.pipe($awk '{printf $1", world!"}')
.pipe($tr '[a-z]' '[A-Z]')

// →
$printf "hello"
.pipeawk '{printf $1", world!"}'
.pipetr '[a-z]' '[A-Z]'

Thanks, I appreciate the reply.

Let me better articulate where I think the issue lies here: previously, I was doing the following:

const lines = await $(options)`command`.pipe(process.stdout).lines();

In other words, taking advantage of the fact that any method defined for ProcessPromise would return itself, allowing for the above chaining.

I've since updated the above to something like so:

const cli = $(options)`command`;

cli.pipe(process.stdout);

const lines = await cli.lines();

But you can see how anyone consuming the library and relying on the previous method signature to chain methods like that would be caught off guard by 8.2; hence why I agree with @hfhchan-plb that this maybe should have been a major version change.