-
-
Notifications
You must be signed in to change notification settings - Fork 626
/
Group.js
186 lines (174 loc) · 3.25 KB
/
Group.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
'use strict'
/*
* adonis-framework
*
* (c) Harminder Virk <virk@adonisjs.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
const Macroable = require('macroable')
/**
* Route Group class is used to group routes with
* common behavior. For example prefixing a bunch
* of routes or applying middleware to a bunch
* of routes.
*
* An instance of group is obtained by calling the
* `Route.group` method on @ref('RouteManager')
* class.
*
* @class RouteGroup
* @group Http
* @constructor
*
* @example
* ```js
* const group = new RouteGroup([arrayOfRoutes], optionalName)
* ```
*/
class RouteGroup extends Macroable {
constructor (routes, name = null) {
super()
this._routes = routes
this._name = name
}
/**
* Give a name to a group of routes.
* This will prefix all routes name.
*
* @method as
*
* @chainable
*
* @example
* ```js
* Route
* .group()
* .as('admin')
* ```
*/
as (name) {
this._routes.forEach((route) => {
if (route.name.length > 0) {
route.name = `${name}.${route.name}`
}
})
return this
}
/**
* Add middleware to a group of routes.
* Also see @ref('Route/middleware').
*
* @method middleware
*
* @param {Array|String|Spread} middleware
*
* @chainable
*
* @example
* ```js
* Route
* .group()
* .middleware('auth')
* ```
*/
middleware (...middleware) {
this._routes.forEach((route) => route.prependMiddleware(...middleware))
return this
}
/**
* Namespace group of routes.
* Also see @ref('Route/namespace')
*
* @method namespace
*
* @param {String} namespace
*
* @chainable
*
* @example
* ```js
* Route
* .group()
* .namespace('Admin')
* ```
*/
namespace (namespace) {
this._routes.forEach((route) => route.namespace(namespace))
return this
}
/**
* Add formats to a group of routes.
* Also see @ref('Route/formats')
*
* @method formats
*
* @param {Array} formats
* @param {Boolean} [strict = false]
*
* @chainable
*
* @example
* ```js
* Route
* .group()
* .formats(['json', 'html'])
* ```
*/
formats (formats, strict = false) {
this._routes.forEach((route) => route.formats(formats, strict))
return this
}
/**
* Prefix group of routes.
* Also see @ref('Route/prefix')
*
* @method prefix
*
* @param {String} prefix
*
* @chainable
*
* @example
* ```js
* Route
* .group()
* .prefix('api/v1')
* ```
*/
prefix (prefix) {
this._routes.forEach((route) => route.prefix(prefix))
return this
}
/**
* Add domain to a group of routes.
* Also see @ref('Route/domain')
*
* @method domain
*
* @param {String} domain
*
* @chainable
*
* @example
* ```js
* Route
* .group()
* .domain('blog.adonisjs.com')
* ```
*/
domain (domain) {
this._routes.forEach((route) => route.domain(domain))
return this
}
}
/**
* Defining _macros and _getters property
* for Macroable class
*
* @type {Object}
*/
RouteGroup._macros = {}
RouteGroup._getters = {}
module.exports = RouteGroup