fix: Documentation details blocks

adrien2p · Feb 9, 2022 · 50b7ce6 · 50b7ce6
1 parent af1ea6d
commit 50b7ce6
Show file tree

Hide file tree

Showing 29 changed files with 568 additions and 590 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/classes/Medusa.Medusa-1.md b/docs/classes/Medusa.Medusa-1.md
@@ -37,7 +37,7 @@ internal container and database connection.
 
 #### Defined in
 
-[src/Medusa.ts:37](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/Medusa.ts#L37)
+[src/Medusa.ts:37](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/Medusa.ts#L37)
 
 ## Properties
 
@@ -47,7 +47,7 @@ internal container and database connection.
 
 #### Defined in
 
-[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/Medusa.ts#L30)
+[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/Medusa.ts#L30)
 
 ___
 
@@ -57,7 +57,7 @@ ___
 
 #### Defined in
 
-[src/Medusa.ts:31](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/Medusa.ts#L31)
+[src/Medusa.ts:31](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/Medusa.ts#L31)
 
 ## Methods
 
@@ -77,4 +77,4 @@ ___
 
 #### Defined in
 
-[src/Medusa.ts:45](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/Medusa.ts#L45)
+[src/Medusa.ts:45](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/Medusa.ts#L45)
diff --git a/docs/classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md b/docs/classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md
@@ -45,7 +45,7 @@
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L42)
+[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L42)
 
 ## Properties
 
@@ -55,7 +55,7 @@
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L40)
+[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L40)
 
 ___
 
@@ -65,7 +65,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L39)
+[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L39)
 
 ## Accessors
 
@@ -79,7 +79,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L50)
+[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L50)
 
 ___
 
@@ -93,7 +93,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L46)
+[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L46)
 
 ## Methods
 
@@ -120,7 +120,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L70)
+[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L70)
 
 ___
 
@@ -146,7 +146,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L58)
+[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L58)
 
 ___
 
@@ -173,7 +173,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L84)
+[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L84)
 
 ___
 
@@ -199,7 +199,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L66)
+[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L66)
 
 ___
 
@@ -226,7 +226,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L77)
+[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L77)
 
 ___
 
@@ -252,7 +252,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L62)
+[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L62)
 
 ___
 
@@ -280,7 +280,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L91)
+[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L91)
 
 ___
 
@@ -300,4 +300,4 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L54)
+[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L54)
diff --git a/docs/classes/event_emmiter.Internals.CustomEventEmmiter.md b/docs/classes/event_emmiter.Internals.CustomEventEmmiter.md
@@ -41,7 +41,7 @@ EventEmitter.constructor
 
 #### Defined in
 
-[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/event-emmiter.ts#L21)
+[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/event-emmiter.ts#L21)
 
 ## Properties
 
@@ -51,7 +51,7 @@ EventEmitter.constructor
 
 #### Defined in
 
-[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/event-emmiter.ts#L19)
+[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/event-emmiter.ts#L19)
 
 ## Methods
 
@@ -80,7 +80,7 @@ Emit an asynchrone event entity based and wait for the result.
 
 #### Defined in
 
-[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/event-emmiter.ts#L80)
+[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/event-emmiter.ts#L80)
 
 ___
 
@@ -110,7 +110,7 @@ Register a new event handler.
 
 #### Defined in
 
-[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/event-emmiter.ts#L31)
+[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/event-emmiter.ts#L31)
 
 ___
 
@@ -132,7 +132,7 @@ Apply all event handlers hold by the `listenerDescriptor`.
 
 #### Defined in
 
-[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/event-emmiter.ts#L43)
+[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/event-emmiter.ts#L43)
 
 ___
 
@@ -146,4 +146,4 @@ ___
 
 #### Defined in
 
-[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/event-emmiter.ts#L68)
+[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/event-emmiter.ts#L68)
diff --git a/docs/classes/metadata_reader.Internals.CustomMap.md b/docs/classes/metadata_reader.Internals.CustomMap.md
@@ -84,4 +84,4 @@ Map.get
 
 #### Defined in
 
-[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/metadata-reader.ts#L5)
+[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/metadata-reader.ts#L5)
diff --git a/docs/classes/utils.Utils.md b/docs/classes/utils.Utils.md
@@ -56,7 +56,7 @@ Attach a new subscriber to a specific entities.
 
 #### Defined in
 
-[src/utils.ts:36](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/utils.ts#L36)
+[src/utils.ts:36](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/utils.ts#L36)
 
 ___
 
@@ -80,7 +80,7 @@ Prepare the log to be shown to be consistent everywhere.
 
 #### Defined in
 
-[src/utils.ts:67](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/utils.ts#L67)
+[src/utils.ts:67](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/utils.ts#L67)
 
 ___
 
@@ -102,7 +102,7 @@ Log all the routes from the express instance.
 
 #### Defined in
 
-[src/utils.ts:57](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/utils.ts#L57)
+[src/utils.ts:57](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/utils.ts#L57)
 
 ___
 
@@ -123,7 +123,7 @@ ___
 
 #### Defined in
 
-[src/utils.ts:81](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/utils.ts#L81)
+[src/utils.ts:81](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/utils.ts#L81)
 
 ___
 
@@ -153,7 +153,7 @@ Since it is not possible to use multiple extend, you can use that utilities to a
 
 #### Defined in
 
-[src/utils.ts:16](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/utils.ts#L16)
+[src/utils.ts:16](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/utils.ts#L16)
 
 ___
 
@@ -173,4 +173,4 @@ ___
 
 #### Defined in
 
-[src/utils.ts:101](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/utils.ts#L101)
+[src/utils.ts:101](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/utils.ts#L101)
diff --git a/docs/interfaces/types.MedusaMiddleware.md b/docs/interfaces/types.MedusaMiddleware.md
@@ -46,4 +46,4 @@ Describe a custom middleware instance.
 
 #### Defined in
 
-[src/types.ts:152](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/types.ts#L152)
+[src/types.ts:152](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/types.ts#L152)
diff --git a/docs/interfaces/types.Type.md b/docs/interfaces/types.Type.md
@@ -40,4 +40,4 @@ Function.constructor
 
 #### Defined in
 
-[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/types.ts#L6)
+[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/types.ts#L6)
diff --git a/docs/modules/constants.md b/docs/modules/constants.md
@@ -20,7 +20,7 @@ Metadata key to store config from decorated injectables.
 
 #### Defined in
 
-[src/constants.ts:9](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/constants.ts#L9)
+[src/constants.ts:9](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/constants.ts#L9)
 
 ___
 
@@ -66,7 +66,7 @@ Hold the name of the medusa services registered into the container for later on
 
 #### Defined in
 
-[src/constants.ts:14](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/constants.ts#L14)
+[src/constants.ts:14](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/constants.ts#L14)
 
 ___
 
@@ -78,4 +78,4 @@ Metadata key to store config from decorated injectables.
 
 #### Defined in
 
-[src/constants.ts:4](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/constants.ts#L4)
+[src/constants.ts:4](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/constants.ts#L4)
diff --git a/docs/modules/decorators_components_decorator.md b/docs/modules/decorators_components_decorator.md
@@ -40,7 +40,7 @@ Mark a class as an entity to be used by the loader.
 
 #### Defined in
 
-[src/decorators/components.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/components.decorator.ts#L16)
+[src/decorators/components.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/components.decorator.ts#L16)
 
 ___
 
@@ -62,7 +62,7 @@ Mark a class as a middleware to be used by the loader.
 
 #### Defined in
 
-[src/decorators/components.decorator.ts:43](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/components.decorator.ts#L43)
+[src/decorators/components.decorator.ts:43](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/components.decorator.ts#L43)
 
 ___
 
@@ -78,7 +78,7 @@ Mark a class as a migration to be used by the loader.
 
 #### Defined in
 
-[src/decorators/components.decorator.ts:51](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/components.decorator.ts#L51)
+[src/decorators/components.decorator.ts:51](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/components.decorator.ts#L51)
 
 ___
 
@@ -106,7 +106,7 @@ Mark a class as a repository to be used by the loader.
 
 #### Defined in
 
-[src/decorators/components.decorator.ts:34](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/components.decorator.ts#L34)
+[src/decorators/components.decorator.ts:34](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/components.decorator.ts#L34)
 
 ___
 
@@ -128,7 +128,7 @@ Mark a class as a router to be used by the loader.
 
 #### Defined in
 
-[src/decorators/components.decorator.ts:60](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/components.decorator.ts#L60)
+[src/decorators/components.decorator.ts:60](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/components.decorator.ts#L60)
 
 ___
 
@@ -156,7 +156,7 @@ Mark a class as a service to be used by the loader.
 
 #### Defined in
 
-[src/decorators/components.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/components.decorator.ts#L25)
+[src/decorators/components.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/components.decorator.ts#L25)
 
 ___
 
@@ -178,4 +178,4 @@ Mark a class as a validator to be used by the validator utility.
 
 #### Defined in
 
-[src/decorators/components.decorator.ts:69](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/components.decorator.ts#L69)
+[src/decorators/components.decorator.ts:69](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/components.decorator.ts#L69)
diff --git a/docs/modules/decorators_module_decorator.md b/docs/modules/decorators_module_decorator.md
@@ -29,4 +29,4 @@ Mark a class as aa module and store all injectable on it.
 
 #### Defined in
 
-[src/decorators/module.decorator.ts:9](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/module.decorator.ts#L9)
+[src/decorators/module.decorator.ts:9](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/module.decorator.ts#L9)
diff --git a/docs/modules/decorators_onMedusaEntityEvent_decorator.md b/docs/modules/decorators_onMedusaEntityEvent_decorator.md
@@ -24,7 +24,7 @@
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:11](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L11)
+[src/decorators/onMedusaEntityEvent.decorator.ts:11](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L11)
 
 ___
 
@@ -41,7 +41,7 @@ ___
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:6](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L6)
+[src/decorators/onMedusaEntityEvent.decorator.ts:6](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L6)
 
 ___
 
@@ -60,7 +60,7 @@ Event types that can be emitted.
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L16)
+[src/decorators/onMedusaEntityEvent.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L16)
 
 ___
 
@@ -86,7 +86,7 @@ The arguments expected by the [OnMedusaEntityEvent](../classes/decorators_onMedu
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L25)
+[src/decorators/onMedusaEntityEvent.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L25)
 
 ___
 
@@ -112,4 +112,4 @@ The arguments expected by the event handler.
 
 #### Defined in
 
-[src/decorators/onMedusaEntityEvent.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/65c2ff4/src/decorators/onMedusaEntityEvent.decorator.ts#L33)
+[src/decorators/onMedusaEntityEvent.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/6b3601b/src/decorators/onMedusaEntityEvent.decorator.ts#L33)