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 #1758

Open
e-dong opened this issue Mar 11, 2022 · 3 comments
Open

Comments

@e-dong
Copy link

e-dong commented Mar 11, 2022

I'm using yeoman-generator@5.6.1

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.

@e-dong
Copy link
Author

e-dong commented Oct 3, 2023

Wow this issue is still open? Lol

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

3 participants