1- [ @ poppinss/http-server ] ( ../README.md ) > [ @poppinss/http-server ] ( ../modules/_poppinss_http_server .md ) > [ BriskRoute ] ( ../classes/_poppinss_http_server.briskroute.md )
1+ > ** [ @poppinss/http-server ] ( ../README .md ) **
22
3- # Class: BriskRoute
3+ [ Globals ] ( ../README.md ) / [ @ poppinss/http-server ] ( ../modules/_poppinss_http_server.md ) / [ BriskRoute] ( _poppinss_http_server.briskroute.md ) /
44
5- Brisk route enables you to expose expressive API for defining route handler.
5+ # Class: BriskRoute < ** Context ** >
66
7- For example: AdonisJs uses [ BriskRoute] ( _poppinss_http_server.briskroute.md ) ` Route.on().render() ` to render a view without defining a controller method or closure.
7+ Brisk route enables you to expose expressive API for
8+ defining route handler.
9+
10+ For example: AdonisJs uses [ BriskRoute] ( _poppinss_http_server.briskroute.md ) ` Route.on().render() `
11+ to render a view without defining a controller method or
12+ closure.
813
914## Type parameters
10- #### Context
15+
16+ ▪ ** Context**
17+
1118## Hierarchy
1219
13- ` Macroable `
20+ * ` Macroable `
1421
15- ** ↳ BriskRoute**
22+ * ** BriskRoute**
1623
1724## Implements
1825
19- * [ BriskRouteContract] ( ../interfaces/_poppinss_http_server.briskroutecontract.md ) < ` Context ` >
26+ * [ BriskRouteContract] ( ../interfaces/_poppinss_http_server.briskroutecontract.md ) ‹ * ` Context ` * ›
2027
2128## Index
2229
@@ -27,193 +34,192 @@ For example: AdonisJs uses [BriskRoute](_poppinss_http_server.briskroute.md) `Ro
2734### Properties
2835
2936* [ route] ( _poppinss_http_server.briskroute.md#route )
30- * [ _ getters] ( _poppinss_http_server.briskroute.md#_getters )
31- * [ _ macros] ( _poppinss_http_server.briskroute.md#_macros )
37+ * [ _ getters] ( _poppinss_http_server.briskroute.md#static-protected- _getters )
38+ * [ _ macros] ( _poppinss_http_server.briskroute.md#static-protected- _macros )
3239
3340### Methods
3441
3542* [ setHandler] ( _poppinss_http_server.briskroute.md#sethandler )
36- * [ getGetter] ( _poppinss_http_server.briskroute.md#getgetter )
37- * [ getMacro] ( _poppinss_http_server.briskroute.md#getmacro )
38- * [ getter] ( _poppinss_http_server.briskroute.md#getter )
39- * [ hasGetter] ( _poppinss_http_server.briskroute.md#hasgetter )
40- * [ hasMacro] ( _poppinss_http_server.briskroute.md#hasmacro )
41- * [ hydrate] ( _poppinss_http_server.briskroute.md#hydrate )
42- * [ macro] ( _poppinss_http_server.briskroute.md#macro )
43-
44- ---
43+ * [ getGetter] ( _poppinss_http_server.briskroute.md#static-getgetter )
44+ * [ getMacro] ( _poppinss_http_server.briskroute.md#static-getmacro )
45+ * [ getter] ( _poppinss_http_server.briskroute.md#static-getter )
46+ * [ hasGetter] ( _poppinss_http_server.briskroute.md#static-hasgetter )
47+ * [ hasMacro] ( _poppinss_http_server.briskroute.md#static-hasmacro )
48+ * [ hydrate] ( _poppinss_http_server.briskroute.md#static-hydrate )
49+ * [ macro] ( _poppinss_http_server.briskroute.md#static-macro )
4550
4651## Constructors
4752
48- <a id =" constructor " ></a >
49-
5053### constructor
5154
52- ⊕ ** new BriskRoute** (_ pattern: * ` string ` * , _ namespace: * ` string ` * , _ globalMatchers: * [ RouteMatchers] ( ../modules/_poppinss_http_server.md#routematchers ) * ): [ BriskRoute] ( _poppinss_http_server.briskroute.md )
55+ \+ ** new BriskRoute** (` _pattern ` : string, ` _namespace ` : string, ` _globalMatchers ` : [ RouteMatchers] ( ../modules/_poppinss_http_server.md#routematchers ) ): * [ BriskRoute] ( _poppinss_http_server.briskroute.md ) *
5356
5457** Parameters:**
5558
56- | Name | Type |
57- | ------ | ------ |
58- | _ pattern | ` string ` |
59- | _ namespace | ` string ` |
60- | _ globalMatchers | [ RouteMatchers] ( ../modules/_poppinss_http_server.md#routematchers ) |
59+ Name | Type |
60+ ------ | ------ |
61+ ` _pattern ` | string |
62+ ` _namespace ` | string |
63+ ` _globalMatchers ` | [ RouteMatchers] ( ../modules/_poppinss_http_server.md#routematchers ) |
6164
62- ** Returns:** [ BriskRoute] ( _poppinss_http_server.briskroute.md )
63-
64- ___
65+ ** Returns:** * [ BriskRoute] ( _poppinss_http_server.briskroute.md ) *
6566
6667## Properties
6768
68- <a id =" route " ></a >
69-
7069### route
7170
72- ** ● route** : * ` null ` \| [ Route] ( _poppinss_http_server.route.md ) <` Context ` >* = null
71+ • ** route** : * null | [ Route] ( _poppinss_http_server.route.md ) ‹* ` Context ` * ›* = null
72+
73+ * Implementation of [ BriskRouteContract] ( ../interfaces/_poppinss_http_server.briskroutecontract.md ) .[ route] ( ../interfaces/_poppinss_http_server.briskroutecontract.md#route ) *
7374
7475Reference to route instance. Set after ` setHandler ` is called
7576
7677___
77- <a id =" _getters " ></a >
7878
79- ### ` < Static>``< Protected> ` _ getters
79+ ### ` Static ` ` Protected ` _ getters
8080
81- ** ● _ getters** : * ` object ` *
81+ ▪ ** _ getters** : * object*
8282
83- #### Type declaration
83+ * Overrides void*
84+
85+ #### Type declaration:
8486
8587___
86- <a id =" _macros " ></a >
8788
88- ### ` < Static>``< Protected> ` _ macros
89+ ### ` Static ` ` Protected ` _ macros
8990
90- ** ● _ macros** : * ` object ` *
91+ ▪ ** _ macros** : * object*
9192
92- #### Type declaration
93+ * Overrides void *
9394
94- ___
95+ #### Type declaration:
9596
9697## Methods
9798
98- <a id =" sethandler " ></a >
99-
10099### setHandler
101100
102- ▸ ** setHandler** (handler: * [ RouteHandlerNode] ( ../modules/_poppinss_http_server.md#routehandlernode ) < ` Context ` > * , invokedBy: * ` string ` * , methods?: * ` string ` [ ] * ): [ Route] ( _poppinss_http_server.route.md ) < ` Context ` >
101+ ▸ ** setHandler** (` handler ` : [ RouteHandlerNode] ( ../modules/_poppinss_http_server.md#routehandlernode ) ‹ * ` Context ` * ›, ` invokedBy ` : string, ` methods? ` : string[ ] ): * [ Route] ( _poppinss_http_server.route.md ) ‹ * ` Context ` * › *
103102
104- Set handler for the brisk route. The ` invokedBy ` string is the reference to the method that calls this method. It is required to create human readable error message when ` setHandler ` is called for multiple times.
103+ Set handler for the brisk route. The ` invokedBy ` string is the reference
104+ to the method that calls this method. It is required to create human
105+ readable error message when ` setHandler ` is called for multiple
106+ times.
105107
106108** Parameters:**
107109
108- | Name | Type |
109- | ------ | ------ |
110- | handler | [ RouteHandlerNode] ( ../modules/_poppinss_http_server.md#routehandlernode ) < ` Context ` > |
111- | invokedBy | ` string ` |
112- | ` Optional ` methods | ` string ` [ ] |
110+ Name | Type |
111+ ------ | ------ |
112+ ` handler ` | [ RouteHandlerNode] ( ../modules/_poppinss_http_server.md#routehandlernode ) ‹ * ` Context ` * › |
113+ ` invokedBy ` | string |
114+ ` methods? ` | string[ ] |
113115
114- ** Returns:** [ Route] ( _poppinss_http_server.route.md ) < ` Context ` >
116+ ** Returns:** * [ Route] ( _poppinss_http_server.route.md ) ‹ * ` Context ` * › *
115117
116118___
117- <a id =" getgetter " ></a >
118119
119- ### ` <Static> ` getGetter
120+ ### ` Static ` getGetter
121+
122+ ▸ ** getGetter** (` name ` : string): * ` MacroableFn ` | undefined*
120123
121- ▸ ** getGetter ** (name: * ` string ` * ): ` MacroableFn ` \| ` undefined `
124+ * Inherited from void *
122125
123126** Parameters:**
124127
125- | Name | Type |
126- | ------ | ------ |
127- | name | ` string ` |
128+ Name | Type |
129+ ------ | ------ |
130+ ` name ` | string |
128131
129- ** Returns:** ` MacroableFn ` \| ` undefined `
132+ ** Returns:** * ` MacroableFn ` | undefined*
130133
131134___
132- <a id =" getmacro " ></a >
133135
134- ### ` <Static> ` getMacro
136+ ### ` Static ` getMacro
137+
138+ ▸ ** getMacro** (` name ` : string): * ` MacroableFn ` | undefined*
135139
136- ▸ ** getMacro ** (name: * ` string ` * ): ` MacroableFn ` \| ` undefined `
140+ * Inherited from void *
137141
138142** Parameters:**
139143
140- | Name | Type |
141- | ------ | ------ |
142- | name | ` string ` |
144+ Name | Type |
145+ ------ | ------ |
146+ ` name ` | string |
143147
144- ** Returns:** ` MacroableFn ` \| ` undefined `
148+ ** Returns:** * ` MacroableFn ` | undefined*
145149
146150___
147- <a id =" getter " ></a >
148151
149- ### ` < Static> ` getter
152+ ### ` Static ` getter
150153
151- ▸ ** getter** (name: * ` string ` * , callback: * ` MacroableFn ` * , singleton?: * ` undefined ` \| ` false ` \| ` true ` * ): ` void `
154+ ▸ ** getter** (` name ` : string, ` callback ` : ` MacroableFn ` , ` singleton? ` : undefined | false | true): * void*
155+
156+ * Inherited from void*
152157
153158** Parameters:**
154159
155- | Name | Type |
156- | ------ | ------ |
157- | name | ` string ` |
158- | callback | ` MacroableFn ` |
159- | ` Optional ` singleton | ` undefined ` \| ` false ` \| ` true ` |
160+ Name | Type |
161+ ------ | ------ |
162+ ` name ` | string |
163+ ` callback ` | ` MacroableFn ` |
164+ ` singleton? ` | undefined \| false \| true |
160165
161- ** Returns:** ` void `
166+ ** Returns:** * void*
162167
163168___
164- <a id =" hasgetter " ></a >
165169
166- ### ` <Static> ` hasGetter
170+ ### ` Static ` hasGetter
171+
172+ ▸ ** hasGetter** (` name ` : string): * boolean*
167173
168- ▸ ** hasGetter ** (name: * ` string ` * ): ` boolean `
174+ * Inherited from void *
169175
170176** Parameters:**
171177
172- | Name | Type |
173- | ------ | ------ |
174- | name | ` string ` |
178+ Name | Type |
179+ ------ | ------ |
180+ ` name ` | string |
175181
176- ** Returns:** ` boolean `
182+ ** Returns:** * boolean*
177183
178184___
179- <a id =" hasmacro " ></a >
180185
181- ### ` <Static> ` hasMacro
186+ ### ` Static ` hasMacro
187+
188+ ▸ ** hasMacro** (` name ` : string): * boolean*
182189
183- ▸ ** hasMacro ** (name: * ` string ` * ): ` boolean `
190+ * Inherited from void *
184191
185192** Parameters:**
186193
187- | Name | Type |
188- | ------ | ------ |
189- | name | ` string ` |
194+ Name | Type |
195+ ------ | ------ |
196+ ` name ` | string |
190197
191- ** Returns:** ` boolean `
198+ ** Returns:** * boolean*
192199
193200___
194- <a id =" hydrate " ></a >
195201
196- ### ` < Static> ` hydrate
202+ ### ` Static ` hydrate
197203
198- ▸ ** hydrate** (): ` void `
204+ ▸ ** hydrate** (): * void*
199205
200- ** Returns: ** ` void `
206+ * Inherited from void*
201207
202- ___
203- <a id =" macro " ></a >
208+ ** Returns:** * void*
204209
205- ### ` <Static> ` macro
210+ ___
206211
207- ▸ ** macro ** (name: * ` string ` * , callback: * ` MacroableFn ` * ): ` void `
212+ ### ` Static ` macro
208213
209- ** Parameters: * *
214+ ▸ ** macro ** ( ` name ` : string, ` callback ` : ` MacroableFn ` ): * void *
210215
211- | Name | Type |
212- | ------ | ------ |
213- | name | ` string ` |
214- | callback | ` MacroableFn ` |
216+ * Inherited from void*
215217
216- ** Returns :** ` void `
218+ ** Parameters :**
217219
218- ___
220+ Name | Type |
221+ ------ | ------ |
222+ ` name ` | string |
223+ ` callback ` | ` MacroableFn ` |
219224
225+ ** Returns:** * void*
0 commit comments