From 1a2fddb6ec4651628254113206ccf7315ce60a78 Mon Sep 17 00:00:00 2001 From: adrien2p Date: Fri, 28 Jan 2022 17:05:18 +0100 Subject: [PATCH] Feat() Update doc by describing the provided decorators --- README.md | 16 ++++++++++ docs/README.md | 15 ++++++++++ ...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 | 30 +++++++++---------- 29 files changed, 118 insertions(+), 87 deletions(-) diff --git a/README.md b/README.md index f044fca7..7398b1aa 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,7 @@ - [Middleware](#middleware) - [Router](#router) - [Module](#module) +- [Decorators](#decorators) - [Entity event handling](#entity-event-handling) # Getting started @@ -315,6 +316,21 @@ export class MyModule {} That's it you've completed your first module :rocket: +## Decorators + +Here is the list of the provided decorators. + +| Decorator | Description | Option | +| ---------------------- | ---------------------- | ---------------------- +| @Entity(/*...*/) | Decorate an entity | `{ scope?: LifetimeType; resolutionKey?: string; override?: Type; };` +| @Repository(/*...*/) | Decorate a repository | `{ resolutionKey?: string; override?: Type; };` +| @Service(/*...*/) | Decorate a service | `{ scope?: LifetimeType; resolutionKey?: string; override?: Type; };` +| @Middleware(/*...*/) | Decorate a middleware | `{ requireAuth: boolean; string; routerOptions: MedusaRouteOptions[]; };` +| @Router(/*...*/) | Decorate a router | `{ router: RoutesInjectionRouterConfiguration[]; };` +| @Migration(/*...*/) | Decorate a migration | +| @OnMedusaEntityEvent.\*.\*(/*...*/)| Can be used to send the right event type or register handler to an event | + + ## Entity event handling One of the feature out the box is the ability to emit (sync/async) event from diff --git a/docs/README.md b/docs/README.md index 0a8652a8..9af74395 100644 --- a/docs/README.md +++ b/docs/README.md @@ -37,6 +37,7 @@ medusa-extender / [Exports](modules.md) - [Middleware](#middleware) - [Router](#router) - [Module](#module) +- [Decorators](#decorators) - [Entity event handling](#entity-event-handling) # Getting started @@ -317,6 +318,20 @@ export class MyModule {} That's it you've completed your first module :rocket: +## Decorators + +Here is the list of the provided decorators. + +| Decorator | Description | Option | +| ---------------------- | ---------------------- | ---------------------- +| @Entity(/*...*/) | Decorate an entity | `{ scope?: LifetimeType; resolutionKey?: string; override?: Type; };` +| @Repository(/*...*/) | Decorate a repository | `{ resolutionKey?: string; override?: Type; };` +| @Service(/*...*/) | Decorate a service | `{ scope?: LifetimeType; resolutionKey?: string; override?: Type; };` +| @Middleware(/*...*/) | Decorate a middleware | `{ requireAuth: boolean; string; routerOptions: MedusaRouteOptions[]; };` +| @Router(/*...*/) | Decorate a router | `{ router: RoutesInjectionRouterConfiguration[]; };` +| @Migration(/*...*/) | Decorate a migration | +| @OnMedusaEntityEvent.\*.\*(/*...*/)| Can be used to send the right event type or register handler to an event | + ## Entity event handling One of the feature out the box is the ability to emit (sync/async) event from diff --git a/docs/classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md b/docs/classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md index 8c4a7695..f86bf03d 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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L42) +[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L40) +[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L39) +[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L50) +[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L46) +[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L70) +[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L58) +[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L84) +[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L66) +[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L77) +[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L62) +[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L91) +[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L54) +[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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 616340d5..35a3098e 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/1127b65/src/event-emmiter.ts#L21) +[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/event-emmiter.ts#L19) +[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/event-emmiter.ts#L19) ## Methods @@ -74,7 +74,7 @@ Emit an asynchrone event entity based and wait for the result. #### Defined in -[src/event-emmiter.ts:81](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/event-emmiter.ts#L81) +[src/event-emmiter.ts:81](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/event-emmiter.ts#L81) ___ @@ -104,7 +104,7 @@ Register a new event handler. #### Defined in -[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/event-emmiter.ts#L31) +[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/event-emmiter.ts#L31) ___ @@ -126,7 +126,7 @@ Apply all event handlers hold by the `listenerDescriptor`. #### Defined in -[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/event-emmiter.ts#L43) +[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/event-emmiter.ts#L43) ___ @@ -140,4 +140,4 @@ ___ #### Defined in -[src/event-emmiter.ts:69](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/event-emmiter.ts#L69) +[src/event-emmiter.ts:69](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/event-emmiter.ts#L69) diff --git a/docs/classes/loader.Loader.md b/docs/classes/loader.Loader.md index 7d5e495e..cbc55399 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/1127b65/src/loader.ts#L35) +[src/loader.ts:35](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/loader.ts#L35) diff --git a/docs/classes/medusa.Medusa.md b/docs/classes/medusa.Medusa.md index fa94516b..b7a2df49 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/1127b65/src/medusa.ts#L15) +[src/medusa.ts:15](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/medusa.ts#L8) +[src/medusa.ts:8](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/medusa.ts#L8) ___ @@ -56,7 +56,7 @@ ___ #### Defined in -[src/medusa.ts:9](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/medusa.ts#L9) +[src/medusa.ts:9](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/medusa.ts#L23) +[src/medusa.ts:23](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/medusa.ts#L23) diff --git a/docs/classes/metadata_reader.Internals.CustomMap.md b/docs/classes/metadata_reader.Internals.CustomMap.md index 5784393d..2c9a2b46 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:6](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/metadata-reader.ts#L6) +[src/metadata-reader.ts:6](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/metadata-reader.ts#L6) diff --git a/docs/classes/utils.Utils.md b/docs/classes/utils.Utils.md index 08a919bb..df1297a3 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:40](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/utils.ts#L40) +[src/utils.ts:40](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/utils.ts#L40) ___ @@ -78,7 +78,7 @@ Log all the routes from the express instance. #### Defined in -[src/utils.ts:61](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/utils.ts#L61) +[src/utils.ts:61](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/utils.ts#L61) ___ @@ -101,7 +101,7 @@ Prepare the log to be shown to be consistent everywhere. #### Defined in -[src/utils.ts:70](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/utils.ts#L70) +[src/utils.ts:70](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/utils.ts#L70) ___ @@ -122,7 +122,7 @@ ___ #### Defined in -[src/utils.ts:81](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/utils.ts#L81) +[src/utils.ts:81](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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:17](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/utils.ts#L17) +[src/utils.ts:17](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/utils.ts#L17) ___ @@ -173,4 +173,4 @@ ___ #### Defined in -[src/utils.ts:101](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/utils.ts#L101) +[src/utils.ts:101](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/utils.ts#L101) diff --git a/docs/interfaces/types.MedusaMiddleware.md b/docs/interfaces/types.MedusaMiddleware.md index 1859033e..5e9650c8 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:135](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L135) +[src/types.ts:135](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L135) diff --git a/docs/interfaces/types.Type.md b/docs/interfaces/types.Type.md index 521fdfd1..756ec293 100644 --- a/docs/interfaces/types.Type.md +++ b/docs/interfaces/types.Type.md @@ -40,4 +40,4 @@ Function.constructor #### Defined in -[src/types.ts:5](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L5) +[src/types.ts:5](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L5) diff --git a/docs/modules/contants.md b/docs/modules/contants.md index 18b5a828..3eb738a8 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/1127b65/src/contants.ts#L9) +[src/contants.ts:9](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/contants.ts#L14) +[src/contants.ts:14](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/contants.ts#L4) +[src/contants.ts:4](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/contants.ts#L4) diff --git a/docs/modules/decorators_components_decorator.md b/docs/modules/decorators_components_decorator.md index 8753c7a1..da473786 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/1127b65/src/decorators/components.decorator.ts#L15) +[src/decorators/components.decorator.ts:15](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/components.decorator.ts#L42) +[src/decorators/components.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/components.decorator.ts#L50) +[src/decorators/components.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/components.decorator.ts#L33) +[src/decorators/components.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/components.decorator.ts#L59) +[src/decorators/components.decorator.ts:59](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/components.decorator.ts#L24) +[src/decorators/components.decorator.ts:24](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/components.decorator.ts#L24) diff --git a/docs/modules/decorators_module_decorator.md b/docs/modules/decorators_module_decorator.md index 9afb23cd..b0b41641 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/1127b65/src/decorators/module.decorator.ts#L9) +[src/decorators/module.decorator.ts:9](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/module.decorator.ts#L9) diff --git a/docs/modules/decorators_onMedusaEntityEvent_decorator.md b/docs/modules/decorators_onMedusaEntityEvent_decorator.md index 3ccaef56..91edf7e6 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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L11) +[src/decorators/onMedusaEntityEvent.decorator.ts:11](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L6) +[src/decorators/onMedusaEntityEvent.decorator.ts:6](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L16) +[src/decorators/onMedusaEntityEvent.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L25) +[src/decorators/onMedusaEntityEvent.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/decorators/onMedusaEntityEvent.decorator.ts#L33) +[src/decorators/onMedusaEntityEvent.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/onMedusaEntityEvent.decorator.ts#L33) diff --git a/docs/modules/decorators_utils.md b/docs/modules/decorators_utils.md index ae575e72..0d555580 100644 --- a/docs/modules/decorators_utils.md +++ b/docs/modules/decorators_utils.md @@ -32,4 +32,4 @@ #### Defined in -[src/decorators/utils.ts:5](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/decorators/utils.ts#L5) +[src/decorators/utils.ts:5](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/decorators/utils.ts#L5) diff --git a/docs/modules/event_emmiter.Internals.md b/docs/modules/event_emmiter.Internals.md index bc6426e2..a8060a31 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/1127b65/src/event-emmiter.ts#L9) +[src/event-emmiter.ts:9](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/event-emmiter.ts#L9) diff --git a/docs/modules/event_emmiter.md b/docs/modules/event_emmiter.md index 0ed19628..c14a79a7 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:103](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/event-emmiter.ts#L103) +[src/event-emmiter.ts:103](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/event-emmiter.ts#L103) diff --git a/docs/modules/index.md b/docs/modules/index.md index e766c5d6..59ca5b56 100644 --- a/docs/modules/index.md +++ b/docs/modules/index.md @@ -271,4 +271,4 @@ Renames and re-exports [customEventEmitter](event_emmiter.md#customeventemitter) #### Defined in -[src/index.ts:20](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/index.ts#L20) +[src/index.ts:20](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/index.ts#L20) diff --git a/docs/modules/loaders_api_loader.md b/docs/modules/loaders_api_loader.md index f28059d1..1c667c44 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/1127b65/src/loaders/api.loader.ts#L12) +[src/loaders/api.loader.ts:12](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/loaders/api.loader.ts#L12) diff --git a/docs/modules/loaders_database_loader.md b/docs/modules/loaders_database_loader.md index ad3df9aa..d569cd2d 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/1127b65/src/loaders/database.loader.ts#L5) +[src/loaders/database.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/loaders/database.loader.ts#L5) diff --git a/docs/modules/loaders_entities_loader.md b/docs/modules/loaders_entities_loader.md index 2977322d..46128a2f 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/1127b65/src/loaders/entities.loader.ts#L5) +[src/loaders/entities.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/loaders/entities.loader.ts#L16) +[src/loaders/entities.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/loaders/entities.loader.ts#L16) ___ @@ -73,7 +73,7 @@ Load custom entity and override existing ones. #### Defined in -[src/loaders/entities.loader.ts:50](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/loaders/entities.loader.ts#L50) +[src/loaders/entities.loader.ts:50](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/loaders/entities.loader.ts#L50) ___ @@ -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/1127b65/src/loaders/entities.loader.ts#L30) +[src/loaders/entities.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/loaders/entities.loader.ts#L30) diff --git a/docs/modules/loaders_middlewares_loader.md b/docs/modules/loaders_middlewares_loader.md index 5b2459a0..ab92386a 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/1127b65/src/loaders/middlewares.loader.ts#L13) +[src/loaders/middlewares.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/loaders/middlewares.loader.ts#L13) diff --git a/docs/modules/loaders_migrations_loader.md b/docs/modules/loaders_migrations_loader.md index f094c9a2..f28adb8b 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/1127b65/src/loaders/migrations.loader.ts#L10) +[src/loaders/migrations.loader.ts:10](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/loaders/migrations.loader.ts#L10) diff --git a/docs/modules/loaders_plugins_loader.md b/docs/modules/loaders_plugins_loader.md index 3fd74c98..a3b5e369 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/1127b65/src/loaders/plugins.loader.ts#L11) +[src/loaders/plugins.loader.ts:11](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/loaders/plugins.loader.ts#L11) diff --git a/docs/modules/loaders_repository_loader.md b/docs/modules/loaders_repository_loader.md index a95161d6..5de3df0a 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/1127b65/src/loaders/repository.loader.ts#L16) +[src/loaders/repository.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/loaders/repository.loader.ts#L16) ___ @@ -52,7 +52,7 @@ Load custom repositories and override existing ones. #### Defined in -[src/loaders/repository.loader.ts:49](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/loaders/repository.loader.ts#L49) +[src/loaders/repository.loader.ts:49](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/loaders/repository.loader.ts#L49) ___ @@ -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/1127b65/src/loaders/repository.loader.ts#L30) +[src/loaders/repository.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/loaders/repository.loader.ts#L5) +[src/loaders/repository.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/loaders/repository.loader.ts#L5) diff --git a/docs/modules/loaders_routes_loader.md b/docs/modules/loaders_routes_loader.md index 0bef4cd3..dc76d4f2 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/1127b65/src/loaders/routes.loader.ts#L4) +[src/loaders/routes.loader.ts:4](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/loaders/routes.loader.ts#L14) +[src/loaders/routes.loader.ts:14](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/loaders/routes.loader.ts#L14) diff --git a/docs/modules/loaders_services_loader.md b/docs/modules/loaders_services_loader.md index 2fbb7bec..f0f32e10 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:56](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/loaders/services.loader.ts#L56) +[src/loaders/services.loader.ts:56](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/loaders/services.loader.ts#L56) ___ @@ -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/1127b65/src/loaders/services.loader.ts#L31) +[src/loaders/services.loader.ts:31](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/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/1127b65/src/loaders/services.loader.ts#L9) +[src/loaders/services.loader.ts:9](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/loaders/services.loader.ts#L9) diff --git a/docs/modules/metadata_reader.md b/docs/modules/metadata_reader.md index 8984dfb6..cbf392c8 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:43](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/metadata-reader.ts#L43) +[src/metadata-reader.ts:43](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/metadata-reader.ts#L43) ___ @@ -62,4 +62,4 @@ Read all metadata from the imported modules and extract components that will be #### Defined in -[src/metadata-reader.ts:15](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/metadata-reader.ts#L15) +[src/metadata-reader.ts:15](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/metadata-reader.ts#L15) diff --git a/docs/modules/types.md b/docs/modules/types.md index 48a37faa..9ed14608 100644 --- a/docs/modules/types.md +++ b/docs/modules/types.md @@ -51,7 +51,7 @@ #### Defined in -[src/types.ts:8](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L8) +[src/types.ts:8](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L8) ___ @@ -77,7 +77,7 @@ Defines the injection options for entities. #### Defined in -[src/types.ts:18](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L18) +[src/types.ts:18](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L18) ___ @@ -95,7 +95,7 @@ Determine which options type it actually is depending on the component type. #### Defined in -[src/types.ts:79](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L79) +[src/types.ts:79](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L79) ___ @@ -113,7 +113,7 @@ Determine which options type it actually is depending on the component type. #### Defined in -[src/types.ts:100](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L100) +[src/types.ts:100](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L100) ___ @@ -125,7 +125,7 @@ Components that does not required any other options that Type. #### Defined in -[src/types.ts:13](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L13) +[src/types.ts:13](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L13) ___ @@ -143,7 +143,7 @@ Union of all options type possible for injectable. #### Defined in -[src/types.ts:69](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L69) +[src/types.ts:69](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L69) ___ @@ -155,7 +155,7 @@ Describe the expected request from a middleware [MedusaMiddleware](../interfaces #### Defined in -[src/types.ts:113](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L113) +[src/types.ts:113](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L113) ___ @@ -174,7 +174,7 @@ Medusa request extended. #### Defined in -[src/types.ts:106](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L106) +[src/types.ts:106](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L106) ___ @@ -184,7 +184,7 @@ ___ #### Defined in -[src/types.ts:120](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L120) +[src/types.ts:120](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L120) ___ @@ -203,7 +203,7 @@ Describe all the available options for the Route [MedusaMiddleware](../interface #### Defined in -[src/types.ts:125](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L125) +[src/types.ts:125](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L125) ___ @@ -222,7 +222,7 @@ Defines the injection options for middlewares. #### Defined in -[src/types.ts:61](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L61) +[src/types.ts:61](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L61) ___ @@ -247,7 +247,7 @@ Defines the injection options for services, entities, repositories. #### Defined in -[src/types.ts:36](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L36) +[src/types.ts:36](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L36) ___ @@ -265,7 +265,7 @@ Defines the injection options for routes. #### Defined in -[src/types.ts:54](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L54) +[src/types.ts:54](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L54) ___ @@ -286,7 +286,7 @@ Define a router and its configuration. #### Defined in -[src/types.ts:44](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L44) +[src/types.ts:44](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L44) ___ @@ -312,4 +312,4 @@ Defines the injection options for service. #### Defined in -[src/types.ts:27](https://github.com/adrien2p/medusa-extender/blob/1127b65/src/types.ts#L27) +[src/types.ts:27](https://github.com/adrien2p/medusa-extender/blob/81ad1b3/src/types.ts#L27)