Skip to content

Commit dcb4cec

Browse files
committed
Fixed README typo and added example service
1 parent c7a7759 commit dcb4cec

File tree

8 files changed

+102
-1
lines changed

8 files changed

+102
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ functions:
3939
hello:
4040
handler: index.handler
4141
layers:
42-
- !Ref: LibLambdaLayer # TitleCase layer name followed by LambdaLayer
42+
# Note the reference being the TitleCase representation of the layer id followed by "LambdaLayer"
43+
- {Ref: LibLambdaLayer}
4344
```
4445

4546
The `lib` layer will be installed and its `node_modules` packaged into the artifact, and the function will use the layer.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# package directories
2+
node_modules
3+
jspm_packages
4+
5+
# Serverless directories
6+
.serverless
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
const _ = require('lodash');
2+
3+
module.exports.handler = (event, context) => {
4+
console.log('Event: %j', event);
5+
6+
console.log(`Using lodash: ${_.range(10)}`);
7+
};

examples/example-layer-service/my-lib/nodejs/package-lock.json

Lines changed: 13 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": "my-lib",
3+
"version": "1.0.0",
4+
"description": "",
5+
"scripts": {},
6+
"author": "",
7+
"license": "ISC",
8+
"dependencies": {
9+
"lodash": "^4.17.15"
10+
}
11+
}

examples/example-layer-service/package-lock.json

Lines changed: 23 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"name": "example-layer-service",
3+
"version": "1.0.0",
4+
"description": "Example service for serverless-plugin-layer-manager",
5+
"scripts": {},
6+
"author": "Henrik Hall",
7+
"license": "ISC",
8+
"devDependencies": {
9+
"serverless-plugin-layer-manager": "^1.0.2"
10+
}
11+
}
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
service: example-layer-service
2+
provider:
3+
name: aws
4+
runtime: nodejs12.x
5+
6+
plugins:
7+
- serverless-plugin-layer-manager
8+
9+
layers:
10+
myLib:
11+
path: ./my-lib
12+
name: my-lib
13+
description: My library
14+
retain: true
15+
16+
functions:
17+
hello:
18+
handler: hello.handler
19+
layers:
20+
# Note the reference being the TitleCase representation of the layer id followed by "LambdaLayer"
21+
- {Ref: MyLibLambdaLayer}
22+
23+
#custom:
24+
# layerConfig:
25+
# installLayers: <boolean>
26+
# exportLayers: <boolean>
27+
# upgradeLayerReferences: <boolean>
28+
# exportPrefix: <prefix used for the names of the exported layers>
29+

0 commit comments

Comments
 (0)