Merge pull request #34 from jryd/patch-1

aarondfrancis · web-flow · commit d6a4af11a11d · 2021-10-18T10:33:21.000-05:00
Update package documentation to include note for shipping node_modules
diff --git a/docs/functions/handlers-and-packages.md b/docs/functions/handlers-and-packages.md
@@ -162,6 +162,10 @@ class ExampleFunction extends LambdaFunction
 }
 ```
 
+> Note; if you are using any external dependencies (i.e packages installed in your `node_modules`), you need to ship the dependencies also.
+> For example, if you have installed some Javascript packages for your Javascript function, and these were installed alongside your function in the `resources/lambda` folder, then you would need to include the whole directory as detailed above.
+> See the section below on "Strategies for Dealing With node_modules" for more control over this
+
 ## The Package Class
 
 If you need a little more fine-grained control over the packaging process, you can use the `Package` class instead of the simpler array format.

Original file line number	Diff line number	Diff line change
`@@ -162,6 +162,10 @@ class ExampleFunction extends LambdaFunction`
`162`	`162`	`}`
`163`	`163`	```
`164`	`164`
	`165`	+> Note; if you are using any external dependencies (i.e packages installed in your `node_modules`), you need to ship the dependencies also.
	`166`	+> For example, if you have installed some Javascript packages for your Javascript function, and these were installed alongside your function in the `resources/lambda` folder, then you would need to include the whole directory as detailed above.
	`167`	`+> See the section below on "Strategies for Dealing With node_modules" for more control over this`
	`168`	`+`
`165`	`169`	`## The Package Class`
`166`	`170`
`167`	`171`	If you need a little more fine-grained control over the packaging process, you can use the `Package` class instead of the simpler array format.