add JSDoc comments to all methods

Author: Raice Hannay

package.json

@@ -3,7 +3,7 @@
   "author": "Raice Hannay <[email protected]>",
   "description": "A set of classes to make setting up React components for unit tests easy.",
   "license": "ISC",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "keywords": [
     "component",
     "enzyme",

src/Wrapper.tsx

@@ -1,54 +1,141 @@
 import { ComponentType, mount, render, shallow } from "enzyme";
 import * as React from "react";
 
+/**
+ * A class to provide a simple interface for setting up your React component unit tests
+ */
 export default class Wrapper<
   C extends React.ComponentType<any>,
   P extends React.ComponentProps<C> = React.ComponentProps<C>
 > {
-  // Properties that are implemented in classes that extend Wrapper
+  // region Properties that are implemented in classes that extend Wrapper
+
+  /**
+   * The component that will wrap the component you're testing.
+   *
+   * This is useful adding provider components to wrap your components with.
+   */
   protected WrappingComponent: ComponentType<any> | undefined = undefined;
 
-  // Properties that remain throughout instance lifecycle
+  // endregion
+
+  // region Properties that remain throughout instance lifecycle
+
+  /**
+   * The default children for all test scenarios for the current test suite.
+   *
+   * This is set by the `.withDefaultChildren()` method.
+   */
   protected defaultChildren: React.ReactNode;
+
+  /**
+   * The default props for all test scenarios for the current test suite.
+   *
+   * This is set by the `.withDefaultProps()` method.
+   */
   protected defaultProps: Partial<P> = {};
 
-  // Scenario-specific properties that are cleared whenever shallow/mount/render are called
+  // endregion
+
+  // region Scenario-specific properties that are cleared whenever shallow/mount/render are called
+
+  /**
+   * The children specific to the test scenario.
+   *
+   * This is set by the `.withChildren()` method and cleared after `.mount()`, `.render()` or `.shallow()` are called.
+   */
   protected scenarioChildren: React.ReactNode;
+
+  /**
+   * The props specific to the test scenario.
+   *
+   * This is set by the `.withProps()` method and cleared after `.mount()`, `.render()` or `.shallow()` are called.
+   */
   protected scenarioProps: Partial<P> = {};
 
-  // Properties to be accessed via getters after mounting
+  // endregion
+
+  // region Properties to be accessed via getters after mounting
+
+  /**
+   * The merged props to be used during the lifecycle of the test scenario.
+   *
+   * This is set by the `.mount()`, `.render()` and `.shallow()` methods so that you can access the
+   * props in your test via the `.props` getter.
+   */
   protected mergedProps: Partial<P> = {};
 
+  // endregion
+
+  /**
+   * @param Component The React component to test
+   */
   constructor(protected readonly Component: C) {}
 
+  /**
+   * Returns the props for the current test scenario lifecycle
+   */
   public get props() {
     return this.mergedProps;
   }
 
+  /**
+   * Sets the default children to be used in all test scenarios for the current test suite.
+   *
+   * This method can be chained with other methods.
+   *
+   * @param children  The children to set
+   */
   public withDefaultChildren = (children: React.ReactNode) => {
     this.defaultChildren = children;
 
     return this;
   };
 
+  /**
+   * Sets the default props to be used in all test scenarios for the current test suite.
+   *
+   * This method can be chained with other methods.
+   *
+   * @param props The props to set
+   */
   public withDefaultProps = (props: Partial<P>) => {
     this.defaultProps = props;
 
     return this;
   };
 
+  /**
+   * Sets the children to be used by the current test scenario.
+   *
+   * This method can be chained with other methods.
+   *
+   * @param children  The children to set
+   */
   public withChildren = (children: React.ReactNode) => {
     this.scenarioChildren = children;
 
     return this;
   };
 
+  /**
+   * Sets the props to be used by the current test scenario.
+   *
+   * This method can be chained with other methods.
+   *
+   * @param props The props to set
+   */
   public withProps = (props: Partial<P>) => {
     this.scenarioProps = props;
 
     return this;
   };
 
+  /**
+   * Mounts the component using Enzyme's `mount()` function.
+   *
+   * Returns the `ReactWrapper` instance from `mount()`.
+   */
   public mount = () => {
     this.beforeMount();
 
@@ -62,6 +149,11 @@ export default class Wrapper<
     return wrapper;
   };
 
+  /**
+   * Mounts the component using Enzyme's `render()` function.
+   *
+   * Returns the `Cheerio` wrapper instance from `render()`.
+   */
   public render = () => {
     this.beforeMount();
 
@@ -81,6 +173,11 @@ export default class Wrapper<
     return wrapper;
   };
 
+  /**
+   * Mounts the component using Enzyme's `shallow()` function.
+   *
+   * Returns the `ShallowWrapper` instance from `shallow()`.
+   */
   public shallow = () => {
     this.beforeMount();
 
@@ -100,10 +197,18 @@ export default class Wrapper<
     return wrapper;
   };
 
+  /**
+   * This is called before `.mount()`, `.render()` and `.shallow()` are called.
+   *
+   * You can use this to perform additional functionality when extending this class.
+   */
   protected beforeMount = () => {
     // Implement this method when extending to define properties to pass to `WrappingComponent`
   };
 
+  /**
+   * Defines the merged props for the current test scenario lifecycle
+   */
   protected defineProps = () => {
     this.mergedProps = {
       ...this.defaultProps,
@@ -114,6 +219,9 @@ export default class Wrapper<
     return this.mergedProps;
   };
 
+  /**
+   * Resets the scenario-specific children and props for the instance
+   */
   protected reset() {
     this.scenarioChildren = undefined;
     this.scenarioProps = {};

src/WrapperWithIntl.tsx

@@ -3,12 +3,23 @@ import { IntlConfig, IntlProvider } from "react-intl";
 
 import Wrapper from "./Wrapper";
 
+/**
+ * A class to provide a simple interface for setting up your React component unit tests, with support for `react-intl`.
+ *
+ * This class shouldn't be used when using `react-intl-redux`, as that uses a different provider component.
+ */
 export default abstract class WrapperWithIntl<
   C extends React.ComponentType<any>,
   P extends React.ComponentProps<C> = React.ComponentProps<C>
 > extends Wrapper<C, P> {
+  /**
+   * The props to be passed to `react-intl`'s `IntlProvider` component
+   */
   protected abstract intlProviderProps: Partial<IntlConfig>;
 
+  /**
+   * Returns the merged `IntlProvider` props
+   */
   protected get mergedIntlProviderProps() {
     return {
       defaultLocale: "en",
@@ -18,6 +29,9 @@ export default abstract class WrapperWithIntl<
     };
   }
 
+  /**
+   * The component that wraps the component you're testing
+   */
   protected WrappingComponent: React.FC = ({ children }) => (
     <IntlProvider {...this.mergedIntlProviderProps}>{children}</IntlProvider>
   );