Document reload method. (#235)

Robert Jackson · web-flow · commit 90a378c50768 · 2019-10-25T15:50:49.000-07:00
Document `reload` method.
diff --git a/src/index.js b/src/index.js
@@ -80,6 +80,14 @@ class FastBoot {
     }
   }
 
+  /**
+   * Destroy the existing Ember application instance, and recreate it from the provided dist path.
+   * This is commonly done when `dist` has been updated, and you need to prepare to serve requests
+   * with the updated assets.
+   *
+   * @param {Object} options
+   * @param {string} options.distPath the path to the built Ember application
+   */
   reload({ distPath }) {
     if (this._app) {
       this._app.destroy();

Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,14 @@ class FastBoot {`
`80`	`80`	`}`
`81`	`81`	`}`
`82`	`82`
	`83`	`+ /**`
	`84`	`+ * Destroy the existing Ember application instance, and recreate it from the provided dist path.`
	`85`	+ * This is commonly done when `dist` has been updated, and you need to prepare to serve requests
	`86`	`+ * with the updated assets.`
	`87`	`+ *`
	`88`	`+ * @param {Object} options`
	`89`	`+ * @param {string} options.distPath the path to the built Ember application`
	`90`	`+ */`
`83`	`91`	`reload({ distPath }) {`
`84`	`92`	`if (this._app) {`
`85`	`93`	`this._app.destroy();`