Skip to content

Commit dffbe8f

Browse files
committed
add cors to SetRouter options
1 parent cf8e78b commit dffbe8f

15 files changed

+135
-61
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -163,14 +163,18 @@ class Greeting {
163163
}
164164
}
165165

166-
const endpoints = [new Greeting()];
166+
const cors = {
167+
validOrigins: ['http://localhost:8080'],
168+
responseHeaders: ['content-type']
169+
};
167170

168171
const configRouter: IRouterOptions = {
169-
road: app,
170-
endpoints,
171172
connectionMode: true,
173+
cors,
174+
endpoints,
175+
road: app,
172176
verbose: true,
173-
}
177+
};
174178

175179
new SetRouter(configRouter);
176180
```
@@ -180,7 +184,10 @@ import {Road, middleware} from "spiel-server";
180184

181185
const app = new Road();
182186

183-
app.use(middleware.cors(['http://localhost:8080'], ['authorization']));
187+
app.use(middleware.cors({
188+
validOrigins: ['http://localhost:8080'],
189+
responseHeaders: ['content-type']
190+
}));
184191
```
185192
About the Roads Api see [in Roads docs](https://github.com/Dashron/roads#index)
186193

@@ -296,8 +303,14 @@ class Greeting {
296303

297304
const endpoints = [new User(), new Greeting()];
298305

306+
const cors = {
307+
validOrigins: ['http://localhost:8080'],
308+
responseHeaders: ['content-type']
309+
};
310+
299311
const configRouter: IRouterOptions = {
300312
connectionMode: true,
313+
cors,
301314
endpoints,
302315
road: app,
303316
verbose: true,

READMEAPI.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -160,14 +160,18 @@ class Greeting {
160160
}
161161
}
162162

163-
const endpoints = [new Greeting()];
163+
const cors = {
164+
validOrigins: ['http://localhost:8080'],
165+
responseHeaders: ['content-type']
166+
};
164167

165168
const configRouter: IRouterOptions = {
166-
road: app,
167-
endpoints,
168169
connectionMode: true,
170+
cors,
171+
endpoints,
172+
road: app,
169173
verbose: true,
170-
}
174+
};
171175

172176
new SetRouter(configRouter);
173177
```
@@ -177,7 +181,10 @@ import {Road, middleware} from "spiel-server";
177181

178182
const app = new Road();
179183

180-
app.use(middleware.cors(['http://localhost:8080'], ['authorization']));
184+
app.use(middleware.cors({
185+
validOrigins: ['http://localhost:8080'],
186+
responseHeaders: ['content-type']
187+
}));
181188
```
182189
About the Roads Api see [in Roads docs](https://github.com/Dashron/roads#index)
183190

@@ -293,8 +300,14 @@ class Greeting {
293300

294301
const endpoints = [new User(), new Greeting()];
295302

303+
const cors = {
304+
validOrigins: ['http://localhost:8080'],
305+
responseHeaders: ['content-type']
306+
};
307+
296308
const configRouter: IRouterOptions = {
297309
connectionMode: true,
310+
cors,
298311
endpoints,
299312
road: app,
300313
verbose: true,

docs/assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/_server_set_router_.setrouter.html

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ <h3>constructor</h3>
136136
<li class="tsd-description">
137137
<aside class="tsd-sources">
138138
<ul>
139-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/set-router.ts#L14">server/set-router.ts:14</a></li>
139+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/set-router.ts#L14">server/set-router.ts:14</a></li>
140140
</ul>
141141
</aside>
142142
<div class="tsd-comment tsd-typography">
@@ -165,7 +165,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> Router<wbr>Connect<
165165
<div class="tsd-signature tsd-kind-icon">Router<wbr>Connect<span class="tsd-signature-symbol">:</span> <a href="../modules/_server_helpers_interfaces_.html#endpointsconnect" class="tsd-signature-type">EndpointsConnect</a><span class="tsd-signature-symbol"> =&nbsp;[]</span></div>
166166
<aside class="tsd-sources">
167167
<ul>
168-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/set-router.ts#L11">server/set-router.ts:11</a></li>
168+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/set-router.ts#L11">server/set-router.ts:11</a></li>
169169
</ul>
170170
</aside>
171171
</section>
@@ -175,7 +175,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> connection<wbr>Mode
175175
<div class="tsd-signature tsd-kind-icon">connection<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
176176
<aside class="tsd-sources">
177177
<ul>
178-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/set-router.ts#L13">server/set-router.ts:13</a></li>
178+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/set-router.ts#L13">server/set-router.ts:13</a></li>
179179
</ul>
180180
</aside>
181181
</section>
@@ -185,7 +185,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> endpoints</h3>
185185
<div class="tsd-signature tsd-kind-icon">endpoints<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_server_helpers_interfaces_.iendpoint.html" class="tsd-signature-type">IEndpoint</a><span class="tsd-signature-symbol">[]</span></div>
186186
<aside class="tsd-sources">
187187
<ul>
188-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/set-router.ts#L9">server/set-router.ts:9</a></li>
188+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/set-router.ts#L9">server/set-router.ts:9</a></li>
189189
</ul>
190190
</aside>
191191
</section>
@@ -195,7 +195,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> road</h3>
195195
<div class="tsd-signature tsd-kind-icon">road<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Road</span></div>
196196
<aside class="tsd-sources">
197197
<ul>
198-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/set-router.ts#L12">server/set-router.ts:12</a></li>
198+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/set-router.ts#L12">server/set-router.ts:12</a></li>
199199
</ul>
200200
</aside>
201201
</section>
@@ -205,7 +205,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> router</h3>
205205
<div class="tsd-signature tsd-kind-icon">router<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SimpleRouter</span></div>
206206
<aside class="tsd-sources">
207207
<ul>
208-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/set-router.ts#L10">server/set-router.ts:10</a></li>
208+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/set-router.ts#L10">server/set-router.ts:10</a></li>
209209
</ul>
210210
</aside>
211211
</section>
@@ -215,7 +215,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> verbose</h3>
215215
<div class="tsd-signature tsd-kind-icon">verbose<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
216216
<aside class="tsd-sources">
217217
<ul>
218-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/set-router.ts#L14">server/set-router.ts:14</a></li>
218+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/set-router.ts#L14">server/set-router.ts:14</a></li>
219219
</ul>
220220
</aside>
221221
</section>
@@ -232,7 +232,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> build<wbr>After<wbr>Mid
232232
<li class="tsd-description">
233233
<aside class="tsd-sources">
234234
<ul>
235-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/set-router.ts#L111">server/set-router.ts:111</a></li>
235+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/set-router.ts#L115">server/set-router.ts:115</a></li>
236236
</ul>
237237
</aside>
238238
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -255,7 +255,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> build<wbr>Before<wbr>Mi
255255
<li class="tsd-description">
256256
<aside class="tsd-sources">
257257
<ul>
258-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/set-router.ts#L105">server/set-router.ts:105</a></li>
258+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/set-router.ts#L109">server/set-router.ts:109</a></li>
259259
</ul>
260260
</aside>
261261
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -278,7 +278,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> getendpoints</h3>
278278
<li class="tsd-description">
279279
<aside class="tsd-sources">
280280
<ul>
281-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/set-router.ts#L71">server/set-router.ts:71</a></li>
281+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/set-router.ts#L75">server/set-router.ts:75</a></li>
282282
</ul>
283283
</aside>
284284
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -295,7 +295,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> info<wbr>Request</h
295295
<li class="tsd-description">
296296
<aside class="tsd-sources">
297297
<ul>
298-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/set-router.ts#L43">server/set-router.ts:43</a></li>
298+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/set-router.ts#L47">server/set-router.ts:47</a></li>
299299
</ul>
300300
</aside>
301301
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -312,7 +312,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> set<wbr>Connection<
312312
<li class="tsd-description">
313313
<aside class="tsd-sources">
314314
<ul>
315-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/set-router.ts#L65">server/set-router.ts:65</a></li>
315+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/set-router.ts#L69">server/set-router.ts:69</a></li>
316316
</ul>
317317
</aside>
318318
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -329,7 +329,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> set<wbr>Router<wbr>
329329
<li class="tsd-description">
330330
<aside class="tsd-sources">
331331
<ul>
332-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/set-router.ts#L50">server/set-router.ts:50</a></li>
332+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/set-router.ts#L54">server/set-router.ts:54</a></li>
333333
</ul>
334334
</aside>
335335
<h4 class="tsd-parameters-title">Parameters</h4>

docs/index.html

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -220,14 +220,18 @@ <h3 id="setting-the-router">Setting the router</h3>
220220
}
221221
}
222222

223-
<span class="hljs-keyword">const</span> endpoints = [<span class="hljs-keyword">new</span> Greeting()];
223+
<span class="hljs-keyword">const</span> cors = {
224+
validOrigins: [<span class="hljs-string">'http://localhost:8080'</span>],
225+
responseHeaders: [<span class="hljs-string">'content-type'</span>]
226+
};
224227

225228
<span class="hljs-keyword">const</span> configRouter: IRouterOptions = {
226-
road: app,
227-
endpoints,
228229
connectionMode: <span class="hljs-literal">true</span>,
230+
cors,
231+
endpoints,
232+
road: app,
229233
verbose: <span class="hljs-literal">true</span>,
230-
}
234+
};
231235

232236
<span class="hljs-keyword">new</span> SetRouter(configRouter);
233237
</code></pre>
@@ -236,7 +240,10 @@ <h3 id="using-the-roads-api">Using the roads API</h3>
236240

237241
<span class="hljs-keyword">const</span> app = <span class="hljs-keyword">new</span> Road();
238242

239-
app.use(middleware.cors([<span class="hljs-string">'http://localhost:8080'</span>], [<span class="hljs-string">'authorization'</span>]));
243+
app.use(middleware.cors({
244+
validOrigins: [<span class="hljs-string">'http://localhost:8080'</span>],
245+
responseHeaders: [<span class="hljs-string">'content-type'</span>]
246+
}));
240247
</code></pre>
241248
<p>About the Roads Api see <a href="https://github.com/Dashron/roads#index">in Roads docs</a></p>
242249
<h3 id="complete-example-with-server">Complete example with Server</h3>
@@ -350,8 +357,14 @@ <h3 id="complete-example-with-server">Complete example with Server</h3>
350357

351358
<span class="hljs-keyword">const</span> endpoints = [<span class="hljs-keyword">new</span> User(), <span class="hljs-keyword">new</span> Greeting()];
352359

360+
<span class="hljs-keyword">const</span> cors = {
361+
validOrigins: [<span class="hljs-string">'http://localhost:8080'</span>],
362+
responseHeaders: [<span class="hljs-string">'content-type'</span>]
363+
};
364+
353365
<span class="hljs-keyword">const</span> configRouter: IRouterOptions = {
354366
connectionMode: <span class="hljs-literal">true</span>,
367+
cors,
355368
endpoints,
356369
road: app,
357370
verbose: <span class="hljs-literal">true</span>,

docs/interfaces/_server_helpers_interfaces_.iendpoints.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <h3>name</h3>
9999
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100100
<aside class="tsd-sources">
101101
<ul>
102-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/helpers/interfaces.ts#L23">server/helpers/interfaces.ts:23</a></li>
102+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/helpers/interfaces.ts#L23">server/helpers/interfaces.ts:23</a></li>
103103
</ul>
104104
</aside>
105105
</section>
@@ -109,7 +109,7 @@ <h3>props</h3>
109109
<div class="tsd-signature tsd-kind-icon">props<span class="tsd-signature-symbol">:</span> <a href="_server_helpers_interfaces_.irouteprops.html" class="tsd-signature-type">IRouteProps</a><span class="tsd-signature-symbol">[]</span></div>
110110
<aside class="tsd-sources">
111111
<ul>
112-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/helpers/interfaces.ts#L24">server/helpers/interfaces.ts:24</a></li>
112+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/helpers/interfaces.ts#L24">server/helpers/interfaces.ts:24</a></li>
113113
</ul>
114114
</aside>
115115
</section>

docs/interfaces/_server_helpers_interfaces_.iroutemethod.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <h3>method</h3>
9999
<div class="tsd-signature tsd-kind-icon">method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100100
<aside class="tsd-sources">
101101
<ul>
102-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/helpers/interfaces.ts#L13">server/helpers/interfaces.ts:13</a></li>
102+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/helpers/interfaces.ts#L13">server/helpers/interfaces.ts:13</a></li>
103103
</ul>
104104
</aside>
105105
</section>
@@ -109,7 +109,7 @@ <h3>path</h3>
109109
<div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
110110
<aside class="tsd-sources">
111111
<ul>
112-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/helpers/interfaces.ts#L12">server/helpers/interfaces.ts:12</a></li>
112+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/helpers/interfaces.ts#L12">server/helpers/interfaces.ts:12</a></li>
113113
</ul>
114114
</aside>
115115
</section>

docs/interfaces/_server_helpers_interfaces_.irouteprops.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ <h3>method</h3>
100100
<div class="tsd-signature tsd-kind-icon">method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
101101
<aside class="tsd-sources">
102102
<ul>
103-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/helpers/interfaces.ts#L18">server/helpers/interfaces.ts:18</a></li>
103+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/helpers/interfaces.ts#L18">server/helpers/interfaces.ts:18</a></li>
104104
</ul>
105105
</aside>
106106
</section>
@@ -110,7 +110,7 @@ <h3>name</h3>
110110
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
111111
<aside class="tsd-sources">
112112
<ul>
113-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/helpers/interfaces.ts#L19">server/helpers/interfaces.ts:19</a></li>
113+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/helpers/interfaces.ts#L19">server/helpers/interfaces.ts:19</a></li>
114114
</ul>
115115
</aside>
116116
</section>
@@ -120,7 +120,7 @@ <h3>path</h3>
120120
<div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
121121
<aside class="tsd-sources">
122122
<ul>
123-
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/a5e07ed/src/server/helpers/interfaces.ts#L17">server/helpers/interfaces.ts:17</a></li>
123+
<li>Defined in <a href="https://github.com/spieljs/spiel-server/blob/cf8e78b/src/server/helpers/interfaces.ts#L17">server/helpers/interfaces.ts:17</a></li>
124124
</ul>
125125
</aside>
126126
</section>

0 commit comments

Comments
 (0)