Skip to content

Commit 7c5fbe1

Browse files
yugasunyugasun
committed
docs: update src object doc
1 parent fc5c824 commit 7c5fbe1

File tree

1 file changed

+26
-20
lines changed

1 file changed

+26
-20
lines changed

‎docs/configure.md

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ inputs:
1818
runtime: Nodejs10.15
1919
serviceId: service-np1uloxw
2020
src: ./src
21+
# src:
22+
# src: ./src
23+
# exclude:
24+
# - .env
25+
# - node_modules
2126
layers:
2227
- name: expressLayer
2328
version: 1
@@ -61,29 +66,30 @@ inputs:
6166
6267
Main param description
6368
64-
| Param | Required | Default | Description |
65-
| ---------------------------------------- | :------: | :-------------: | :------------------------------------------------------------------------------------------ |
66-
| runtime | N | Nodejs10.15 | Function Runtime, support: Nodejs6.10, Nodejs8.9, Nodejs10.15 |
67-
| region | N | ap-guangzhou | Deploy region |
68-
| functionName | N | | Serverless Cloud Function Name |
69-
| serviceName | N | | API-Gateway service name, default to create a new serivce |
70-
| serviceId | N | | API-Gateway service id, if it has will use this APII-Gateway service |
71-
| src | N | `process.cwd()` | Default is current working directory, if it is object, refer to [code object](#code-object) |
72-
| layers | N | | Bind layers for scf, array of [Layer](#layer) |
73-
| exclude | N | | exclude file |
74-
| include | N | | include file, if relative path, should relative to `serverless.yml` |
75-
| [functionConf](#funtionConf) | N | | Function configure |
76-
| [apigatewayConf](#apigatewayConf) | N | | API-Gateway configure |
77-
| [cloudDNSConf](#cloudDNSConf) | N | | Special config for region |
78-
| [Region special config](#apigatewayConf) | N | | Special config for region. Use region name for key |
69+
| Param | Required | Default | Description |
70+
| ---------------------------------------- | :------: | :-------------: | :---------------------------------------------------------------------------------------- |
71+
| runtime | N | Nodejs10.15 | Function Runtime, support: Nodejs6.10, Nodejs8.9, Nodejs10.15 |
72+
| region | N | ap-guangzhou | Deploy region |
73+
| functionName | N | | Serverless Cloud Function Name |
74+
| serviceName | N | | API-Gateway service name, default to create a new serivce |
75+
| serviceId | N | | API-Gateway service id, if it has will use this APII-Gateway service |
76+
| src | N | `process.cwd()` | Default is current working directory, if it is object, refer to [src object](#src-object) |
77+
| layers | N | | Bind layers for scf, array of [Layer](#layer) |
78+
| exclude | N | | exclude file |
79+
| include | N | | include file, if relative path, should relative to `serverless.yml` |
80+
| [functionConf](#funtionConf) | N | | Function configure |
81+
| [apigatewayConf](#apigatewayConf) | N | | API-Gateway configure |
82+
| [cloudDNSConf](#cloudDNSConf) | N | | Special config for region |
83+
| [Region special config](#apigatewayConf) | N | | Special config for region. Use region name for key |
7984

8085
## src object
8186

82-
| Param | Required | Type | Default | Description |
83-
| ------ | :------: | :----: | :-----: | :----------------- |
84-
| src | N | String | | code path |
85-
| bucket | N | String | | bucket name |
86-
| object | N | String | | bucket object name |
87+
| Param | Required | Type | Default | Description |
88+
| ------- | :------: | :-------------: | :-----: | :---------------------------------------------------------------------------- |
89+
| src | N | String | | code path |
90+
| exclude | N | Array of String | | Exclude path or file, using [glob sytax](https://github.com/isaacs/node-glob) |
91+
| bucket | N | String | | bucket name |
92+
| object | N | String | | bucket object name |
8793

8894
## layer
8995

0 commit comments

Comments
 (0)