update api docs

kristw · Aug 1, 2016 · dc188d7 · dc188d7
1 parent f1c1f11
commit dc188d7
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -28,7 +28,7 @@ Class that provides convenient functions for a Yeoman generator.
         * [.templateExists(filePath)](#Easily+templateExists) ⇒ <code>boolean</code>
         * [.destinationExists(filePath)](#Easily+destinationExists) ⇒ <code>boolean</code>
         * [.listTemplateFiles(pattern, ignore)](#Easily+listTemplateFiles) ⇒ <code>Array.&lt;string&gt;</code>
-        * [.copyFiles(pattern)](#Easily+copyFiles) ⇒ <code>[Easily](#Easily)</code>
+        * [.copyFiles(pattern, options)](#Easily+copyFiles) ⇒ <code>[Easily](#Easily)</code>
         * [.savePropsToConfig()](#Easily+savePropsToConfig) ⇒ <code>[Easily](#Easily)</code>
         * [.learnPrompts(prompts)](#Easily+learnPrompts) ⇒ <code>[Easily](#Easily)</code>
         * [.findPrompt(prompt)](#Easily+findPrompt) ⇒ <code>Object</code>
@@ -306,7 +306,7 @@ List files in the template directory
 
 <a name="Easily+copyFiles"></a>
 
-### easily.copyFiles(pattern) ⇒ <code>[Easily](#Easily)</code>
+### easily.copyFiles(pattern, options) ⇒ <code>[Easily](#Easily)</code>
 Copy files from template directory to destination directory.
 Files with static content are copied directly.
 Files with dynamic content are created using the template and given props.
@@ -317,6 +317,7 @@ Files with dynamic content are created using the template and given props.
 | Param | Type | Description |
 | --- | --- | --- |
 | pattern | <code>string</code> | glob pattern for the files |
+| options | <code>Object</code> | options |
 | options.ignore | <code>Array.&lt;string&gt;</code> | glob pattern(s) to ignore |
 | options.dynamicFiles | <code>Array.&lt;string&gt;</code> | array of files with dynamic content (need templating) |
 | options.props | <code>Object</code> | properties for creating dynamic content |

diff --git a/lib/easily.js b/lib/easily.js
@@ -284,7 +284,8 @@ class Easily {
    * Copy files from template directory to destination directory.
    * Files with static content are copied directly.
    * Files with dynamic content are created using the template and given props.
-   * @param  {string} pattern              glob pattern for the files
+   * @param  {string} pattern  glob pattern for the files
+   * @param  {Object} options  options
    * @param  {Array.<string>}  options.ignore       glob pattern(s) to ignore
    * @param  {Array.<string>}  options.dynamicFiles array of files with dynamic content (need templating)
    * @param  {Object} options.props        properties for creating dynamic content