Fix RunResult doc. (#150)

yeoman · May 17, 2021 · 42f5d56 · 42f5d56
1 parent 495b863
commit 42f5d56
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/lib/run-context.js b/lib/run-context.js
@@ -188,8 +188,8 @@ RunContext.prototype._run = function () {
 };
 
 /**
- * Run the generator on the environment and returns the promise.
- * @return {Promise} Promise
+ * Run the generator on the environment and promises a RunResult instance.
+ * @return {Promise<RunResult>} Promise a RunResult instance.
  */
 RunContext.prototype.run = function () {
   if (!this.settings.runEnvironment && this.buildAsync === undefined) {

diff --git a/lib/run-result.js b/lib/run-result.js
@@ -18,7 +18,11 @@ function convertArgs(args) {
   return Array.isArray(arg) ? arg : [arg];
 }
 
-module.exports = class RunResult {
+/**
+ * This class provides utilities for testing generated content.
+ */
+
+class RunResult {
   constructor(options = {cwd: process.cwd()}) {
     this.env = options.env;
     this.cwd = options.cwd;
@@ -349,4 +353,6 @@ module.exports = class RunResult {
   assertNoJsonFileContent(filename, content) {
     this.assertNoObjectContent(this._readFile(filename, true), content);
   }
-};
+}
+
+module.exports = RunResult;