From de32581132abced8024925223c4d8e9db4923b65 Mon Sep 17 00:00:00 2001 From: adrien2p Date: Thu, 3 Feb 2022 00:50:28 +0100 Subject: [PATCH] fix: README doc feat: Improve readme --- README.md | 9 ++++-- docs/README.md | 9 ++++-- ...tityEvent_decorator.OnMedusaEntityEvent.md | 26 +++++++-------- ...nt_emmiter.Internals.CustomEventEmmiter.md | 12 +++---- docs/classes/loader.Loader.md | 2 +- docs/classes/medusa.Medusa.md | 8 ++--- .../metadata_reader.Internals.CustomMap.md | 2 +- docs/classes/utils.Utils.md | 12 +++---- docs/interfaces/types.MedusaMiddleware.md | 2 +- docs/interfaces/types.Type.md | 2 +- docs/modules/contants.md | 6 ++-- .../decorators_components_decorator.md | 12 +++---- docs/modules/decorators_module_decorator.md | 2 +- ...ecorators_onMedusaEntityEvent_decorator.md | 10 +++--- docs/modules/decorators_utils.md | 2 +- docs/modules/event_emmiter.Internals.md | 2 +- docs/modules/event_emmiter.md | 2 +- docs/modules/index.md | 2 +- docs/modules/loaders_api_loader.md | 2 +- docs/modules/loaders_database_loader.md | 2 +- docs/modules/loaders_entities_loader.md | 8 ++--- docs/modules/loaders_middlewares_loader.md | 2 +- docs/modules/loaders_migrations_loader.md | 2 +- docs/modules/loaders_plugins_loader.md | 2 +- docs/modules/loaders_repository_loader.md | 8 ++--- docs/modules/loaders_routes_loader.md | 4 +-- docs/modules/loaders_services_loader.md | 6 ++-- docs/modules/metadata_reader.md | 4 +-- docs/modules/types.md | 32 +++++++++---------- 29 files changed, 100 insertions(+), 94 deletions(-) diff --git a/README.md b/README.md index b7c6022d..e8f196ec 100644 --- 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(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, config: FindConfig): any { + /** + * This is an example. you must not necessarly keep that implementation. + **/ + public prepareListQuery_(selector: Record, config: FindConfig): 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 index b5c1b52d..6bacec52 100644 --- 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(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, config: FindConfig): any { + /** + * This is an example. you must not necessarly keep that implementation. + **/ + public prepareListQuery_(selector: Record, config: FindConfig): 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 index 34f235d2..916bbaee 100644 --- 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 index 7414dc35..78c982c5 100644 --- 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 index 76f51c87..170c43c3 100644 --- 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 index 17611e31..630ccbaf 100644 --- 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 index 7fec59a5..641fe6a5 100644 --- 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 index ee9a5dca..637e6b57 100644 --- 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 index ddab9567..866469fb 100644 --- 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 index 4b92a757..7865e912 100644 --- 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 index 0f2c8f94..1cf56c74 100644 --- 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 index 28e38535..31152ed1 100644 --- 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) diff --git a/docs/modules/decorators_module_decorator.md b/docs/modules/decorators_module_decorator.md index 82379b3b..0b1edc18 100644 --- 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/dd34810/src/decorators/module.decorator.ts#L9) +[src/decorators/module.decorator.ts:9](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/decorators/module.decorator.ts#L9) diff --git a/docs/modules/decorators_onMedusaEntityEvent_decorator.md b/docs/modules/decorators_onMedusaEntityEvent_decorator.md index f26b2e8a..b7e2385a 100644 --- 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/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L11) +[src/decorators/onMedusaEntityEvent.decorator.ts:11](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/decorators/onMedusaEntityEvent.decorator.ts#L11) ___ @@ -47,7 +47,7 @@ ___ #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:6](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L6) +[src/decorators/onMedusaEntityEvent.decorator.ts:6](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/decorators/onMedusaEntityEvent.decorator.ts#L6) ___ @@ -66,7 +66,7 @@ Event types that can be emitted. #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L16) +[src/decorators/onMedusaEntityEvent.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/decorators/onMedusaEntityEvent.decorator.ts#L16) ___ @@ -92,7 +92,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/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L25) +[src/decorators/onMedusaEntityEvent.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/decorators/onMedusaEntityEvent.decorator.ts#L25) ___ @@ -118,4 +118,4 @@ The arguments expected by the event handler. #### Defined in -[src/decorators/onMedusaEntityEvent.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/decorators/onMedusaEntityEvent.decorator.ts#L33) +[src/decorators/onMedusaEntityEvent.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/decorators/onMedusaEntityEvent.decorator.ts#L33) diff --git a/docs/modules/decorators_utils.md b/docs/modules/decorators_utils.md index 42c3e41f..3357ae69 100644 --- a/docs/modules/decorators_utils.md +++ b/docs/modules/decorators_utils.md @@ -32,4 +32,4 @@ #### Defined in -[src/decorators/utils.ts:4](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/decorators/utils.ts#L4) +[src/decorators/utils.ts:4](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/decorators/utils.ts#L4) diff --git a/docs/modules/event_emmiter.Internals.md b/docs/modules/event_emmiter.Internals.md index af645e25..64256602 100644 --- a/docs/modules/event_emmiter.Internals.md +++ b/docs/modules/event_emmiter.Internals.md @@ -38,4 +38,4 @@ A listener descriptor. #### Defined in -[src/event-emmiter.ts:9](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/event-emmiter.ts#L9) +[src/event-emmiter.ts:9](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/event-emmiter.ts#L9) diff --git a/docs/modules/event_emmiter.md b/docs/modules/event_emmiter.md index 29430943..d999bb55 100644 --- a/docs/modules/event_emmiter.md +++ b/docs/modules/event_emmiter.md @@ -23,4 +23,4 @@ Export the instance of the event emmiter. #### Defined in -[src/event-emmiter.ts:102](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/event-emmiter.ts#L102) +[src/event-emmiter.ts:102](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/event-emmiter.ts#L102) diff --git a/docs/modules/index.md b/docs/modules/index.md index 1459120c..1d7243b1 100644 --- a/docs/modules/index.md +++ b/docs/modules/index.md @@ -278,4 +278,4 @@ Renames and re-exports [customEventEmitter](event_emmiter.md#customeventemitter) #### Defined in -[src/index.ts:25](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/index.ts#L25) +[src/index.ts:25](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/index.ts#L25) diff --git a/docs/modules/loaders_api_loader.md b/docs/modules/loaders_api_loader.md index 92b81bd8..cbe755b8 100644 --- a/docs/modules/loaders_api_loader.md +++ b/docs/modules/loaders_api_loader.md @@ -30,4 +30,4 @@ Decorate the original api loader to apply our custom middleware first. #### Defined in -[src/loaders/api.loader.ts:12](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/api.loader.ts#L12) +[src/loaders/api.loader.ts:12](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/api.loader.ts#L12) diff --git a/docs/modules/loaders_database_loader.md b/docs/modules/loaders_database_loader.md index 0100e0b2..ff601a00 100644 --- a/docs/modules/loaders_database_loader.md +++ b/docs/modules/loaders_database_loader.md @@ -27,4 +27,4 @@ #### Defined in -[src/loaders/database.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/database.loader.ts#L5) +[src/loaders/database.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/database.loader.ts#L5) diff --git a/docs/modules/loaders_entities_loader.md b/docs/modules/loaders_entities_loader.md index ad5263ad..9ba32b6f 100644 --- a/docs/modules/loaders_entities_loader.md +++ b/docs/modules/loaders_entities_loader.md @@ -30,7 +30,7 @@ #### Defined in -[src/loaders/entities.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/entities.loader.ts#L5) +[src/loaders/entities.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/entities.loader.ts#L5) ___ @@ -50,7 +50,7 @@ ___ #### Defined in -[src/loaders/entities.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/entities.loader.ts#L16) +[src/loaders/entities.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/entities.loader.ts#L16) ___ @@ -73,7 +73,7 @@ Load custom entity and override existing ones. #### Defined in -[src/loaders/entities.loader.ts:49](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/entities.loader.ts#L49) +[src/loaders/entities.loader.ts:49](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/entities.loader.ts#L49) ___ @@ -97,4 +97,4 @@ Load custom entity into the container. #### Defined in -[src/loaders/entities.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/entities.loader.ts#L30) +[src/loaders/entities.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/entities.loader.ts#L30) diff --git a/docs/modules/loaders_middlewares_loader.md b/docs/modules/loaders_middlewares_loader.md index f3624191..fc117644 100644 --- a/docs/modules/loaders_middlewares_loader.md +++ b/docs/modules/loaders_middlewares_loader.md @@ -31,4 +31,4 @@ Register custom middlewares into the middlewareRegistery. #### Defined in -[src/loaders/middlewares.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/middlewares.loader.ts#L13) +[src/loaders/middlewares.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/middlewares.loader.ts#L13) diff --git a/docs/modules/loaders_migrations_loader.md b/docs/modules/loaders_migrations_loader.md index a2aaa0de..24005645 100644 --- a/docs/modules/loaders_migrations_loader.md +++ b/docs/modules/loaders_migrations_loader.md @@ -30,4 +30,4 @@ Run custom migrations that are find from the provided directory and stored in a #### Defined in -[src/loaders/migrations.loader.ts:10](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/migrations.loader.ts#L10) +[src/loaders/migrations.loader.ts:10](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/migrations.loader.ts#L10) diff --git a/docs/modules/loaders_plugins_loader.md b/docs/modules/loaders_plugins_loader.md index 148d9775..7520ba4d 100644 --- a/docs/modules/loaders_plugins_loader.md +++ b/docs/modules/loaders_plugins_loader.md @@ -29,4 +29,4 @@ Register all listeners before the plugins are loaded to be sure that the scope m #### Defined in -[src/loaders/plugins.loader.ts:11](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/plugins.loader.ts#L11) +[src/loaders/plugins.loader.ts:11](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/plugins.loader.ts#L11) diff --git a/docs/modules/loaders_repository_loader.md b/docs/modules/loaders_repository_loader.md index f75bc6e1..b007bc95 100644 --- a/docs/modules/loaders_repository_loader.md +++ b/docs/modules/loaders_repository_loader.md @@ -29,7 +29,7 @@ #### Defined in -[src/loaders/repository.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/repository.loader.ts#L16) +[src/loaders/repository.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/repository.loader.ts#L16) ___ @@ -52,7 +52,7 @@ Load custom repositories and override existing ones. #### Defined in -[src/loaders/repository.loader.ts:48](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/repository.loader.ts#L48) +[src/loaders/repository.loader.ts:48](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/repository.loader.ts#L48) ___ @@ -76,7 +76,7 @@ Load custom repository into the container. #### Defined in -[src/loaders/repository.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/repository.loader.ts#L30) +[src/loaders/repository.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/repository.loader.ts#L30) ___ @@ -97,4 +97,4 @@ ___ #### Defined in -[src/loaders/repository.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/repository.loader.ts#L5) +[src/loaders/repository.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/repository.loader.ts#L5) diff --git a/docs/modules/loaders_routes_loader.md b/docs/modules/loaders_routes_loader.md index 9ce6f756..2008c195 100644 --- a/docs/modules/loaders_routes_loader.md +++ b/docs/modules/loaders_routes_loader.md @@ -28,7 +28,7 @@ #### Defined in -[src/loaders/routes.loader.ts:4](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/routes.loader.ts#L4) +[src/loaders/routes.loader.ts:4](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/routes.loader.ts#L4) ___ @@ -49,4 +49,4 @@ ___ #### Defined in -[src/loaders/routes.loader.ts:14](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/routes.loader.ts#L14) +[src/loaders/routes.loader.ts:14](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/routes.loader.ts#L14) diff --git a/docs/modules/loaders_services_loader.md b/docs/modules/loaders_services_loader.md index c6fd7fe0..8d03ef46 100644 --- a/docs/modules/loaders_services_loader.md +++ b/docs/modules/loaders_services_loader.md @@ -33,7 +33,7 @@ Load custom service and override existing ones. #### Defined in -[src/loaders/services.loader.ts:55](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/services.loader.ts#L55) +[src/loaders/services.loader.ts:55](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/services.loader.ts#L55) ___ @@ -58,7 +58,7 @@ Load custom service into the container. #### Defined in -[src/loaders/services.loader.ts:31](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/services.loader.ts#L31) +[src/loaders/services.loader.ts:31](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/services.loader.ts#L31) ___ @@ -81,4 +81,4 @@ Load custom services from the rootDir. #### Defined in -[src/loaders/services.loader.ts:9](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/loaders/services.loader.ts#L9) +[src/loaders/services.loader.ts:9](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/loaders/services.loader.ts#L9) diff --git a/docs/modules/metadata_reader.md b/docs/modules/metadata_reader.md index 00735d45..4edf66fa 100644 --- a/docs/modules/metadata_reader.md +++ b/docs/modules/metadata_reader.md @@ -40,7 +40,7 @@ Return the options from components. #### Defined in -[src/metadata-reader.ts:36](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/metadata-reader.ts#L36) +[src/metadata-reader.ts:36](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/metadata-reader.ts#L36) ___ @@ -62,4 +62,4 @@ Read all metadata from the imported modules and extract components that will be #### Defined in -[src/metadata-reader.ts:14](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/metadata-reader.ts#L14) +[src/metadata-reader.ts:14](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/metadata-reader.ts#L14) diff --git a/docs/modules/types.md b/docs/modules/types.md index c90002ad..68ba0c95 100644 --- a/docs/modules/types.md +++ b/docs/modules/types.md @@ -52,7 +52,7 @@ #### Defined in -[src/types.ts:9](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L9) +[src/types.ts:9](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L9) ___ @@ -78,7 +78,7 @@ Defines the injection options for entities. #### Defined in -[src/types.ts:19](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L19) +[src/types.ts:19](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L19) ___ @@ -96,7 +96,7 @@ Determine which options type it actually is depending on the component type. #### Defined in -[src/types.ts:80](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L80) +[src/types.ts:80](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L80) ___ @@ -114,7 +114,7 @@ Determine which options type it actually is depending on the component type. #### Defined in -[src/types.ts:101](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L101) +[src/types.ts:101](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L101) ___ @@ -126,7 +126,7 @@ Components that does not required any other options that Type. #### Defined in -[src/types.ts:14](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L14) +[src/types.ts:14](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L14) ___ @@ -144,7 +144,7 @@ Union of all options type possible for injectable. #### Defined in -[src/types.ts:70](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L70) +[src/types.ts:70](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L70) ___ @@ -156,7 +156,7 @@ Describe the expected request from a middleware [MedusaMiddleware](../interfaces #### Defined in -[src/types.ts:114](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L114) +[src/types.ts:114](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L114) ___ @@ -175,7 +175,7 @@ Medusa request extended. #### Defined in -[src/types.ts:107](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L107) +[src/types.ts:107](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L107) ___ @@ -185,7 +185,7 @@ ___ #### Defined in -[src/types.ts:121](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L121) +[src/types.ts:121](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L121) ___ @@ -204,7 +204,7 @@ Describe all the available options for the Route [MedusaMiddleware](../interface #### Defined in -[src/types.ts:126](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L126) +[src/types.ts:126](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L126) ___ @@ -223,7 +223,7 @@ Defines the injection options for middlewares. #### Defined in -[src/types.ts:62](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L62) +[src/types.ts:62](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L62) ___ @@ -252,7 +252,7 @@ Mix the return type of two objects. #### Defined in -[src/types.ts:144](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L144) +[src/types.ts:144](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L144) ___ @@ -277,7 +277,7 @@ Defines the injection options for services, entities, repositories. #### Defined in -[src/types.ts:37](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L37) +[src/types.ts:37](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L37) ___ @@ -295,7 +295,7 @@ Defines the injection options for routes. #### Defined in -[src/types.ts:55](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L55) +[src/types.ts:55](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L55) ___ @@ -316,7 +316,7 @@ Define a router and its configuration. #### Defined in -[src/types.ts:45](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L45) +[src/types.ts:45](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L45) ___ @@ -342,4 +342,4 @@ Defines the injection options for service. #### Defined in -[src/types.ts:28](https://github.com/adrien2p/medusa-extender/blob/dd34810/src/types.ts#L28) +[src/types.ts:28](https://github.com/adrien2p/medusa-extender/blob/075fc78/src/types.ts#L28)