Commit 1aa798d
doc: clarify transform._transform() callback argument logic
Clarify that `transform._transform()` callback second argument is
used only if the first argument is `null`, i.e. no error occured
processing the chunk.
PR-URL: #48680
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com>1 parent d723e87 commit 1aa798d
1 file changed
Lines changed: 2 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -4507,7 +4507,8 @@ The `callback` function must be called only when the current chunk is completely | |||
| 4507 | 4507 | consumed. The first argument passed to the `callback` must be an `Error` object | |
| 4508 | 4508 | if an error occurred while processing the input or `null` otherwise. If a second | |
| 4509 | 4509 | argument is passed to the `callback`, it will be forwarded on to the | |
| 4510 | - `transform.push()` method. In other words, the following are equivalent: | ||
| 4510 | + `transform.push()` method, but only if the first argument is falsy. In other | ||
| 4511 | + words, the following are equivalent: | ||
| 4511 | 4512 | ||
| 4512 | 4513 | ```js | |
| 4513 | 4514 | transform.prototype._transform = function(data, encoding, callback) { | |
0 commit comments