Updating jsDoc

Author: Otto Pecz

README.md

@@ -1,7 +1,7 @@
 ## Modules
 
 <dl>
-<dt><a href="#module_index">index</a></dt>
+<dt><a href="#index.module_js">js</a></dt>
 <dd><p>The plugin can register triggers (events) for a lambda function dynamically. At deployment time</p>
 <ol>
 <li>It fetches the value of a parameter in the Parameters. The value must be a list ARNs sepearted by comma.</li>
@@ -20,7 +20,32 @@ while on <em>prod</em> foo lambda function is triggered by</li>
 <li>arn:aws:sns:eu-west-2:123456654321:topic2
 This way we can switch features on and off on different stages.</li>
 </ul>
-<p>The dynamic triger sets needs to ne stored in the Parameter Store of the Systems Manager (SSM) and it should look somewhat like this:</p>
+<p>The dynamic trigger sets needs to ne stored in the Parameter Store of the Systems Manager (SSM) and it should look somewhat like this:
+Name: /dev/dynamic-trigger
+Value: arn:aws:sns:eu-west-2:123456654321:topic1,arn:aws:sns:eu-west-2:123456654321:topic2,arn:aws:sns:eu-west-2:123456654321:topic3
+or
+Name: /prod/dynamic-trigger
+Value: arn:aws:sns:eu-west-2:123456654321:topic1,arn:aws:sns:eu-west-2:123456654321:topic2</p>
+<p>The config parameters:</p>
+<ul>
+<li>region: the region of the Systems Manager -&gt; Parameter Store</li>
+<li>functions:<ul>
+<li>name: The name of the function</li>
+</ul>
+</li>
+</ul>
+<p>plugins:</p>
+<ul>
+<li>@kakkuk/serverless-aws-lambda-dynamic-trigger
+custom:
+  dynamicTrigger:
+region: &quot;eu-west-2&quot; // !!! Optional !!! It&#39;ll fall back to AWS_DEFAULT_REGION if it&#39;s not set
+functions:<ul>
+<li>name: &quot;handler&quot;
+ssmPath: &quot;{/path/to/triggers}&quot;</li>
+</ul>
+</li>
+</ul>
 </dd>
 </dl>
 
@@ -32,9 +57,9 @@ This way we can switch features on and off on different stages.</li>
 </dd>
 </dl>
 
-<a name="module_index"></a>
+<a name="index.module_js"></a>
 
-## index
+## js
 The plugin can register triggers (events) for a lambda function dynamically. At deployment time
 1. It fetches the value of a parameter in the Parameters. The value must be a list ARNs sepearted by comma.
 2. Parses the individual ARNs.
@@ -52,23 +77,18 @@ while on *prod* foo lambda function is triggered by
 - arn:aws:sns:eu-west-2:123456654321:topic2
 This way we can switch features on and off on different stages.
 
-The dynamic triger sets needs to ne stored in the Parameter Store of the Systems Manager (SSM) and it should look somewhat like this:
-
-**Example**  
-```js
-*Name*: /dev/dynamic-trigger
-*Value*: arn:aws:sns:eu-west-2:123456654321:topic1,arn:aws:sns:eu-west-2:123456654321:topic2,arn:aws:sns:eu-west-2:123456654321:topic3
+The dynamic trigger sets needs to ne stored in the Parameter Store of the Systems Manager (SSM) and it should look somewhat like this:
+Name: /dev/dynamic-trigger
+Value: arn:aws:sns:eu-west-2:123456654321:topic1,arn:aws:sns:eu-west-2:123456654321:topic2,arn:aws:sns:eu-west-2:123456654321:topic3
 or
-*Name*: /prod/dynamic-trigger
-*Value*: arn:aws:sns:eu-west-2:123456654321:topic1,arn:aws:sns:eu-west-2:123456654321:topic2
+Name: /prod/dynamic-trigger
+Value: arn:aws:sns:eu-west-2:123456654321:topic1,arn:aws:sns:eu-west-2:123456654321:topic2
 
 The config parameters:
+- region: the region of the Systems Manager -> Parameter Store
 - functions:
   - name: The name of the function
-  - ssmPath: Path to ssm which stores the triggers for the function. The value of the parameter should be a list of aws arns.
-```
-**Example**  
-```js
+
 plugins:
   - @kakkuk/serverless-aws-lambda-dynamic-trigger
 custom:
@@ -77,7 +97,7 @@ custom:
     functions:
       - name: "handler"
         ssmPath: "{/path/to/triggers}"
-```
+
 <a name="Package @kakkuk/serverless-aws-lambda-dynamic-trigger"></a>
 
 ## Package @kakkuk/serverless-aws-lambda-dynamic-trigger

src/index.js

@@ -4,9 +4,8 @@
  */
 
 /**
- * @module index
+ * @module index.js
  * @description
- *
  * The plugin can register triggers (events) for a lambda function dynamically. At deployment time
  * 1. It fetches the value of a parameter in the Parameters. The value must be a list ARNs sepearted by comma.
  * 2. Parses the individual ARNs.
@@ -24,19 +23,18 @@
  * - arn:aws:sns:eu-west-2:123456654321:topic2
  * This way we can switch features on and off on different stages.
  *
- * The dynamic triger sets needs to ne stored in the Parameter Store of the Systems Manager (SSM) and it should look somewhat like this:
- * @example
- * *Name*: /dev/dynamic-trigger
- * *Value*: arn:aws:sns:eu-west-2:123456654321:topic1,arn:aws:sns:eu-west-2:123456654321:topic2,arn:aws:sns:eu-west-2:123456654321:topic3
+ * The dynamic trigger sets needs to ne stored in the Parameter Store of the Systems Manager (SSM) and it should look somewhat like this:
+ * Name: /dev/dynamic-trigger
+ * Value: arn:aws:sns:eu-west-2:123456654321:topic1,arn:aws:sns:eu-west-2:123456654321:topic2,arn:aws:sns:eu-west-2:123456654321:topic3
  * or
- * *Name*: /prod/dynamic-trigger
- * *Value*: arn:aws:sns:eu-west-2:123456654321:topic1,arn:aws:sns:eu-west-2:123456654321:topic2
+ * Name: /prod/dynamic-trigger
+ * Value: arn:aws:sns:eu-west-2:123456654321:topic1,arn:aws:sns:eu-west-2:123456654321:topic2
  *
  * The config parameters:
+ * - region: the region of the Systems Manager -> Parameter Store
  * - functions:
  *   - name: The name of the function
- *   - ssmPath: Path to ssm which stores the triggers for the function. The value of the parameter should be a list of aws arns.
- * @example
+ *
  * plugins:
  *   - @kakkuk/serverless-aws-lambda-dynamic-trigger
  * custom: