Skip to content

Commit 4a421a2

Browse files
committed
chore(docs): regenerate docs
1 parent 32e2b26 commit 4a421a2

File tree

8 files changed

+64
-51
lines changed

8 files changed

+64
-51
lines changed

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
[middleware-io](README.md)
1+
[middleware-io - v2.2.0](README.md)
22

3-
# middleware-io
3+
# middleware-io - v2.2.0
44

55
## Index
66

docs/classes/_composer_.composer.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
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)
22

33
# Class: Composer <**T**>
44

@@ -24,6 +24,7 @@ A simple middleware compose builder
2424
* [before](_composer_.composer.md#before)
2525
* [branch](_composer_.composer.md#branch)
2626
* [caught](_composer_.composer.md#caught)
27+
* [clone](_composer_.composer.md#clone)
2728
* [compose](_composer_.composer.md#compose)
2829
* [concurrency](_composer_.composer.md#concurrency)
2930
* [enforce](_composer_.composer.md#enforce)
@@ -40,15 +41,15 @@ A simple middleware compose builder
4041

4142
**middlewares**: *[Middleware](../modules/_types_.md#middleware)‹T›[]* = []
4243

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)*
4445

4546
## Methods
4647

4748
### after
4849

4950
**after**(`middleware`: [Middleware](../modules/_types_.md#middleware)‹T›, `afterMiddleware`: [Middleware](../modules/_types_.md#middleware)‹T›): *this*
5051

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)*
5253

5354
Runs the second middleware after the main
5455

@@ -67,7 +68,7 @@ ___
6768

6869
**before**(`middleware`: [Middleware](../modules/_types_.md#middleware)‹T›, `beforeMiddleware`: [Middleware](../modules/_types_.md#middleware)‹T›): *this*
6970

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)*
7172

7273
Runs the second middleware before the main
7374

@@ -86,7 +87,7 @@ ___
8687

8788
**branch**(`condition`: [BranchMiddlewareCondition](../modules/_types_.md#branchmiddlewarecondition)‹T›, `trueMiddleware`: [Middleware](../modules/_types_.md#middleware)‹T›, `falseMiddleware`: [Middleware](../modules/_types_.md#middleware)‹T›): *this*
8889

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)*
9091

9192
By condition splits the middleware
9293

@@ -106,7 +107,7 @@ ___
106107

107108
**caught**(`errorHandler`: [CaughtMiddlewareHandler](../modules/_types_.md#caughtmiddlewarehandler)‹T›): *this*
108109

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)*
110111

111112
Catches errors in the middleware chain
112113

@@ -120,11 +121,23 @@ Name | Type |
120121

121122
___
122123

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+
123136
### compose
124137

125138
**compose**(): *[Middleware](../modules/_types_.md#middleware)‹T›*
126139

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)*
128141

129142
Compose middleware handlers into a single handler
130143

@@ -136,7 +149,7 @@ ___
136149

137150
**concurrency**(`middlewares`: [Middleware](../modules/_types_.md#middleware)‹T›[]): *this*
138151

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)*
140153

141154
Concurrently launches middleware,
142155
the chain will continue if `next()` is called in all middlewares
@@ -155,7 +168,7 @@ ___
155168

156169
**enforce**(`middleware`: [Middleware](../modules/_types_.md#middleware)‹T›, `beforeMiddleware`: [Middleware](../modules/_types_.md#middleware)‹T›, `afterMiddleware`: [Middleware](../modules/_types_.md#middleware)‹T›): *this*
157170

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)*
159172

160173
Runs middleware before and after the main
161174

@@ -175,7 +188,7 @@ ___
175188

176189
**filter**(`condition`: [BranchMiddlewareCondition](../modules/_types_.md#branchmiddlewarecondition)‹T›, `filterMiddleware`: [Middleware](../modules/_types_.md#middleware)‹T›): *this*
177190

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)*
179192

180193
Conditionally runs middleware or stops the chain
181194

@@ -194,7 +207,7 @@ ___
194207

195208
**fork**(`middleware`: [Middleware](../modules/_types_.md#middleware)‹T›): *this*
196209

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)*
198211

199212
Runs the middleware at the next event loop and force call `next()`
200213

@@ -212,7 +225,7 @@ ___
212225

213226
**lazy**(`factory`: [LazyMiddlewareFactory](../modules/_types_.md#lazymiddlewarefactory)‹T›): *this*
214227

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)*
216229

217230
Lazily asynchronously gets middleware
218231

@@ -230,7 +243,7 @@ ___
230243

231244
**optional**(`condition`: [BranchMiddlewareCondition](../modules/_types_.md#branchmiddlewarecondition)‹T›, `optionalMiddleware`: [Middleware](../modules/_types_.md#middleware)‹T›): *this*
232245

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)*
234247

235248
Conditionally runs optional middleware or skips middleware
236249

@@ -249,7 +262,7 @@ ___
249262

250263
**tap**(`middleware`: [Middleware](../modules/_types_.md#middleware)‹T›): *this*
251264

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)*
253266

254267
Runs the middleware and force call `next()`
255268

@@ -267,7 +280,7 @@ ___
267280

268281
**use**(`middleware`: [Middleware](../modules/_types_.md#middleware)‹T›): *this*
269282

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)*
271284

272285
Adds middleware to the chain
273286

docs/modules/_compose_.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[middleware-io](../README.md)["compose"](_compose_.md)
1+
[middleware-io - v2.2.0](../README.md)["compose"](_compose_.md)
22

33
# External module: "compose"
44

@@ -14,7 +14,7 @@
1414

1515
**compose**<**T**>(`middlewares`: [Middleware](_types_.md#middleware)‹T›[]): *[Middleware](_types_.md#middleware)‹T›*
1616

17-
*Defined in [compose.ts:17](https://github.com/negezor/middleware-io/blob/c808840/src/compose.ts#L17)*
17+
*Defined in [compose.ts:17](https://github.com/negezor/middleware-io/blob/32e2b26/src/compose.ts#L17)*
1818

1919
Compose an array of middleware handlers into a single handler
2020

docs/modules/_composer_.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[middleware-io](../README.md)["composer"](_composer_.md)
1+
[middleware-io - v2.2.0](../README.md)["composer"](_composer_.md)
22

33
# External module: "composer"
44

docs/modules/_helpers_.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[middleware-io](../README.md)["helpers"](_helpers_.md)
1+
[middleware-io - v2.2.0](../README.md)["helpers"](_helpers_.md)
22

33
# External module: "helpers"
44

@@ -17,7 +17,7 @@
1717

1818
**assertMiddleware**(`middleware`: Function): *void*
1919

20-
*Defined in [helpers.ts:3](https://github.com/negezor/middleware-io/blob/c808840/src/helpers.ts#L3)*
20+
*Defined in [helpers.ts:3](https://github.com/negezor/middleware-io/blob/32e2b26/src/helpers.ts#L3)*
2121

2222
**Parameters:**
2323

@@ -33,7 +33,7 @@ ___
3333

3434
**assertMiddlewares**(`middlewares`: Function[]): *void*
3535

36-
*Defined in [helpers.ts:9](https://github.com/negezor/middleware-io/blob/c808840/src/helpers.ts#L9)*
36+
*Defined in [helpers.ts:9](https://github.com/negezor/middleware-io/blob/32e2b26/src/helpers.ts#L9)*
3737

3838
**Parameters:**
3939

@@ -49,7 +49,7 @@ ___
4949

5050
**noopNext**(): *Promise‹void›*
5151

52-
*Defined in [helpers.ts:29](https://github.com/negezor/middleware-io/blob/c808840/src/helpers.ts#L29)*
52+
*Defined in [helpers.ts:30](https://github.com/negezor/middleware-io/blob/32e2b26/src/helpers.ts#L30)*
5353

5454
Noop for call `next()` in middleware
5555

@@ -61,7 +61,7 @@ ___
6161

6262
**wrapMiddlewareNextCall**<**T**>(`context`: T, `middleware`: [Middleware](_types_.md#middleware)‹T›): *Promise‹boolean›*
6363

64-
*Defined in [helpers.ts:13](https://github.com/negezor/middleware-io/blob/c808840/src/helpers.ts#L13)*
64+
*Defined in [helpers.ts:13](https://github.com/negezor/middleware-io/blob/32e2b26/src/helpers.ts#L13)*
6565

6666
**Type parameters:**
6767

docs/modules/_index_.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[middleware-io](../README.md)["index"](_index_.md)
1+
[middleware-io - v2.2.0](../README.md)["index"](_index_.md)
22

33
# External module: "index"
44

docs/modules/_snippets_.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[middleware-io](../README.md)["snippets"](_snippets_.md)
1+
[middleware-io - v2.2.0](../README.md)["snippets"](_snippets_.md)
22

33
# External module: "snippets"
44

@@ -26,7 +26,7 @@
2626

2727
**getAfterMiddleware**<**T**>(`middleware`: [Middleware](_types_.md#middleware)‹T›, `afterMiddleware`: [Middleware](_types_.md#middleware)‹T›): *[Middleware](_types_.md#middleware)‹T›*
2828

29-
*Defined in [snippets.ts:217](https://github.com/negezor/middleware-io/blob/c808840/src/snippets.ts#L217)*
29+
*Defined in [snippets.ts:219](https://github.com/negezor/middleware-io/blob/32e2b26/src/snippets.ts#L219)*
3030

3131
Runs the second middleware after the main
3232

@@ -58,7 +58,7 @@ ___
5858

5959
**getBeforeMiddleware**<**T**>(`middleware`: [Middleware](_types_.md#middleware)‹T›, `beforeMiddleware`: [Middleware](_types_.md#middleware)‹T›): *[Middleware](_types_.md#middleware)‹T›*
6060

61-
*Defined in [snippets.ts:191](https://github.com/negezor/middleware-io/blob/c808840/src/snippets.ts#L191)*
61+
*Defined in [snippets.ts:193](https://github.com/negezor/middleware-io/blob/32e2b26/src/snippets.ts#L193)*
6262

6363
Runs the second middleware before the main
6464

@@ -90,7 +90,7 @@ ___
9090

9191
**getBranchMiddleware**<**T**>(`condition`: [BranchMiddlewareCondition](_types_.md#branchmiddlewarecondition)‹T›, `trueMiddleware`: [Middleware](_types_.md#middleware)‹T›, `falseMiddleware`: [Middleware](_types_.md#middleware)‹T›): *[Middleware](_types_.md#middleware)‹T›*
9292

93-
*Defined in [snippets.ts:114](https://github.com/negezor/middleware-io/blob/c808840/src/snippets.ts#L114)*
93+
*Defined in [snippets.ts:116](https://github.com/negezor/middleware-io/blob/32e2b26/src/snippets.ts#L116)*
9494

9595
By condition splits the middleware
9696

@@ -134,7 +134,7 @@ ___
134134

135135
**getCaughtMiddleware**<**T**>(`errorHandler`: [CaughtMiddlewareHandler](_types_.md#caughtmiddlewarehandler)‹T›): *[Middleware](_types_.md#middleware)‹T›*
136136

137-
*Defined in [snippets.ts:296](https://github.com/negezor/middleware-io/blob/c808840/src/snippets.ts#L296)*
137+
*Defined in [snippets.ts:298](https://github.com/negezor/middleware-io/blob/32e2b26/src/snippets.ts#L298)*
138138

139139
Catches errors in the middleware chain
140140

@@ -183,7 +183,7 @@ ___
183183

184184
**getConcurrencyMiddleware**<**T**>(`middlewares`: [Middleware](_types_.md#middleware)‹T›[]): *[Middleware](_types_.md#middleware)‹T›*
185185

186-
*Defined in [snippets.ts:325](https://github.com/negezor/middleware-io/blob/c808840/src/snippets.ts#L325)*
186+
*Defined in [snippets.ts:327](https://github.com/negezor/middleware-io/blob/32e2b26/src/snippets.ts#L327)*
187187

188188
Concurrently launches middleware,
189189
the chain will continue if `next()` is called in all middlewares
@@ -218,7 +218,7 @@ ___
218218

219219
**getEnforceMiddleware**<**T**>(`middleware`: [Middleware](_types_.md#middleware)‹T›, `beforeMiddleware`: [Middleware](_types_.md#middleware)‹T›, `afterMiddleware`: [Middleware](_types_.md#middleware)‹T›): *[Middleware](_types_.md#middleware)‹T›*
220220

221-
*Defined in [snippets.ts:243](https://github.com/negezor/middleware-io/blob/c808840/src/snippets.ts#L243)*
221+
*Defined in [snippets.ts:245](https://github.com/negezor/middleware-io/blob/32e2b26/src/snippets.ts#L245)*
222222

223223
Runs middleware before and after the main
224224

@@ -251,7 +251,7 @@ ___
251251

252252
**getFilterMiddleware**<**T**>(`condition`: [BranchMiddlewareCondition](_types_.md#branchmiddlewarecondition)‹T›, `filterMiddleware`: [Middleware](_types_.md#middleware)‹T›): *[Middleware](_types_.md#middleware)‹T*
253253

254-
*Defined in [snippets.ts:168](https://github.com/negezor/middleware-io/blob/c808840/src/snippets.ts#L168)*
254+
*Defined in [snippets.ts:170](https://github.com/negezor/middleware-io/blob/32e2b26/src/snippets.ts#L170)*
255255

256256
Conditionally runs middleware or stops the chain
257257

@@ -283,7 +283,7 @@ ___
283283

284284
**getForkMiddleware**<**T**>(`middleware`: [Middleware](_types_.md#middleware)‹T›): *[Middleware](_types_.md#middleware)‹T*
285285

286-
*Defined in [snippets.ts:83](https://github.com/negezor/middleware-io/blob/c808840/src/snippets.ts#L83)*
286+
*Defined in [snippets.ts:85](https://github.com/negezor/middleware-io/blob/32e2b26/src/snippets.ts#L85)*
287287

288288
Runs the middleware at the next event loop and force call `next()`
289289

@@ -313,7 +313,7 @@ ___
313313

314314
**getLazyMiddleware**<**T**>(`factory`: [LazyMiddlewareFactory](_types_.md#lazymiddlewarefactory)‹T›): *[Middleware](_types_.md#middleware)‹T*
315315

316-
*Defined in [snippets.ts:41](https://github.com/negezor/middleware-io/blob/c808840/src/snippets.ts#L41)*
316+
*Defined in [snippets.ts:43](https://github.com/negezor/middleware-io/blob/32e2b26/src/snippets.ts#L43)*
317317

318318
Lazily asynchronously gets middleware
319319

@@ -345,7 +345,7 @@ ___
345345

346346
**getOptionalMiddleware**<**T**>(`condition`: [BranchMiddlewareCondition](_types_.md#branchmiddlewarecondition)‹T›, `optionalMiddleware`: [Middleware](_types_.md#middleware)‹T›): *[Middleware](_types_.md#middleware)‹T*
347347

348-
*Defined in [snippets.ts:145](https://github.com/negezor/middleware-io/blob/c808840/src/snippets.ts#L145)*
348+
*Defined in [snippets.ts:147](https://github.com/negezor/middleware-io/blob/32e2b26/src/snippets.ts#L147)*
349349

350350
Conditionally runs optional middleware or skips middleware
351351

@@ -377,7 +377,7 @@ ___
377377

378378
**getTapMiddleware**<**T**>(`middleware`: [Middleware](_types_.md#middleware)‹T›): *[Middleware](_types_.md#middleware)‹T*
379379

380-
*Defined in [snippets.ts:64](https://github.com/negezor/middleware-io/blob/c808840/src/snippets.ts#L64)*
380+
*Defined in [snippets.ts:66](https://github.com/negezor/middleware-io/blob/32e2b26/src/snippets.ts#L66)*
381381

382382
Runs the middleware and force call `next()`
383383

@@ -407,7 +407,7 @@ ___
407407

408408
**skipMiddleware**<**T**>(`context`: T, `next`: [NextMiddleware](_types_.md#nextmiddleware)): *Promise‹[MiddlewareReturn](_types_.md#middlewarereturn)›*
409409

410-
*Defined in [snippets.ts:17](https://github.com/negezor/middleware-io/blob/c808840/src/snippets.ts#L17)*
410+
*Defined in [snippets.ts:17](https://github.com/negezor/middleware-io/blob/32e2b26/src/snippets.ts#L17)*
411411

412412
Call `next()` in middleware
413413

@@ -428,9 +428,9 @@ ___
428428

429429
### `Const` stopMiddleware
430430

431-
**stopMiddleware**<**T**>(`context`: T, `next`: [NextMiddleware](_types_.md#nextmiddleware)): *void*
431+
**stopMiddleware**<**T**>(`context`: T, `next`: [NextMiddleware](_types_.md#nextmiddleware)): *Promisevoid*
432432

433-
*Defined in [snippets.ts:26](https://github.com/negezor/middleware-io/blob/c808840/src/snippets.ts#L26)*
433+
*Defined in [snippets.ts:26](https://github.com/negezor/middleware-io/blob/32e2b26/src/snippets.ts#L26)*
434434

435435
Does not call `next()` in middleware
436436

@@ -445,4 +445,4 @@ Name | Type |
445445
`context` | T |
446446
`next` | [NextMiddleware](_types_.md#nextmiddleware) |
447447

448-
**Returns:** *void*
448+
**Returns:** *Promisevoid*

0 commit comments

Comments
 (0)