Skip to content

Commit

Permalink
chore: Fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Romakita committed Feb 26, 2020
1 parent f81d476 commit ea17926
Show file tree
Hide file tree
Showing 10 changed files with 10 additions and 8 deletions.
2 changes: 0 additions & 2 deletions docs/assets/middleware-call-sequence.svg

This file was deleted.

1 change: 1 addition & 0 deletions docs/assets/middleware-in-sequence.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<mxfile modified="2020-02-26T19:05:47.562Z" host="www.draw.io" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:72.0) Gecko/20100101 Firefox/72.0" etag="c9YXUEPpS20V46L8mika" version="12.7.8" type="device"><diagram id="DG_1D_lNAm6PYI5epRoH" name="Page-1">7Ztbc+I2FIB/DTPbBzq+Gz8GQpKdps2WbNLdp46wBXgjLCILAvn1lWz5hgx4A0FdAnmIdXSxdM75jmRZbpm96fKagNnkTxxA1DK0YNkyL1uGoeu6yf5xySqVOJqRCsYkDEShQnAfvkIh1IR0HgYwrhSkGCMazqpCH0cR9GlFBgjBL9ViI4yqd52BMZQE9z5AsvSfMKCTVNox3EJ+A8PxJLuz7nhpzhRkhcVI4gkI8EtJZPZbZo9gTNOr6bIHEVdeppe03tWG3LxjBEa0SYXwy8AxnowQPF0hf/j0t+XBH23TSptZADQXIxa9patMBQTPowDyVrSW2X2ZhBTez4DPc1+Y0ZlsQqeIpXR2OQoR6mGESVLXDGzYCSwmjynBT7CU0zGGpuOwHNEBSChcbhyaniuMeRrEU0jJihURFUxb6Fg4md4R6ZfCZIYmZJOSuazMzYBwk3HedqFJdiGUWa9Y0vYvLlev1nRw88fn1eD1bvnt37YrqREGzLFEEhM6wWMcAdQvpN2qoosytxjPhHp/QEpXghIwp7iqfLgM6Tde/XdbpL6Xci6XouUkscoSERtuqRJPfi/nFdWSVFZPMqimuVbg5QaVrMeUgefEh1uUJspxTVWJB2QM6RY33uAeBCJAw0W1sTpTi6pfcMi6nLtV7kaZW1l2tYm0X6LWmsPk3Xi7D+kSmz0UwqSHBD7PYUy3sKrvZnWzCUc4oldgGiI+8huIFpCGPthmW4nfjbCuKdW2JVR1qwZV8wCk1vuOoxJVvQRqge0RUL0sUJV4exO7RkNWjT1Z3SssZ70sMfUQwy4cYQIPDJPnuCZw5CkR6mxSdN8ZMsPU60PXMTBz7q4fnq8HD+41caA2uF08UrOt2zUrDQex23aDcMEuxzQZeiqK57NM9En/LZOyG5cy+B0j3iIDmPWJddzC0eco5PERLtI4GUPClJaMO+niECauNsULZlc2yihI0jPEzcqyV2k7w8Qh0rbSWw/JehdZZ2o6XiPaXXXN75iNadW5CIzDVzBMCnCiZ3zKSSxkd1v2JZPwCBOnwYZXACgcR+wawRFvijsO8y10IcSUR6luzJw5jMZfk5DVtg7jeZ5dcTzPk5diVt1S7N3iu2Gd4/vPxffNS6xqeN8SYY8Q37f1shRkrhEeAl5vGgYBgi9s6PGBI33gekNNkyP9aAQd398d6fd69llfo2rK11OeSt6UPfocmremyylTJW5bVlN94E/+ZyuqPfcY3CponnLQOmfQDgCa2RA0SyVo5tEeW/J9uU07eceEzDjmY0t9hFO6O3AykFkNIbNVQibvhTPITnkOM5TPYYZ9xusAeNkN8XJU4iVvAPWjYCa23G9AxJ7OyClPZqb6yUyX9Hum7edpcxrS5qqkzambzC5G9MQZUz+jGWfGDsCY25AxTyVj7kbGTn33w1I+l2UNK+KsRNkvva3faciZvu8Ri72M3ZFAq3nfVsxvjd6y/cI0rr/dtdXPeuZ51jsAjV5TGrV6/zgOjZ5E4wAyQzLwtORl/UFBc5LfNqDW37rZ/E9UKMnT3ztNh+oBVPvW7VSmw+w86E4COyoBzHpZIvCeETiA8QxHfMtS+2R8SA5t5ctS/cOfQHAs+cTPkR8NZBtka0Kuh4rinec5zjLa6QGqC1ZA78yWRWaLf1+QKbUQZhGoJErXmvf9wWN/UFqHprdtfNwrO73lMwuwaVU+v5V6UusNB8MIpixAYd6Ipx3G/vmRk2wPxpUdwKuxv/Fu9jcU279399fXwd3t7cfxAcPY7QO1QeD9nEB+Zb63E4yAX63wCEkAIrDbU66Sn+wp+RnRTHCF+TIaJttHGszfj+ReNFyveeqeZZnammfJU3zttz1v8CyWLL7HSr/iKL5qM/v/AQ==</diagram></mxfile>
Binary file added docs/assets/middleware-in-sequence.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/assets/middleware-in-sequence.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/docs/custom-endpoint-decorators.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ It's based on the middleware but this offer you more options and controller over

One of the usecase already implemented by Ts.ED is the @@AcceptMimesMiddleware@@:

<<< @/packages/common/src/mvc/components/AcceptMimesMiddleware.ts
<<< @/packages/common/src/mvc/middlewares/AcceptMimesMiddleware.ts

You can see in this example the usage of `endpoint.get` from @@EndpointInfo@@. This method contain all options
which can be passed to decorator associated to AcceptMimesMiddleware.
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/hooks.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar: false
prev: true
next: true
---
# Hooks

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/middlewares.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ It'll be played only when the url request match with the path associated to the
When a request is sent to the server all middlewares added in the @@ServerLoader@@, [Controller](/docs/controllers.md) or Endpoint with decorators
will be called while a response isn't sent by one of the handlers/middlewares in the stack.

<figure><img src="./../assets/middleware-call-sequence.svg" style="max-width:400px; padding:30px"></figure>
<figure><img src="./../assets/middleware-in-sequence.svg" style="max-width:400px; padding:30px"></figure>

::: tip Note (1)
Render middleware is called only when a the @@Render@@ decorator is used on the endpoint.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/middlewares/override/response-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

There is the current implementation of the @@ResponseViewMiddleware@@:

<<< @/packages/common/src/mvc/components/ResponseViewMiddleware.ts
<<< @/packages/common/src/mvc/middlewares/ResponseViewMiddleware.ts

But for some reason, this implementation isn't enough to meet your needs.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/middlewares/override/send-response.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

There is the current implementation of the @@SendResponseMiddleware@@:

<<< @/packages/common/src/mvc/components/SendResponseMiddleware.ts
<<< @/packages/common/src/platform/middlewares/SendResponseMiddleware.ts

But for some reason, this implementation isn't enough to meet your needs.

Expand Down
1 change: 0 additions & 1 deletion docs/docs/request-data-persistence.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
---
sidebar: false
prev: true
next: true
---
Expand Down

0 comments on commit ea17926

Please sign in to comment.