1
- [ middleware-io] ( ../README.md ) › [ "composer"] ( ../modules/_composer_.md ) › [ Composer] ( _composer_.composer.md )
1
+ [ middleware-io - v2.2.0 ] ( ../README.md ) › [ "composer"] ( ../modules/_composer_.md ) › [ Composer] ( _composer_.composer.md )
2
2
3
3
# Class: Composer <** T** >
4
4
@@ -24,6 +24,7 @@ A simple middleware compose builder
24
24
* [ before] ( _composer_.composer.md#before )
25
25
* [ branch] ( _composer_.composer.md#branch )
26
26
* [ caught] ( _composer_.composer.md#caught )
27
+ * [ clone] ( _composer_.composer.md#clone )
27
28
* [ compose] ( _composer_.composer.md#compose )
28
29
* [ concurrency] ( _composer_.composer.md#concurrency )
29
30
* [ enforce] ( _composer_.composer.md#enforce )
@@ -40,15 +41,15 @@ A simple middleware compose builder
40
41
41
42
• ** middlewares** : * [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›[ ] * = [ ]
42
43
43
- * Defined in [ composer.ts:30] ( https://github.com/negezor/middleware-io/blob/c808840 /src/composer.ts#L30 ) *
44
+ * Defined in [ composer.ts:30] ( https://github.com/negezor/middleware-io/blob/32e2b26 /src/composer.ts#L30 ) *
44
45
45
46
## Methods
46
47
47
48
### after
48
49
49
50
▸ ** after** (` middleware ` : [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›, ` afterMiddleware ` : [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›): * this*
50
51
51
- * Defined in [ composer.ts:143 ] ( https://github.com/negezor/middleware-io/blob/c808840 /src/composer.ts#L143 ) *
52
+ * Defined in [ composer.ts:154 ] ( https://github.com/negezor/middleware-io/blob/32e2b26 /src/composer.ts#L154 ) *
52
53
53
54
Runs the second middleware after the main
54
55
67
68
68
69
▸ ** before** (` middleware ` : [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›, ` beforeMiddleware ` : [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›): * this*
69
70
70
- * Defined in [ composer.ts:128 ] ( https://github.com/negezor/middleware-io/blob/c808840 /src/composer.ts#L128 ) *
71
+ * Defined in [ composer.ts:139 ] ( https://github.com/negezor/middleware-io/blob/32e2b26 /src/composer.ts#L139 ) *
71
72
72
73
Runs the second middleware before the main
73
74
86
87
87
88
▸ ** branch** (` condition ` : [ BranchMiddlewareCondition] ( ../modules/_types_.md#branchmiddlewarecondition ) ‹T›, ` trueMiddleware ` : [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›, ` falseMiddleware ` : [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›): * this*
88
89
89
- * Defined in [ composer.ts:79 ] ( https://github.com/negezor/middleware-io/blob/c808840 /src/composer.ts#L79 ) *
90
+ * Defined in [ composer.ts:90 ] ( https://github.com/negezor/middleware-io/blob/32e2b26 /src/composer.ts#L90 ) *
90
91
91
92
By condition splits the middleware
92
93
106
107
107
108
▸ ** caught** (` errorHandler ` : [ CaughtMiddlewareHandler] ( ../modules/_types_.md#caughtmiddlewarehandler ) ‹T›): * this*
108
109
109
- * Defined in [ composer.ts:175 ] ( https://github.com/negezor/middleware-io/blob/c808840 /src/composer.ts#L175 ) *
110
+ * Defined in [ composer.ts:186 ] ( https://github.com/negezor/middleware-io/blob/32e2b26 /src/composer.ts#L186 ) *
110
111
111
112
Catches errors in the middleware chain
112
113
@@ -120,11 +121,23 @@ Name | Type |
120
121
121
122
___
122
123
124
+ ### clone
125
+
126
+ ▸ ** clone** (): * [ Composer] ( _composer_.composer.md ) ‹T›*
127
+
128
+ * Defined in [ composer.ts:35] ( https://github.com/negezor/middleware-io/blob/32e2b26/src/composer.ts#L35 ) *
129
+
130
+ Clones a composer object
131
+
132
+ ** Returns:** * [ Composer] ( _composer_.composer.md ) ‹T›*
133
+
134
+ ___
135
+
123
136
### compose
124
137
125
138
▸ ** compose** (): * [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›*
126
139
127
- * Defined in [ composer.ts:200 ] ( https://github.com/negezor/middleware-io/blob/c808840 /src/composer.ts#L200 ) *
140
+ * Defined in [ composer.ts:211 ] ( https://github.com/negezor/middleware-io/blob/32e2b26 /src/composer.ts#L211 ) *
128
141
129
142
Compose middleware handlers into a single handler
130
143
136
149
137
150
▸ ** concurrency** (` middlewares ` : [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›[ ] ): * this*
138
151
139
- * Defined in [ composer.ts:187 ] ( https://github.com/negezor/middleware-io/blob/c808840 /src/composer.ts#L187 ) *
152
+ * Defined in [ composer.ts:198 ] ( https://github.com/negezor/middleware-io/blob/32e2b26 /src/composer.ts#L198 ) *
140
153
141
154
Concurrently launches middleware,
142
155
the chain will continue if ` next() ` is called in all middlewares
155
168
156
169
▸ ** enforce** (` middleware ` : [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›, ` beforeMiddleware ` : [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›, ` afterMiddleware ` : [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›): * this*
157
170
158
- * Defined in [ composer.ts:158 ] ( https://github.com/negezor/middleware-io/blob/c808840 /src/composer.ts#L158 ) *
171
+ * Defined in [ composer.ts:169 ] ( https://github.com/negezor/middleware-io/blob/32e2b26 /src/composer.ts#L169 ) *
159
172
160
173
Runs middleware before and after the main
161
174
175
188
176
189
▸ ** filter** (` condition ` : [ BranchMiddlewareCondition] ( ../modules/_types_.md#branchmiddlewarecondition ) ‹T›, ` filterMiddleware ` : [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›): * this*
177
190
178
- * Defined in [ composer.ts:113 ] ( https://github.com/negezor/middleware-io/blob/c808840 /src/composer.ts#L113 ) *
191
+ * Defined in [ composer.ts:124 ] ( https://github.com/negezor/middleware-io/blob/32e2b26 /src/composer.ts#L124 ) *
179
192
180
193
Conditionally runs middleware or stops the chain
181
194
194
207
195
208
▸ ** fork** (` middleware ` : [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›): * this*
196
209
197
- * Defined in [ composer.ts:68 ] ( https://github.com/negezor/middleware-io/blob/c808840 /src/composer.ts#L68 ) *
210
+ * Defined in [ composer.ts:79 ] ( https://github.com/negezor/middleware-io/blob/32e2b26 /src/composer.ts#L79 ) *
198
211
199
212
Runs the middleware at the next event loop and force call ` next() `
200
213
212
225
213
226
▸ ** lazy** (` factory ` : [ LazyMiddlewareFactory] ( ../modules/_types_.md#lazymiddlewarefactory ) ‹T›): * this*
214
227
215
- * Defined in [ composer.ts:46 ] ( https://github.com/negezor/middleware-io/blob/c808840 /src/composer.ts#L46 ) *
228
+ * Defined in [ composer.ts:57 ] ( https://github.com/negezor/middleware-io/blob/32e2b26 /src/composer.ts#L57 ) *
216
229
217
230
Lazily asynchronously gets middleware
218
231
230
243
231
244
▸ ** optional** (` condition ` : [ BranchMiddlewareCondition] ( ../modules/_types_.md#branchmiddlewarecondition ) ‹T›, ` optionalMiddleware ` : [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›): * this*
232
245
233
- * Defined in [ composer.ts:98 ] ( https://github.com/negezor/middleware-io/blob/c808840 /src/composer.ts#L98 ) *
246
+ * Defined in [ composer.ts:109 ] ( https://github.com/negezor/middleware-io/blob/32e2b26 /src/composer.ts#L109 ) *
234
247
235
248
Conditionally runs optional middleware or skips middleware
236
249
249
262
250
263
▸ ** tap** (` middleware ` : [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›): * this*
251
264
252
- * Defined in [ composer.ts:57 ] ( https://github.com/negezor/middleware-io/blob/c808840 /src/composer.ts#L57 ) *
265
+ * Defined in [ composer.ts:68 ] ( https://github.com/negezor/middleware-io/blob/32e2b26 /src/composer.ts#L68 ) *
253
266
254
267
Runs the middleware and force call ` next() `
255
268
267
280
268
281
▸ ** use** (` middleware ` : [ Middleware] ( ../modules/_types_.md#middleware ) ‹T›): * this*
269
282
270
- * Defined in [ composer.ts:35 ] ( https://github.com/negezor/middleware-io/blob/c808840 /src/composer.ts#L35 ) *
283
+ * Defined in [ composer.ts:46 ] ( https://github.com/negezor/middleware-io/blob/32e2b26 /src/composer.ts#L46 ) *
271
284
272
285
Adds middleware to the chain
273
286
0 commit comments