object-mode.js 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. import {TRANSFORM_TYPES} from '../stdio/type.js';
  2. /*
  3. Retrieve the `objectMode`s of a single transform.
  4. `objectMode` determines the return value's type, i.e. the `readableObjectMode`.
  5. The chunk argument's type is based on the previous generator's return value, i.e. the `writableObjectMode` is based on the previous `readableObjectMode`.
  6. The last input's generator is read by `subprocess.stdin` which:
  7. - should not be in `objectMode` for performance reasons.
  8. - can only be strings, Buffers and Uint8Arrays.
  9. Therefore its `readableObjectMode` must be `false`.
  10. The same applies to the first output's generator's `writableObjectMode`.
  11. */
  12. export const getTransformObjectModes = (objectMode, index, newTransforms, direction) => direction === 'output'
  13. ? getOutputObjectModes(objectMode, index, newTransforms)
  14. : getInputObjectModes(objectMode, index, newTransforms);
  15. const getOutputObjectModes = (objectMode, index, newTransforms) => {
  16. const writableObjectMode = index !== 0 && newTransforms[index - 1].value.readableObjectMode;
  17. const readableObjectMode = objectMode ?? writableObjectMode;
  18. return {writableObjectMode, readableObjectMode};
  19. };
  20. const getInputObjectModes = (objectMode, index, newTransforms) => {
  21. const writableObjectMode = index === 0
  22. ? objectMode === true
  23. : newTransforms[index - 1].value.readableObjectMode;
  24. const readableObjectMode = index !== newTransforms.length - 1 && (objectMode ?? writableObjectMode);
  25. return {writableObjectMode, readableObjectMode};
  26. };
  27. // Retrieve the `objectMode` of a file descriptor, e.g. `stdout` or `stderr`
  28. export const getFdObjectMode = (stdioItems, direction) => {
  29. const lastTransform = stdioItems.findLast(({type}) => TRANSFORM_TYPES.has(type));
  30. if (lastTransform === undefined) {
  31. return false;
  32. }
  33. return direction === 'input'
  34. ? lastTransform.value.writableObjectMode
  35. : lastTransform.value.readableObjectMode;
  36. };