Skip to content
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.

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

Docs on registerTransformStream needs to be renamed to queueTransformStream #838

Closed
e-dong opened this issue Mar 11, 2022 · 4 comments
Closed

Comments

@e-dong
Copy link

e-dong commented Mar 11, 2022

I'm using [email protected]

When trying to use this.registerTransformStream, I got this.registerTransformStream is not a function
https://yeoman.io/authoring/file-system.html#transform-output-files-through-streams

Looking at the node_modules, registerTransformStream does not exist, it has queueTransformStream

E.g.

  /**
   * Add a transform stream to the commit stream.
   *
   * Most usually, these transform stream will be Gulp plugins.
   *
   * @param  {stream.Transform|stream.Transform[]} streams An array of Transform stream
   * or a single one.
   * @return {this} This generator
   */
  queueTransformStream(transformStreams) {
    assert(
      transformStreams,
      'expected to receive a transform stream as parameter'
    );

    this.queueTask({
      method() {
        return this.env.applyTransforms(transformStreams);
      },
      taskName: 'transformStream',
      queueName: 'transform'
    });
    return this;
  }
}
@e-dong e-dong changed the title Docs on registerTransformStream needs to be renamed to queueTransformSream Docs on registerTransformStream needs to be renamed to queueTransformStream Mar 11, 2022
@danielsitnik
Copy link

Thanks.
Glad I found this issue because the docs are still mentioning registerTransformStream. 😢

@ZhaoKunLong
Copy link

AH! Yeah I also used It has been found to be wrong for several hours, but all the existing network data indicate that it should be used in this way.

@UlisesGascon
Copy link
Member

This is now fixed as #820 was merged.

Note: the change will be in live docs once #834 is solved

@mischah
Copy link
Member

mischah commented Jan 22, 2025

The changes are live on https://yeoman.io/authoring/file-system.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants