Skip to content

Commit 5ab6e17

Browse files
committed
Add more descriptions to schema
1 parent e9c4ceb commit 5ab6e17

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

lib/optionsSchema.json

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@
1010
"type": "boolean"
1111
},
1212
"lazy": {
13-
"description": "TODO.",
13+
"description": "Disables watch mode and recompiles bundle only on a request.",
1414
"type": "boolean"
1515
},
1616
"host": {
17-
"description": "TODO.",
17+
"description": "The host the server listens to.",
1818
"type": "string"
1919
},
2020
"filename": {
21-
"description": "TODO.",
21+
"description": "The filename that needs to be requested in order to trigger a recompile (only in lazy mode).",
2222
"type": "string"
2323
},
2424
"outputPath": {
@@ -30,31 +30,31 @@
3030
"type": "string"
3131
},
3232
"port": {
33-
"description": "TODO.",
33+
"description": "The port the server listens to.",
3434
"type": "number"
3535
},
3636
"socket": {
37-
"description": "TODO.",
37+
"description": "The Unix socket to listen to (instead of on a host).",
3838
"type": "string"
3939
},
4040
"watchOptions": {
41-
"description": "TODO.",
41+
"description": "Options for changing the watch behavior.",
4242
"type": "object"
4343
},
4444
"headers": {
45-
"description": "TODO.",
45+
"description": "Response headers that are added to each response.",
4646
"type": "object"
4747
},
4848
"clientLogLevel": {
49-
"description": "TODO.",
49+
"description": "Controls the log messages shown in the browser.",
5050
"enum": [
5151
"info",
5252
"warning",
5353
"error"
5454
]
5555
},
5656
"key": {
57-
"description": "TODO.",
57+
"description": "The contents of a SSL key.",
5858
"anyOf": [
5959
{
6060
"type": "string"
@@ -65,7 +65,7 @@
6565
]
6666
},
6767
"cert": {
68-
"description": "TODO.",
68+
"description": "The contents of a SSL certificate.",
6969
"anyOf": [
7070
{
7171
"type": "string"
@@ -76,7 +76,7 @@
7676
]
7777
},
7878
"ca": {
79-
"description": "TODO.",
79+
"description": "The contents of a SSL CA certificate.",
8080
"anyOf": [
8181
{
8282
"type": "string"
@@ -87,7 +87,7 @@
8787
]
8888
},
8989
"pfx": {
90-
"description": "TODO.",
90+
"description": "The contents of a SSL pfx file.",
9191
"anyOf": [
9292
{
9393
"type": "string"
@@ -98,7 +98,7 @@
9898
]
9999
},
100100
"pfxPassphrase": {
101-
"description": "TODO.",
101+
"description": "The passphrase to a (SSL) PFX file.",
102102
"type": "string"
103103
},
104104
"inline": {
@@ -110,7 +110,7 @@
110110
"type": "string"
111111
},
112112
"https": {
113-
"description": "TODO.",
113+
"description": "Enable HTTPS for server.",
114114
"anyOf": [
115115
{
116116
"type": "object"
@@ -121,7 +121,7 @@
121121
]
122122
},
123123
"contentBase": {
124-
"description": "TODO.",
124+
"description": "A directory to serve files non-webpack files from.",
125125
"anyOf": [
126126
{
127127
"type": "array"
@@ -135,19 +135,19 @@
135135
]
136136
},
137137
"watchContentBase": {
138-
"description": "TODO.",
138+
"description": "Watches the contentBase directory for changes.",
139139
"type": "boolean"
140140
},
141141
"open": {
142-
"description": "TODO.",
142+
"description": "Let the CLI open your browser with the URL.",
143143
"type": "boolean"
144144
},
145145
"features": {
146146
"description": "TODO.",
147147
"type": "array"
148148
},
149149
"compress": {
150-
"description": "TODO.",
150+
"description": "Gzip compression for all requests.",
151151
"type": "boolean"
152152
},
153153
"proxy": {
@@ -176,15 +176,15 @@
176176
]
177177
},
178178
"staticOptions": {
179-
"description": "TODO.",
179+
"description": "Options for static files served with contentBase.",
180180
"type": "object"
181181
},
182182
"setup": {
183-
"description": "TODO.",
183+
"description": "Exposes the Express server to add custom middleware or routes.",
184184
"instanceof": "Function"
185185
},
186186
"stats": {
187-
"description": "Used by the webpack CLI program to pass stats options.",
187+
"description": "Decides what bundle information is displayed.",
188188
"anyOf": [
189189
{
190190
"type": "object"

0 commit comments

Comments
 (0)