fix: README doc

feat: Improve readme
adrien2p · Feb 9, 2022 · de32581 · de32581
1 parent 8bc4b5f
commit de32581
Show file tree

Hide file tree

Showing 29 changed files with 100 additions and 94 deletions.
diff --git a/README.md b/README.md
@@ -216,7 +216,7 @@ import { Order } from "./order.entity";
 //...
 
 @MedusaRepository({ override: MedusaOrderRepository })
-@EntityRepository()
+@EntityRepository(Order)
 export class OrderRepository extends Utils.repositoryMixin<Order, MedusaOrderRepository>(MedusaOrderRepository) {
 	testProperty = 'I am the property from OrderRepository that extend MedusaOrderRepository';
 
@@ -274,9 +274,12 @@ export default class ProductService extends MedusaProductService {
         return event;
     }
 
-    public prepareListQuery_(selector: Record<string, any>, config: FindConfig<Product>): any {
+    /**
+    * This is an example. you must not necessarly keep that implementation.
+    **/
+    public prepareListQuery_(selector: Record<string, any>, config: FindConfig<Product>): object {
         selector['customField'] = 'custom_value';
-        return super.prepareListQuery_(selector, config) as any;
+        return super.prepareListQuery_(selector, config);
     }
 }
 ```

diff --git a/docs/README.md b/docs/README.md
@@ -218,7 +218,7 @@ import { Order } from "./order.entity";
 //...
 
 @MedusaRepository({ override: MedusaOrderRepository })
-@EntityRepository()
+@EntityRepository(Order)
 export class OrderRepository extends Utils.repositoryMixin<Order, MedusaOrderRepository>(MedusaOrderRepository) {
 	testProperty = 'I am the property from OrderRepository that extend MedusaOrderRepository';
 
@@ -275,9 +275,12 @@ export default class ProductService extends MedusaProductService {
         return event;
     }
 
-    public prepareListQuery_(selector: Record<string, any>, config: FindConfig<Product>): any {
+    /**
+    * This is an example. you must not necessarly keep that implementation.
+    **/
+    public prepareListQuery_(selector: Record<string, any>, config: FindConfig<Product>): object {
         selector['customField'] = 'custom_value';
-        return super.prepareListQuery_(selector, config) as any;
+        return super.prepareListQuery_(selector, config);
     }
 }
 ```

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/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L42)
+[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L40)
+[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L39)
+[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L50)
+[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L46)
+[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L70)
+[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L58)
+[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L84)
+[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L66)
+[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L77)
+[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L62)
+[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L91)
+[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L54)
+[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/event-emmiter.ts#L21)
+[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/event-emmiter.ts#L19)
+[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/event-emmiter.ts#L80)
+[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/event-emmiter.ts#L31)
+[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/075fc78/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/dd34810/src/event-emmiter.ts#L43)
+[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/event-emmiter.ts#L43)
 
 ___
 
@@ -146,4 +146,4 @@ ___
 
 #### Defined in
 
-[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/event-emmiter.ts#L68)
+[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/event-emmiter.ts#L68)
diff --git a/docs/classes/loader.Loader.md b/docs/classes/loader.Loader.md
@@ -44,4 +44,4 @@ internal container and database connection.
 
 #### Defined in
 
-[src/loader.ts:35](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loader.ts#L35)
+[src/loader.ts:35](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loader.ts#L35)
diff --git a/docs/classes/medusa.Medusa.md b/docs/classes/medusa.Medusa.md
@@ -36,7 +36,7 @@ Register steps that must be executed before/after medusa is load.
 
 #### Defined in
 
-[src/medusa.ts:15](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/medusa.ts#L15)
+[src/medusa.ts:15](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/medusa.ts#L15)
 
 ## Properties
 
@@ -46,7 +46,7 @@ Register steps that must be executed before/after medusa is load.
 
 #### Defined in
 
-[src/medusa.ts:8](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/medusa.ts#L8)
+[src/medusa.ts:8](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/medusa.ts#L8)
 
 ___
 
@@ -56,7 +56,7 @@ ___
 
 #### Defined in
 
-[src/medusa.ts:9](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/medusa.ts#L9)
+[src/medusa.ts:9](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/medusa.ts#L9)
 
 ## Methods
 
@@ -78,4 +78,4 @@ Launch all the steps before/after medusa according to the `stepOptions`.
 
 #### Defined in
 
-[src/medusa.ts:23](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/medusa.ts#L23)
+[src/medusa.ts:23](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/medusa.ts#L23)
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/dd34810/src/metadata-reader.ts#L5)
+[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/075fc78/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:38](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/utils.ts#L38)
+[src/utils.ts:38](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/utils.ts#L38)
 
 ___
 
@@ -80,7 +80,7 @@ Prepare the log to be shown to be consistent everywhere.
 
 #### Defined in
 
-[src/utils.ts:69](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/utils.ts#L69)
+[src/utils.ts:69](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/utils.ts#L69)
 
 ___
 
@@ -102,7 +102,7 @@ Log all the routes from the express instance.
 
 #### Defined in
 
-[src/utils.ts:59](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/utils.ts#L59)
+[src/utils.ts:59](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/utils.ts#L59)
 
 ___
 
@@ -123,7 +123,7 @@ ___
 
 #### Defined in
 
-[src/utils.ts:83](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/utils.ts#L83)
+[src/utils.ts:83](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/utils.ts#L83)
 
 ___
 
@@ -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/dd34810/src/utils.ts#L16)
+[src/utils.ts:16](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/utils.ts#L16)
 
 ___
 
@@ -173,4 +173,4 @@ ___
 
 #### Defined in
 
-[src/utils.ts:103](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/utils.ts#L103)
+[src/utils.ts:103](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/utils.ts#L103)
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:136](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L136)
+[src/types.ts:136](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L136)
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/dd34810/src/types.ts#L6)
+[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L6)
diff --git a/docs/modules/contants.md b/docs/modules/contants.md
@@ -20,7 +20,7 @@ Metadata key to store config from decorated injectables.
 
 #### Defined in
 
-[src/contants.ts:9](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/contants.ts#L9)
+[src/contants.ts:9](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/contants.ts#L9)
 
 ___
 
@@ -66,7 +66,7 @@ Hold the name of the medusa services registered into the container for later on
 
 #### Defined in
 
-[src/contants.ts:14](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/contants.ts#L14)
+[src/contants.ts:14](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/contants.ts#L14)
 
 ___
 
@@ -78,4 +78,4 @@ Metadata key to store config from decorated injectables.
 
 #### Defined in
 
-[src/contants.ts:4](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/contants.ts#L4)
+[src/contants.ts:4](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/contants.ts#L4)
diff --git a/docs/modules/decorators_components_decorator.md b/docs/modules/decorators_components_decorator.md
@@ -39,7 +39,7 @@ Mark a class as an entity to be used by the loader.
 
 #### Defined in
 
-[src/decorators/components.decorator.ts:15](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/decorators/components.decorator.ts#L15)
+[src/decorators/components.decorator.ts:15](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/decorators/components.decorator.ts#L15)
 
 ___
 
@@ -61,7 +61,7 @@ Mark a class as a middleware to be used by the loader.
 
 #### Defined in
 
-[src/decorators/components.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/decorators/components.decorator.ts#L42)
+[src/decorators/components.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/decorators/components.decorator.ts#L42)
 
 ___
 
@@ -77,7 +77,7 @@ Mark a class as a migration to be used by the loader.
 
 #### Defined in
 
-[src/decorators/components.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/decorators/components.decorator.ts#L50)
+[src/decorators/components.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/decorators/components.decorator.ts#L50)
 
 ___
 
@@ -105,7 +105,7 @@ Mark a class as a repository to be used by the loader.
 
 #### Defined in
 
-[src/decorators/components.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/decorators/components.decorator.ts#L33)
+[src/decorators/components.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/decorators/components.decorator.ts#L33)
 
 ___
 
@@ -127,7 +127,7 @@ Mark a class as a router to be used by the loader.
 
 #### Defined in
 
-[src/decorators/components.decorator.ts:59](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/decorators/components.decorator.ts#L59)
+[src/decorators/components.decorator.ts:59](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/decorators/components.decorator.ts#L59)
 
 ___
 
@@ -155,4 +155,4 @@ Mark a class as a service to be used by the loader.
 
 #### Defined in
 
-[src/decorators/components.decorator.ts:24](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/decorators/components.decorator.ts#L24)
+[src/decorators/components.decorator.ts:24](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/decorators/components.decorator.ts#L24)