fix: rename declareStep -> createStep

Author: arlac77

README.md

@@ -33,6 +33,7 @@ basic step implementation
     -   [name](#name)
     -   [startupOrder](#startuporder-1)
 -   [StepProviderMixin](#stepprovidermixin)
+-   [StepProviderMixin](#stepprovidermixin-1)
 
 ## Step
 
@@ -77,12 +78,24 @@ Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ## StepProviderMixin
 
-Provide steps.
+Extends a class to fullfill step provider functionality
+
+**Parameters**
+
+-   `superclass` **Class** class to extend
+
+Returns **Class** extended class
+
+## StepProviderMixin
+
+Extends a class to fullfill step provider functionality
 Register and lookup step types
 
 **Parameters**
 
--   `superclass`  
+-   `superclass` **Class** class to extend
+
+Returns **Class** extended class
 
 # install
 

src/step-provider-mixin.js

@@ -1,20 +1,39 @@
 /**
- * Provide steps.
- * Register and lookup step types
+ * Extends a class to fullfill step provider functionality
+ * @param {Class} superclass class to extend
+ * @return {Class} extended class
  */
 export function StepProviderMixin(superclass) {
+  /**
+   * Extends a class to fullfill step provider functionality
+   * Register and lookup step types
+   * @param {Class} superclass class to extend
+   * @return {Class} extended class
+   */
   return class StepProviderMixin extends superclass {
     constructor(...args) {
       super(...args);
 
       Object.defineProperty(this, 'registeredSteps', { value: new Map() });
     }
 
+    /**
+     * Registers a Step class for later use in createStep
+     * @param {Object} step step class
+     * @return {undefined}
+     */
     registerStep(step) {
       this.registeredSteps.set(step.name, step);
     }
 
-    declareStep(config, ...args) {
+    /**
+     * Creates a step from its config
+     * @param {Object} config
+     * @param {string} config.type step type to create
+     * @param {Object[]} args remaining
+     * @return {Step} newly created step
+     */
+    createStep(config, ...args) {
       const factory = this.registeredSteps.get(config.type);
       if (factory === undefined) {
         throw new Error(`Undefined step ${config.type}`);

tests/step-provider-mixin-test.js

@@ -15,7 +15,7 @@ test('provider', async t => {
 
   provider.registerStep(AStep);
 
-  const step = await provider.declareStep(
+  const step = await provider.createStep(
     {
       name: 's1',
       type: 'a-step'
@@ -31,7 +31,7 @@ test('provider unknown type', async t => {
   const provider = new Provider();
 
   try {
-    const step = await provider.declareStep(
+    const step = await provider.createStep(
       {
         name: 's2',
         type: 'unknown-step'