diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e2ac6616..00000000 --- a/docs/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 1ad6cc9f..00000000 --- a/docs/README.md +++ /dev/null @@ -1,604 +0,0 @@ -medusa-extender / [Exports](modules.md) - - -
-

- Medusa -

- -

Extend medusa to fit your needs

- -

- Did ever though about adding custom fields? Did you ever wonder how to add some custom features? - Did you ever wanted to build something more than a single store? - Well, this project has been made to help you reach you goal. It is now possible to customise - Medusa in a way you will be able to enjoy all the awesome features that Medusa provides you - but with the possibility to take your e-commerce project to the next level :rocket: -

- -
- ---- - -
- Awesome - npm version - activity - issues - download - coverage - licence - twitter - -
- ---- - -
-

- Access the website - Documentation -

-
- - - -# Table of contents - -- [Getting started](#getting-started) -- [Code base overview](#code-base-overview) -- [Features](#features) -- Starters - - [Server](https://github.com/adrien2p/medusa-extender/tree/main/starters/server) - - [Plugin module](https://github.com/adrien2p/medusa-extender/tree/main/starters/plugin-module) -- [Usage](#usage) - - [Create your server](#create-your-server) - - [Create your first module](#create-your-first-module-rocket) - - [Entity](#entity) - - [Migration](#migration) - - [Repository](#repository) - - [Service](#service) - - [Middleware](#middleware) - - [Router](#router) - - [Validator](#validator) - - [Module](#module) -- [Decorators](#decorators) -- [Entity event handling](#entity-event-handling) - -# Getting started - -Installation - -```bash -npm i medusa-extender -``` - -# Code base overview - -Dependency graph - -# Features - -- :technologist: Decorators and full typing support - -> Makes DX easy with the usage of decorators for modular architecture and full typing support for a better DX - -- :building_construction: Flexible architecture. - -> You can organize your code as modules and group your modules by domains. - -- :tada: Create or extend entities - -> Some of the problems that developers encounter are that when you want to add custom fields -> to an entity, it is not that easy. You can't extend a typeorm entity and adding custom -> fields through configuration makes you lose the typings and the domains in which -> they exist. Here, you can now extend a typeorm entity just like any other object. - -- :tada: Create or extend services - -> If you need to extend a service to manage your new fields or update the business logic according to your new needs, -> you only need to extend the original service from medusa and that's it. - -- :tada: Create or extend repositories - -> When you extend an entity and you want to manipulate that entity in a service, you need to do it through a repository. -> In order for that repository to reflect your extended entities, while still getting access to the base repository methods, -> you are provided with the right tools to do so. - -- :tada: Create custom middlewares to apply before/after authentication - -> Do you want to apply custom middlewares to load data on the requests or add some custom -> checks or any other situations? Then what are you waiting for? - -- :tada: Create custom route and attach custom service to handle it. - -> Do you need to add new routes for new features? Do you want to receive webhooks? -> It is easy to do it now. - -- :bulb: Handle entity events from subscribers as easily as possible through the provided decorators. - -> Emit an event (async/sync) from your subscriber and then register a new handler in any of your files. Just use the `OnMedusaEntityEvent` decorator. - -- :package: Build sharable modules - -> Build a module, export it and share it with the community. - -# Usage - -## Create your server - -
-Click to see the example! - -```typescript -// index.ts -import { MyModule } from './modules/myModule/myModule.module'; - -async function bootstrap() { - const expressInstance = express(); - - const rootDir = resolve(__dirname); - await new Medusa(rootDir, expressInstance).load(MyModule); - - expressInstance.listen(config.serverConfig.port, () => { - logger.info('Server successfully started on port ' + config.serverConfig.port); - }); -} - -bootstrap(); -``` -
- -## Create your first module :rocket: - -### Entity - -Let's say that you want to add a new field on the `Product` entity. -
-Click to see the example! - -```typescript -// modules/product/product.entity.ts - -import { Product as MedusaProduct } from '@medusa/medusa/dist'; -import { Column, Entity } from "typeorm"; -import { Entity as MedusaEntity } from "medusa-extender"; -//... - -@MedusaEntity({ override: MedusaProduct }) -@Entity() -class Product extends MedusaProduct { - @Column() - customField: string; -} -``` -
- -### Migration - -After have updated your entity, you will have to migrate the database in order to reflect the new fields. - -
-Click to see the example! - -```typescript -// modules/product/20211126000001-add-field-to-product - -import { MigrationInterface, QueryRunner } from 'typeorm'; -import { Migration } from 'medusa-extender'; - -@Migration() -export default class AddFieldToProduct1611063162649 implements MigrationInterface { - name = 'addFieldToProduct1611063162649'; - - public async up(queryRunner: QueryRunner): Promise { - } - - public async down(queryRunner: QueryRunner): Promise { - } -} -``` -
- -### Repository - -We will then create a new repository to reflect our custom entity. - -
-Click to see the example! - -```typescript -// modules/product/product.repository.ts - -import { OrderRepository as MedusaOrderRepository } from '@medusa/medusa/dist/repositories/order'; -import { EntityRepository } from "typeorm"; -import { Repository as MedusaRepository, Utils } from "medusa-extender"; -import { Order } from "./order.entity"; -//... - -@MedusaRepository({ override: MedusaOrderRepository }) -@EntityRepository(Order) -export class OrderRepository extends Utils.repositoryMixin(MedusaOrderRepository) { - testProperty = 'I am the property from OrderRepository that extend MedusaOrderRepository'; - - test(): Promise { - return this.findWithRelations() as Promise; - } -} -``` - -
- -### Service - -We now want to add a custom service to implement our custom logic for our new field. - -
-Click to see the example! - -```typescript -// modules/product/product.service.ts - -import { Service, OnMedusaEntityEvent, MedusaEventHandlerParams, EntityEventType } from 'medusa-extender'; -//... - -interface ConstructorParams { - manager: EntityManager; - productRepository: typeof ProductRepository; - productVariantRepository: typeof ProductVariantRepository; - productOptionRepository: typeof ProductOptionRepository; - eventBusService: EventBusService; - productVariantService: ProductVariantService; - productCollectionService: ProductCollectionService; - productTypeRepository: typeof ProductTypeRepository; - productTagRepository: typeof ProductTagRepository; - imageRepository: typeof ImageRepository; - searchService: TSearchService; -} - -@Service({ scope: 'SCOPED', override: MedusaProductService }) -export default class ProductService extends MedusaProductService { - readonly #manager: EntityManager; - - constructor(private readonly container: ConstructorParams) { - super(container); - this.#manager = container.manager; - } - - @OnMedusaEntityEvent.Before.Insert(Product, { async: true }) - public async attachStoreToProduct( - params: MedusaEventHandlerParams - ): Promise> { - const { event } = params; - event.entity.customField = 'custom_value'; - return event; - } - - /** - * 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); - } -} -``` -
- -### Middleware - -Let's say that you want to attach a custom middleware to certain routes - -
-Click to see the example! - -```typescript -// modules/product/custom.middleware.ts - -import { Express, NextFunction, Response } from 'express'; -import { - Middleware, - MedusaAuthenticatedRequest, - MedusaMiddleware, -} from 'medusa-extender'; - -const routerOption = { method: 'post', path: '/admin/products/' }; - -@Middleware({ requireAuth: true, routerOptions: [routerOption] }) -export class CustomMiddleware implements MedusaMiddleware { - public consume( - options: { app: Express } - ): (req: MedusaAuthenticatedRequest, res: Response, next: NextFunction) => void | Promise { - return (req: MedusaAuthenticatedRequest, res: Response, next: NextFunction): void => { - return next(); - }; - } -} - -``` -
- -### Router - -If you need to add custom routes to medusa here is a simple way to achieve this - -
-Click to see the example! - -```typescript -// modules/product/product.router.ts - -import { Router } from 'medusa-extender'; -import yourController from './yourController.contaoller'; - -@Router({ - router: [{ - requiredAuth: true, - path: '/admin/dashboard', - method: 'get', - handler: yourController.getStats - }] -}) -export class ProductRouter { -} -``` -
- -### Validator - -If you add a custom field on an entity, there is a huge risk that you end up getting -an error as soon as you it the end point with that new field. The medusa validators -are not aware of your new field once the request arrive. In order to handle that -you can extend the class validator in order to add your custom field constraint. - -
-Click to see the example! - -```typescript -<<<<<<< HEAD -<<<<<<< HEAD -// modules/product/AdminPostProductsReq.validator.ts -======= -// modules/product/product.router.ts ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -// modules/product/AdminPostProductsReq.validator.ts ->>>>>>> 4c3e573... Feat() Update doc - -import { Validator } from 'medusa-extender'; -import { AdminPostProductsReq } from "@medusajs/medusa/dist"; - -@Validator({ override: AdminPostProductsReq }) -class ExtendedClassValidator extends AdminPostProductsReq { - @IsString() - customField: string; -} -``` -
- -### Module - -the last step is to import everything in our module :package: - -
-Click to see the example! - -```typescript -// modules/products/myModule.module.ts - -import { Module } from 'medusa-extender'; -import { Product } from './product.entity'; -import { ProductRouter } from './product.router'; -import { CustomMiddleware } from './custom.middleware'; -import ProductRepository from './product.repository'; -import ProductService from './product.service'; -import AddFieldToProduct1611063162649 from './product.20211126000001-add-field-to-product'; - -@Module({ - imports: [ - Product, - ProductRepository, - ProductService, - ProductRouter, - CustomMiddleware, - AddFieldToProduct1611063162649, - ExtendedClassValidator - ] -}) -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 | -| `@Validator(/*...*/)` | Decorate a validator | `{ override: Type; };` -| `@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) events from -your entity subscriber and to be able to handle those events easily. - -To be able to achieve this, here is an example. - -
-Click to see the example! - -```typescript -// modules/products/product.subscriber.ts - -import { Connection, EntitySubscriberInterface, EventSubscriber, InsertEvent } from 'typeorm'; -import { eventEmitter, Utils, OnMedusaEntityEvent } from 'medusa-extender'; -import { Product } from '../entities/product.entity'; - -@EventSubscriber() -export default class ProductSubscriber implements EntitySubscriberInterface { - static attachTo(connection: Connection): void { - Utils.attachOrReplaceEntitySubscriber(connection, ProductSubscriber); - } - - public listenTo(): typeof Product { - return Product; - } - - /** - * Relay the event to the handlers. - * @param event Event to pass to the event handler - */ - public async beforeInsert(event: InsertEvent): Promise { - return await eventEmitter.emitAsync(OnMedusaEntityEvent.Before.InsertEvent(Product), { - event, - transactionalEntityManager: event.manager, - }); - } -} -``` -
- -And then create a new handler. - -
-Click to see the example! - -```typescript -// modules/product/product.service.ts - -import { Service, OnMedusaEntityEvent } from 'medusa-extender'; -//... - -interface ConstructorParams { - // ... -} - -@Service({ scope: 'SCOPED', override: MedusaProductService }) -export default class ProductService extends MedusaProductService { - readonly #manager: EntityManager; - - constructor(private readonly container: ConstructorParams) { - super(container); - this.#manager = container.manager; - } - - @OnMedusaEntityEvent.Before.Insert(Product, { async: true }) - public async attachStoreToProduct( - params: MedusaEventHandlerParams - ): Promise> { - const { event } = params; - event.entity.customField = 'custom_value'; - return event; - } -} -``` -
- -And finally, we need to add the subscriber to the connection. There are different ways to achieve -this. We will see, as an example below, a way to attach request scoped subscribers. - -
-Click to see the example! - -```typescript -// modules/product/attachSubscriber.middleware.ts - -import { Express, NextFunction, Response } from 'express'; -import { - Middleware, - MEDUSA_RESOLVER_KEYS, - MedusaAuthenticatedRequest, - MedusaMiddleware, - MedusaRouteOptions, - Utils as MedusaUtils, -} from 'medusa-extender'; -import { Connection } from 'typeorm'; -import Utils from '@core/utils'; -import ProductSubscriber from '@modules/product/subscribers/product.subscriber'; import { Middleware } from "./components.decorator"; - -@Middleware({ requireAuth: true, routerOptions: [{ method: 'post', path: '/admin/products/' }] }) -export class AttachProductSubscribersMiddleware implements MedusaMiddleware { - private app: Express; - private hasBeenAttached = false; - - public static get routesOptions(): MedusaRouteOptions { - return { - path: '/admin/products/', - method: 'post', - }; - } - - public consume( - options: { app: Express } - ): (req: MedusaAuthenticatedRequest, res: Response, next: NextFunction) => void | Promise { - this.app = options.app; - - const attachIfNeeded = (routeOptions: MedusaRouteOptions): void => { - if (!this.hasBeenAttached) { - this.app.use((req: MedusaAuthenticatedRequest, res: Response, next: NextFunction): void => { - if (Utils.isExpectedRoute([routeOptions], req)) { - const { connection } = req.scope.resolve(MEDUSA_RESOLVER_KEYS.manager) as { connection: Connection }; - MedusaUtils.attachOrReplaceEntitySubscriber(connection, ProductSubscriber); - } - return next(); - }); - this.hasBeenAttached = true; - } - } - - return (req: MedusaAuthenticatedRequest, res: Response, next: NextFunction): void => { - const routeOptions = AttachProductSubscribersMiddleware.routesOptions; - attachIfNeeded(routeOptions); - return next(); - }; - } -} -``` -
- -Now, you only need to add that middleware to the previous module we've created. - -
-Click to see the example! - -```typescript -// modules/products/myModule.module.ts - -import { Module } from 'medusa-extender'; -import { Product } from './product.entity'; -import { ProductRouter } from './product.router'; -import { CustomMiddleware } from './custom.middleware'; -import ProductRepository from './product.repository'; -import ProductService from './product.service'; -import AddFieldToProduct1611063162649 from './product.20211126000001-add-field-to-product'; -import { AttachProductSubscribersMiddleware } from './attachSubscriber.middleware' - -@Module({ - imports: [ - Product, - ProductRepository, - ProductService, - ProductRouter, - CustomMiddleware, - AttachProductSubscribersMiddleware, - AddFieldToProduct1611063162649 - ] -}) -export class MyModule {} -``` -
- -# Contribute :ballot_box: - -Contributions are welcome! You can look at the contribution [guidelines](./CONTRIBUTING.md) diff --git a/docs/classes/Medusa.Medusa-1.md b/docs/classes/Medusa.Medusa-1.md deleted file mode 100644 index 039e31b7..00000000 --- a/docs/classes/Medusa.Medusa-1.md +++ /dev/null @@ -1,192 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / [Medusa](../modules/Medusa.md) / Medusa - -# Class: Medusa - -[Medusa](../modules/Medusa.md).Medusa - -Load medusa and apply all middlewares and migrations before registering the medusa -internal container and database connection. - -## Table of contents - -### Constructors - -- [constructor](Medusa.Medusa-1.md#constructor) - -### Properties - -- [#express](Medusa.Medusa-1.md##express) -- [#rootDir](Medusa.Medusa-1.md##rootdir) - -### Methods - -- [load](Medusa.Medusa-1.md#load) - -## Constructors - -### constructor - -• **new Medusa**(`rootDir`, `express`) - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `rootDir` | `string` | Directory where the `medusa-config` is located | -| `express` | `Express` | Express instance | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/Medusa.ts:37](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/Medusa.ts#L37) -======= -[src/Medusa.ts:36](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/Medusa.ts#L36) ->>>>>>> 834fee1... Feat() Update doc -======= -[src/Medusa.ts:36](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/Medusa.ts#L36) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/Medusa.ts:36](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/Medusa.ts#L36) -======= -[src/Medusa.ts:36](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/Medusa.ts#L36) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/Medusa.ts:36](https://github.com/adrien2p/medusa-extender/blob/0490090/src/Medusa.ts#L36) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/Medusa.ts:37](https://github.com/adrien2p/medusa-extender/blob/e820602/src/Medusa.ts#L37) ->>>>>>> 4c3e573... Feat() Update doc - -## Properties - -### #express - -• `Private` `Readonly` **#express**: `Express` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/Medusa.ts#L30) -======= -[src/Medusa.ts:29](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/Medusa.ts#L29) ->>>>>>> 834fee1... Feat() Update doc -======= -[src/Medusa.ts:29](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/Medusa.ts#L29) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/Medusa.ts:29](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/Medusa.ts#L29) -======= -[src/Medusa.ts:29](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/Medusa.ts#L29) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/Medusa.ts:29](https://github.com/adrien2p/medusa-extender/blob/0490090/src/Medusa.ts#L29) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/e820602/src/Medusa.ts#L30) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### #rootDir - -• `Private` `Readonly` **#rootDir**: `string` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/Medusa.ts:31](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/Medusa.ts#L31) -======= -[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/Medusa.ts#L30) ->>>>>>> 834fee1... Feat() Update doc -======= -[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/Medusa.ts#L30) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/Medusa.ts#L30) -======= -[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/Medusa.ts#L30) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/0490090/src/Medusa.ts#L30) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/Medusa.ts:31](https://github.com/adrien2p/medusa-extender/blob/e820602/src/Medusa.ts#L31) ->>>>>>> 4c3e573... Feat() Update doc - -## Methods - -### load - -▸ **load**(`modules`): `Promise`<`AwilixContainer`<`any`\>\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `modules` | [`Constructor`](../modules/types.md#constructor)<`unknown`\>[] | - -#### Returns - -`Promise`<`AwilixContainer`<`any`\>\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/Medusa.ts:45](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/Medusa.ts#L45) -======= -[src/Medusa.ts:44](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/Medusa.ts#L44) ->>>>>>> 834fee1... Feat() Update doc -======= -[src/Medusa.ts:44](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/Medusa.ts#L44) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/Medusa.ts:44](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/Medusa.ts#L44) -======= -[src/Medusa.ts:44](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/Medusa.ts#L44) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/Medusa.ts:44](https://github.com/adrien2p/medusa-extender/blob/0490090/src/Medusa.ts#L44) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/Medusa.ts:45](https://github.com/adrien2p/medusa-extender/blob/e820602/src/Medusa.ts#L45) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md b/docs/classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md deleted file mode 100644 index 2c766342..00000000 --- a/docs/classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md +++ /dev/null @@ -1,667 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / [decorators/onMedusaEntityEvent.decorator](../modules/decorators_onMedusaEntityEvent_decorator.md) / OnMedusaEntityEvent - -# Class: OnMedusaEntityEvent - -[decorators/onMedusaEntityEvent.decorator](../modules/decorators_onMedusaEntityEvent_decorator.md).OnMedusaEntityEvent - -## Table of contents - -### Constructors - -- [constructor](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md#constructor) - -### Properties - -- [#targetEntity](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md##targetentity) -- [#when](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md##when) - -### Accessors - -- [After](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md#after) -- [Before](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md#before) - -### Methods - -- [Insert](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md#insert) -- [InsertEvent](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md#insertevent) -- [Remove](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md#remove) -- [RemoveEvent](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md#removeevent) -- [Update](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md#update) -- [UpdateEvent](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md#updateevent) -- [buildDecorator](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md#builddecorator) -- [build](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md#build) - -## Constructors - -### constructor - -• **new OnMedusaEntityEvent**(`when?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `when?` | `string` | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L42) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L42) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L42) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L42) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L42) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L42) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L42) ->>>>>>> 4c3e573... Feat() Update doc - -## Properties - -### #targetEntity - -• `Private` **#targetEntity**: [`Type`](../interfaces/types.Type.md)<`unknown`\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L40) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L40) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L40) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L40) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L40) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L40) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L40) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### #when - -• `Private` `Readonly` **#when**: `string` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L39) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L39) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L39) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L39) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L39) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L39) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L39) ->>>>>>> 4c3e573... Feat() Update doc - -## Accessors - -### After - -• `Static` `get` **After**(): [`OnMedusaEntityEvent`](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md) - -#### Returns - -[`OnMedusaEntityEvent`](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md) - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L50) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L50) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L50) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L50) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L50) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L50) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L50) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### Before - -• `Static` `get` **Before**(): [`OnMedusaEntityEvent`](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md) - -#### Returns - -[`OnMedusaEntityEvent`](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md) - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L46) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L46) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L46) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L46) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L46) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L46) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L46) ->>>>>>> 4c3e573... Feat() Update doc - -## Methods - -### Insert - -▸ **Insert**<`TEntity`\>(`entity`, `options?`): `MethodDecorator` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEntity` | extends [`Type`](../interfaces/types.Type.md)<`unknown`, `TEntity`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `entity` | `TEntity` | -| `options` | [`EntityEventActionOptions`](../modules/decorators_onMedusaEntityEvent_decorator.md#entityeventactionoptions)<`TEntity`\> | - -#### Returns - -`MethodDecorator` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L70) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L70) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L70) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L70) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L70) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L70) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L70) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### InsertEvent - -▸ **InsertEvent**<`Entity`\>(`entity`): `string` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Entity` | extends [`Type`](../interfaces/types.Type.md)<`unknown`, `Entity`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `entity` | `Entity` | - -#### Returns - -`string` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L58) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L58) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L58) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L58) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L58) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L58) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L58) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### Remove - -▸ **Remove**<`TEntity`\>(`entity`, `options?`): `MethodDecorator` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEntity` | extends [`Type`](../interfaces/types.Type.md)<`unknown`, `TEntity`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `entity` | `TEntity` | -| `options` | [`EntityEventActionOptions`](../modules/decorators_onMedusaEntityEvent_decorator.md#entityeventactionoptions)<`TEntity`\> | - -#### Returns - -`MethodDecorator` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L84) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L84) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L84) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L84) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L84) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L84) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L84) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### RemoveEvent - -▸ **RemoveEvent**<`Entity`\>(`entity`): `string` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Entity` | extends [`Type`](../interfaces/types.Type.md)<`unknown`, `Entity`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `entity` | `Entity` | - -#### Returns - -`string` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L66) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L66) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L66) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L66) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L66) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L66) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L66) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### Update - -▸ **Update**<`TEntity`\>(`entity`, `options?`): `MethodDecorator` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEntity` | extends [`Type`](../interfaces/types.Type.md)<`unknown`, `TEntity`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `entity` | `TEntity` | -| `options` | [`EntityEventActionOptions`](../modules/decorators_onMedusaEntityEvent_decorator.md#entityeventactionoptions)<`TEntity`\> | - -#### Returns - -`MethodDecorator` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L77) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L77) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L77) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L77) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L77) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L77) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L77) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### UpdateEvent - -▸ **UpdateEvent**<`Entity`\>(`entity`): `string` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Entity` | extends [`Type`](../interfaces/types.Type.md)<`unknown`, `Entity`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `entity` | `Entity` | - -#### Returns - -`string` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L62) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L62) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L62) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L62) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L62) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L62) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L62) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### buildDecorator - -▸ `Private` **buildDecorator**<`TEntity`\>(`action`, `entity`, `options?`): `MethodDecorator` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TEntity` | extends [`Type`](../interfaces/types.Type.md)<`unknown`, `TEntity`\> | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `action` | [`EntityActions`](../modules/decorators_onMedusaEntityEvent_decorator.md#entityactions) | -| `entity` | `TEntity` | -| `options` | [`EntityEventActionOptions`](../modules/decorators_onMedusaEntityEvent_decorator.md#entityeventactionoptions)<`TEntity`\> | - -#### Returns - -`MethodDecorator` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L91) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L91) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L91) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L91) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L91) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L91) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L91) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### build - -▸ `Static` `Private` **build**(`when`): [`OnMedusaEntityEvent`](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `when` | `string` | - -#### Returns - -[`OnMedusaEntityEvent`](decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md) - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L54) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L54) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L54) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L54) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L54) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L54) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L54) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/classes/event_emmiter.Internals.CustomEventEmmiter.md b/docs/classes/event_emmiter.Internals.CustomEventEmmiter.md deleted file mode 100644 index 75b0602c..00000000 --- a/docs/classes/event_emmiter.Internals.CustomEventEmmiter.md +++ /dev/null @@ -1,317 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / [event-emmiter](../modules/event_emmiter.md) / [Internals](../modules/event_emmiter.Internals.md) / CustomEventEmmiter - -# Class: CustomEventEmmiter - -[event-emmiter](../modules/event_emmiter.md).[Internals](../modules/event_emmiter.Internals.md).CustomEventEmmiter - -Extended event emitter to register methods that must be call when certain events are triggered and relay the handling to the API package - -## Hierarchy - -- `EventEmitter` - - ↳ **`CustomEventEmmiter`** - -## Table of contents - -### Constructors - -- [constructor](event_emmiter.Internals.CustomEventEmmiter.md#constructor) - -### Properties - -- [#listeners](event_emmiter.Internals.CustomEventEmmiter.md##listeners) - -### Methods - -- [emitAsync](event_emmiter.Internals.CustomEventEmmiter.md#emitasync) -- [register](event_emmiter.Internals.CustomEventEmmiter.md#register) -- [registerListeners](event_emmiter.Internals.CustomEventEmmiter.md#registerlisteners) -- [unregisterListeners](event_emmiter.Internals.CustomEventEmmiter.md#unregisterlisteners) - -## Constructors - -### constructor - -• **new CustomEventEmmiter**() - -#### Overrides - -EventEmitter.constructor - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/event-emmiter.ts#L21) -======= -[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/event-emmiter.ts#L21) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/event-emmiter.ts#L21) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/event-emmiter.ts#L21) -======= -[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/event-emmiter.ts#L21) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/0490090/src/event-emmiter.ts#L21) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/e820602/src/event-emmiter.ts#L21) ->>>>>>> 4c3e573... Feat() Update doc - -## Properties - -### #listeners - -• `Private` **#listeners**: `Set`<[`ListenerDescriptor`](../modules/event_emmiter.Internals.md#listenerdescriptor)<`unknown`\>\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/event-emmiter.ts#L19) -======= -[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/event-emmiter.ts#L19) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/event-emmiter.ts#L19) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/event-emmiter.ts#L19) -======= -[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/event-emmiter.ts#L19) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/0490090/src/event-emmiter.ts#L19) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/e820602/src/event-emmiter.ts#L19) ->>>>>>> 4c3e573... Feat() Update doc - -## Methods - -### emitAsync - -▸ **emitAsync**<`T`\>(`eventName`, `values`): `Promise`<`T`\> - -Emit an asynchrone event entity based and wait for the result. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The event that must be triggered | -| `values` | `Record`<`string`, `unknown`\> | The data that are passed to the event handler | - -#### Returns - -`Promise`<`T`\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/event-emmiter.ts#L80) -======= -[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/event-emmiter.ts#L80) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/event-emmiter.ts#L80) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/event-emmiter.ts#L80) -======= -[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/event-emmiter.ts#L80) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/0490090/src/event-emmiter.ts#L80) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/e820602/src/event-emmiter.ts#L80) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### register - -▸ **register**<`T`\>(`eventName`, `propertyName`, `metatype`): `void` - -Register a new event handler. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `eventName` | `string` \| `symbol` | The name of the event that has to be triggered | -| `propertyName` | `string` | The name of the class property that will handle the event | -| `metatype` | [`Type`](../interfaces/types.Type.md)<`T`\> | The object that contains the property above | - -#### Returns - -`void` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/event-emmiter.ts#L31) -======= -[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/event-emmiter.ts#L31) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/event-emmiter.ts#L31) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/event-emmiter.ts#L31) -======= -[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/event-emmiter.ts#L31) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/0490090/src/event-emmiter.ts#L31) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/e820602/src/event-emmiter.ts#L31) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### registerListeners - -▸ **registerListeners**(`container`): `void` - -Apply all event handlers hold by the `listenerDescriptor`. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `container` | `AwilixContainer`<`any`\> | The IoC container that allow to resolve instance | - -#### Returns - -`void` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/event-emmiter.ts#L43) -======= -[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/event-emmiter.ts#L43) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/event-emmiter.ts#L43) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/event-emmiter.ts#L43) -======= -[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/event-emmiter.ts#L43) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/0490090/src/event-emmiter.ts#L43) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/e820602/src/event-emmiter.ts#L43) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### unregisterListeners - -▸ **unregisterListeners**(): `void` - -#### Returns - -`void` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/event-emmiter.ts#L68) -======= -[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/event-emmiter.ts#L68) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/event-emmiter.ts#L68) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/event-emmiter.ts#L68) -======= -[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/event-emmiter.ts#L68) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/0490090/src/event-emmiter.ts#L68) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/e820602/src/event-emmiter.ts#L68) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/classes/metadata_reader.Internals.CustomMap.md b/docs/classes/metadata_reader.Internals.CustomMap.md deleted file mode 100644 index b3a79ef1..00000000 --- a/docs/classes/metadata_reader.Internals.CustomMap.md +++ /dev/null @@ -1,115 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / [metadata-reader](../modules/metadata_reader.md) / [Internals](../modules/metadata_reader.Internals.md) / CustomMap - -# Class: CustomMap - -[metadata-reader](../modules/metadata_reader.md).[Internals](../modules/metadata_reader.Internals.md).CustomMap - -## Hierarchy - -- `Map`<[`InjectableComponentTypes`](../modules/types.md#injectablecomponenttypes), [`GetInjectableOptions`](../modules/types.md#getinjectableoptions)\> - - ↳ **`CustomMap`** - -## Table of contents - -### Constructors - -- [constructor](metadata_reader.Internals.CustomMap.md#constructor) - -### Methods - -- [get](metadata_reader.Internals.CustomMap.md#get) - -## Constructors - -### constructor - -• **new CustomMap**(`entries?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `entries?` | readonly readonly [[`InjectableComponentTypes`](../modules/types.md#injectablecomponenttypes), [`GetInjectableOptions`](../modules/types.md#getinjectableoptions)<[`InjectableComponentTypes`](../modules/types.md#injectablecomponenttypes)\>][] | - -#### Inherited from - -Map.constructor - -#### Defined in - -node_modules/typescript/lib/lib.es2015.collection.d.ts:33 - -• **new CustomMap**(`iterable`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `iterable` | `Iterable`]\> | - -#### Inherited from - -Map.constructor - -#### Defined in - -node_modules/typescript/lib/lib.es2015.iterable.d.ts:160 - -## Methods - -### get - -▸ **get**<`TComponentType`\>(`key`): [`GetInjectableOptions`](../modules/types.md#getinjectableoptions)<`TComponentType`\> - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TComponentType` | extends [`InjectableComponentTypes`](../modules/types.md#injectablecomponenttypes) | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `TComponentType` | - -#### Returns - -[`GetInjectableOptions`](../modules/types.md#getinjectableoptions)<`TComponentType`\> - -#### Overrides - -Map.get - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/metadata-reader.ts#L5) -======= -[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/metadata-reader.ts#L5) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/metadata-reader.ts#L5) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/metadata-reader.ts#L5) -======= -[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/metadata-reader.ts#L5) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/0490090/src/metadata-reader.ts#L5) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/e820602/src/metadata-reader.ts#L5) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/classes/utils.Utils.md b/docs/classes/utils.Utils.md deleted file mode 100644 index c4e6ddde..00000000 --- a/docs/classes/utils.Utils.md +++ /dev/null @@ -1,344 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / [utils](../modules/utils.md) / Utils - -# Class: Utils - -[utils](../modules/utils.md).Utils - -**`internal`** -Utilities helper methods. - -## Table of contents - -### Constructors - -- [constructor](utils.Utils.md#constructor) - -### Methods - -- [attachOrReplaceEntitySubscriber](utils.Utils.md#attachorreplaceentitysubscriber) -- [log](utils.Utils.md#log) -- [logRoutes](utils.Utils.md#logroutes) -- [printRoutes](utils.Utils.md#printroutes) -- [repositoryMixin](utils.Utils.md#repositorymixin) -- [splitRoutes](utils.Utils.md#splitroutes) - -## Constructors - -### constructor - -• **new Utils**() - -## Methods - -### attachOrReplaceEntitySubscriber - -▸ `Static` **attachOrReplaceEntitySubscriber**<`T`\>(`connection`, `Subscriber`, `transactionalEntityManager?`): `void` - -Attach a new subscriber to a specific entities. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends [`Constructor`](../modules/types.md#constructor)<`EntitySubscriberInterface`<`unknown`\>\> | - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `connection` | `Connection` | The database connection | -| `Subscriber` | `T` | The subscriber to attach | -| `transactionalEntityManager?` | `EntityManager` | The transactional entity manager to pass the transaction through | - -#### Returns - -`void` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/utils.ts:36](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/utils.ts#L36) -======= -[src/utils.ts:38](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/utils.ts#L38) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/utils.ts:38](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/utils.ts#L38) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/utils.ts:38](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/utils.ts#L38) -======= -[src/utils.ts:38](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/utils.ts#L38) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/utils.ts:38](https://github.com/adrien2p/medusa-extender/blob/0490090/src/utils.ts#L38) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/utils.ts:36](https://github.com/adrien2p/medusa-extender/blob/e820602/src/utils.ts#L36) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### log - -▸ `Static` **log**(`context`, `description`, ...`variables`): `void` - -Prepare the log to be shown to be consistent everywhere. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `context` | `string` | Where the log comes from | -| `description` | `string` | The description of the action logged | -| `...variables` | `string`[] | The variable that populate the logs | - -#### Returns - -`void` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/utils.ts:67](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/utils.ts#L67) -======= -[src/utils.ts:69](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/utils.ts#L69) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/utils.ts:69](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/utils.ts#L69) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/utils.ts:69](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/utils.ts#L69) -======= -[src/utils.ts:69](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/utils.ts#L69) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/utils.ts:69](https://github.com/adrien2p/medusa-extender/blob/0490090/src/utils.ts#L69) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/utils.ts:67](https://github.com/adrien2p/medusa-extender/blob/e820602/src/utils.ts#L67) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### logRoutes - -▸ `Static` **logRoutes**(`express`): `void` - -Log all the routes from the express instance. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `express` | `Express` | Express instance | - -#### Returns - -`void` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/utils.ts:57](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/utils.ts#L57) -======= -[src/utils.ts:59](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/utils.ts#L59) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/utils.ts:59](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/utils.ts#L59) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/utils.ts:59](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/utils.ts#L59) -======= -[src/utils.ts:59](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/utils.ts#L59) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/utils.ts:59](https://github.com/adrien2p/medusa-extender/blob/0490090/src/utils.ts#L59) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/utils.ts:57](https://github.com/adrien2p/medusa-extender/blob/e820602/src/utils.ts#L57) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### printRoutes - -▸ `Static` `Private` **printRoutes**(`path`, `layer`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `path` | `string`[] | -| `layer` | `any` | - -#### Returns - -`void` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/utils.ts:81](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/utils.ts#L81) -======= -[src/utils.ts:83](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/utils.ts#L83) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/utils.ts:83](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/utils.ts#L83) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/utils.ts:83](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/utils.ts#L83) -======= -[src/utils.ts:83](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/utils.ts#L83) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/utils.ts:83](https://github.com/adrien2p/medusa-extender/blob/0490090/src/utils.ts#L83) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/utils.ts:81](https://github.com/adrien2p/medusa-extender/blob/e820602/src/utils.ts#L81) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### repositoryMixin - -▸ `Static` **repositoryMixin**<`TEntity`, `TSource`\>(`source`): [`MixinReturnType`](../modules/types.md#mixinreturntype)<`Repository`<`TEntity`\>, `TSource`\> - -For repository context, you should extends repository and the medusa target repository. -Since it is not possible to use multiple extend, you can use that utilities to apply multiple extends. - -#### Type parameters - -| Name | -| :------ | -| `TEntity` | -| `TSource` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `source` | [`Constructor`](../modules/types.md#constructor)<`TSource`\> | - -#### Returns - -[`MixinReturnType`](../modules/types.md#mixinreturntype)<`Repository`<`TEntity`\>, `TSource`\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/utils.ts:16](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/utils.ts#L16) -======= -[src/utils.ts:16](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/utils.ts#L16) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/utils.ts:16](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/utils.ts#L16) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/utils.ts:16](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/utils.ts#L16) -======= -[src/utils.ts:16](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/utils.ts#L16) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/utils.ts:16](https://github.com/adrien2p/medusa-extender/blob/0490090/src/utils.ts#L16) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/utils.ts:16](https://github.com/adrien2p/medusa-extender/blob/e820602/src/utils.ts#L16) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### splitRoutes - -▸ `Static` `Private` **splitRoutes**(`thing`): `string` \| `string`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `thing` | `string` \| `RegExp` & { `fast_slash`: `boolean` } | - -#### Returns - -`string` \| `string`[] - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/utils.ts:101](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/utils.ts#L101) -======= -[src/utils.ts:103](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/utils.ts#L103) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/utils.ts:103](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/utils.ts#L103) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/utils.ts:103](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/utils.ts#L103) -======= -[src/utils.ts:103](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/utils.ts#L103) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/utils.ts:103](https://github.com/adrien2p/medusa-extender/blob/0490090/src/utils.ts#L103) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/utils.ts:101](https://github.com/adrien2p/medusa-extender/blob/e820602/src/utils.ts#L101) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 10895bfb..00000000 --- a/docs/index.html +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - Medusa-extender - - - - - - - -
Please wait...
- - - - - - - - - \ No newline at end of file diff --git a/docs/interfaces/types.MedusaMiddleware.md b/docs/interfaces/types.MedusaMiddleware.md deleted file mode 100644 index ea9c2c3b..00000000 --- a/docs/interfaces/types.MedusaMiddleware.md +++ /dev/null @@ -1,77 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / MedusaMiddleware - -# Interface: MedusaMiddleware - -[types](../modules/types.md).MedusaMiddleware - -**`interface`** -Describe a custom middleware instance. - -## Table of contents - -### Methods - -- [consume](types.MedusaMiddleware.md#consume) - -## Methods - -### consume - -▸ **consume**(`options`): (`req`: [`MedusaAuthenticatedRequest`](../modules/types.md#medusaauthenticatedrequest) \| `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\>, `res`: `Response`<`any`, `Record`<`string`, `any`\>\>, `next`: `NextFunction`) => `void` \| `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | `Object` | -| `options.app` | `Express` | - -#### Returns - -`fn` - -▸ (`req`, `res`, `next`): `void` \| `Promise`<`void`\> - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `req` | [`MedusaAuthenticatedRequest`](../modules/types.md#medusaauthenticatedrequest) \| `Request`<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`<`string`, `any`\>\> | -| `res` | `Response`<`any`, `Record`<`string`, `any`\>\> | -| `next` | `NextFunction` | - -##### Returns - -`void` \| `Promise`<`void`\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:152](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L152) -======= -[src/types.ts:135](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L135) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:145](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L145) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:145](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L145) -======= -[src/types.ts:145](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L145) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:145](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L145) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:152](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L152) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/interfaces/types.Type.md b/docs/interfaces/types.Type.md deleted file mode 100644 index f8532a56..00000000 --- a/docs/interfaces/types.Type.md +++ /dev/null @@ -1,71 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / [types](../modules/types.md) / Type - -# Interface: Type - -[types](../modules/types.md).Type - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -## Hierarchy - -- `Function` - - ↳ **`Type`** - -## Table of contents - -### Constructors - -- [constructor](types.Type.md#constructor) - -## Constructors - -### constructor - -• **new Type**(...`args`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `unknown`[] | - -#### Inherited from - -Function.constructor - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L6) -======= -[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L6) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L6) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L6) -======= -[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L6) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L6) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L6) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/media/coverage/badge-branches.svg b/docs/media/coverage/badge-branches.svg deleted file mode 100644 index 4cd2466a..00000000 --- a/docs/media/coverage/badge-branches.svg +++ /dev/null @@ -1 +0,0 @@ -Coverage:branches: 30.3%Coverage:branches30.3% \ No newline at end of file diff --git a/docs/media/coverage/badge-functions.svg b/docs/media/coverage/badge-functions.svg deleted file mode 100644 index 53562139..00000000 --- a/docs/media/coverage/badge-functions.svg +++ /dev/null @@ -1 +0,0 @@ -Coverage:functions: 60.82%Coverage:functions60.82% \ No newline at end of file diff --git a/docs/media/coverage/badge-lines.svg b/docs/media/coverage/badge-lines.svg deleted file mode 100644 index 64038eb8..00000000 --- a/docs/media/coverage/badge-lines.svg +++ /dev/null @@ -1 +0,0 @@ -Coverage:lines: 71.6%Coverage:lines71.6% \ No newline at end of file diff --git a/docs/media/coverage/badge-statements.svg b/docs/media/coverage/badge-statements.svg deleted file mode 100644 index 76cf062d..00000000 --- a/docs/media/coverage/badge-statements.svg +++ /dev/null @@ -1 +0,0 @@ -Coverage:statements: 71.34%Coverage:statements71.34% \ No newline at end of file diff --git a/docs/media/medusa-extender.jpeg b/docs/media/medusa-extender.jpeg deleted file mode 100644 index 950f5ede..00000000 Binary files a/docs/media/medusa-extender.jpeg and /dev/null differ diff --git a/docs/modules.md b/docs/modules.md deleted file mode 100644 index 1be089ef..00000000 --- a/docs/modules.md +++ /dev/null @@ -1,31 +0,0 @@ -[medusa-extender](README.md) / Exports - -# medusa-extender - -## Table of contents - -### Modules - -- [Medusa](modules/Medusa.md) -- [constants](modules/constants.md) -- [decorators](modules/decorators.md) -- [decorators/components.decorator](modules/decorators_components_decorator.md) -- [decorators/module.decorator](modules/decorators_module_decorator.md) -- [decorators/onMedusaEntityEvent.decorator](modules/decorators_onMedusaEntityEvent_decorator.md) -- [decorators/utils](modules/decorators_utils.md) -- [event-emmiter](modules/event_emmiter.md) -- [index](modules/index.md) -- [loaders](modules/loaders.md) -- [loaders/api.loader](modules/loaders_api_loader.md) -- [loaders/database.loader](modules/loaders_database_loader.md) -- [loaders/entities.loader](modules/loaders_entities_loader.md) -- [loaders/middlewares.loader](modules/loaders_middlewares_loader.md) -- [loaders/migrations.loader](modules/loaders_migrations_loader.md) -- [loaders/plugins.loader](modules/loaders_plugins_loader.md) -- [loaders/repository.loader](modules/loaders_repository_loader.md) -- [loaders/routes.loader](modules/loaders_routes_loader.md) -- [loaders/services.loader](modules/loaders_services_loader.md) -- [loaders/validators.loader](modules/loaders_validators_loader.md) -- [metadata-reader](modules/metadata_reader.md) -- [types](modules/types.md) -- [utils](modules/utils.md) diff --git a/docs/modules/Medusa.md b/docs/modules/Medusa.md deleted file mode 100644 index 0f840218..00000000 --- a/docs/modules/Medusa.md +++ /dev/null @@ -1,9 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / Medusa - -# Module: Medusa - -## Table of contents - -### Classes - -- [Medusa](../classes/Medusa.Medusa-1.md) diff --git a/docs/modules/constants.md b/docs/modules/constants.md deleted file mode 100644 index bf79c11a..00000000 --- a/docs/modules/constants.md +++ /dev/null @@ -1,165 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / constants - -# Module: constants - -## Table of contents - -### Variables - -- [INJECTABLE\_OPTIONS\_KEY](constants.md#injectable_options_key) -- [MEDUSA\_RESOLVER\_KEYS](constants.md#medusa_resolver_keys) -- [MODULE\_KEY](constants.md#module_key) - -## Variables - -### INJECTABLE\_OPTIONS\_KEY - -• **INJECTABLE\_OPTIONS\_KEY**: ``"__INJECTABLE_OPTIONS_KEY__"`` - -Metadata key to store config from decorated injectables. - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/constants.ts:9](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/constants.ts#L9) -======= -[src/constants.ts:9](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/constants.ts#L9) ->>>>>>> 834fee1... Feat() Update doc -======= -[src/constants.ts:9](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/constants.ts#L9) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/constants.ts:9](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/constants.ts#L9) -======= -[src/constants.ts:9](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/constants.ts#L9) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/constants.ts:9](https://github.com/adrien2p/medusa-extender/blob/0490090/src/constants.ts#L9) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/constants.ts:9](https://github.com/adrien2p/medusa-extender/blob/e820602/src/constants.ts#L9) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### MEDUSA\_RESOLVER\_KEYS - -• **MEDUSA\_RESOLVER\_KEYS**: `Object` - -Hold the name of the medusa services registered into the container for later on resolve. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `AuthService` | `string` | -| `CartService` | `string` | -| `CustomShippingOptionService` | `string` | -| `CustomerService` | `string` | -| `DefaultSearchService` | `string` | -| `DiscountService` | `string` | -| `DraftOrderService` | `string` | -| `EventBusService` | `string` | -| `FulfillmentProviderService` | `string` | -| `FulfillmentService` | `string` | -| `GiftCardService` | `string` | -| `InventoryService` | `string` | -| `LineItemService` | `string` | -| `MiddlewareService` | `string` | -| `NotificationService` | `string` | -| `OrderService` | `string` | -| `PaymentProviderService` | `string` | -| `ProductCollectionService` | `string` | -| `ProductService` | `string` | -| `ProductVariantService` | `string` | -| `RegionService` | `string` | -| `ShippingOptionService` | `string` | -| `ShippingProfileService` | `string` | -| `StoreService` | `string` | -| `TotalsService` | `string` | -| `UserService` | `string` | -| `logger` | `string` | -| `manager` | `string` | -| `requestContext` | `string` | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/constants.ts:14](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/constants.ts#L14) -======= -[src/constants.ts:14](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/constants.ts#L14) ->>>>>>> 834fee1... Feat() Update doc -======= -[src/constants.ts:14](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/constants.ts#L14) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/constants.ts:14](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/constants.ts#L14) -======= -[src/constants.ts:14](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/constants.ts#L14) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/constants.ts:14](https://github.com/adrien2p/medusa-extender/blob/0490090/src/constants.ts#L14) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/constants.ts:14](https://github.com/adrien2p/medusa-extender/blob/e820602/src/constants.ts#L14) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### MODULE\_KEY - -• **MODULE\_KEY**: ``"__MODULE_KEY__"`` - -Metadata key to store config from decorated injectables. - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/constants.ts:4](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/constants.ts#L4) -======= -[src/constants.ts:4](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/constants.ts#L4) ->>>>>>> 834fee1... Feat() Update doc -======= -[src/constants.ts:4](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/constants.ts#L4) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/constants.ts:4](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/constants.ts#L4) -======= -[src/constants.ts:4](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/constants.ts#L4) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/constants.ts:4](https://github.com/adrien2p/medusa-extender/blob/0490090/src/constants.ts#L4) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/constants.ts:4](https://github.com/adrien2p/medusa-extender/blob/e820602/src/constants.ts#L4) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/decorators.md b/docs/modules/decorators.md deleted file mode 100644 index fd92db8d..00000000 --- a/docs/modules/decorators.md +++ /dev/null @@ -1,267 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / decorators - -# Module: decorators - -## Table of contents - -### References - -- [Constructor](decorators.md#constructor) -- [Entity](decorators.md#entity) -- [EntityActions](decorators.md#entityactions) -- [EntityEventActionOptions](decorators.md#entityeventactionoptions) -- [EntityEventType](decorators.md#entityeventtype) -- [EntityInjectableOptions](decorators.md#entityinjectableoptions) -- [GetInjectableOption](decorators.md#getinjectableoption) -- [GetInjectableOptions](decorators.md#getinjectableoptions) -- [INJECTABLE\_OPTIONS\_KEY](decorators.md#injectable_options_key) -- [InjectableComponentTypes](decorators.md#injectablecomponenttypes) -- [InjectableOptions](decorators.md#injectableoptions) -- [MEDUSA\_RESOLVER\_KEYS](decorators.md#medusa_resolver_keys) -- [MODULE\_KEY](decorators.md#module_key) -- [MedusaAuthenticatedRequest](decorators.md#medusaauthenticatedrequest) -- [MedusaEventEmittedParams](decorators.md#medusaeventemittedparams) -- [MedusaEventHandlerParams](decorators.md#medusaeventhandlerparams) -- [MedusaMiddleware](decorators.md#medusamiddleware) -- [MedusaRequest](decorators.md#medusarequest) -- [MedusaRouteMethods](decorators.md#medusaroutemethods) -- [MedusaRouteOptions](decorators.md#medusarouteoptions) -- [Middleware](decorators.md#middleware) -- [MiddlewareInjectionOptions](decorators.md#middlewareinjectionoptions) -- [Migration](decorators.md#migration) -- [MixinReturnType](decorators.md#mixinreturntype) -- [Module](decorators.md#module) -- [OnMedusaEntityEvent](decorators.md#onmedusaentityevent) -- [Repository](decorators.md#repository) -- [RepositoryInjectableOptions](decorators.md#repositoryinjectableoptions) -- [Router](decorators.md#router) -- [RouterInjectionOptions](decorators.md#routerinjectionoptions) -- [RoutesInjectionRouterConfiguration](decorators.md#routesinjectionrouterconfiguration) -- [Service](decorators.md#service) -- [ServiceInjectableOptions](decorators.md#serviceinjectableoptions) -- [Type](decorators.md#type) -- [Validator](decorators.md#validator) -- [ValidatorInjectionOptions](decorators.md#validatorinjectionoptions) -- [buildComponentDecorator](decorators.md#buildcomponentdecorator) - -## References - -### Constructor - -Re-exports [Constructor](types.md#constructor) - -___ - -### Entity - -Re-exports [Entity](decorators_components_decorator.md#entity) - -___ - -### EntityActions - -Re-exports [EntityActions](decorators_onMedusaEntityEvent_decorator.md#entityactions) - -___ - -### EntityEventActionOptions - -Re-exports [EntityEventActionOptions](decorators_onMedusaEntityEvent_decorator.md#entityeventactionoptions) - -___ - -### EntityEventType - -Re-exports [EntityEventType](decorators_onMedusaEntityEvent_decorator.md#entityeventtype) - -___ - -### EntityInjectableOptions - -Re-exports [EntityInjectableOptions](types.md#entityinjectableoptions) - -___ - -### GetInjectableOption - -Re-exports [GetInjectableOption](types.md#getinjectableoption) - -___ - -### GetInjectableOptions - -Re-exports [GetInjectableOptions](types.md#getinjectableoptions) - -___ - -### INJECTABLE\_OPTIONS\_KEY - -Re-exports [INJECTABLE_OPTIONS_KEY](constants.md#injectable_options_key) - -___ - -### InjectableComponentTypes - -Re-exports [InjectableComponentTypes](types.md#injectablecomponenttypes) - -___ - -### InjectableOptions - -Re-exports [InjectableOptions](types.md#injectableoptions) - -___ - -### MEDUSA\_RESOLVER\_KEYS - -Re-exports [MEDUSA_RESOLVER_KEYS](constants.md#medusa_resolver_keys) - -___ - -### MODULE\_KEY - -Re-exports [MODULE_KEY](constants.md#module_key) - -___ - -### MedusaAuthenticatedRequest - -Re-exports [MedusaAuthenticatedRequest](types.md#medusaauthenticatedrequest) - -___ - -### MedusaEventEmittedParams - -Re-exports [MedusaEventEmittedParams](decorators_onMedusaEntityEvent_decorator.md#medusaeventemittedparams) - -___ - -### MedusaEventHandlerParams - -Re-exports [MedusaEventHandlerParams](decorators_onMedusaEntityEvent_decorator.md#medusaeventhandlerparams) - -___ - -### MedusaMiddleware - -Re-exports [MedusaMiddleware](../interfaces/types.MedusaMiddleware.md) - -___ - -### MedusaRequest - -Re-exports [MedusaRequest](types.md#medusarequest) - -___ - -### MedusaRouteMethods - -Re-exports [MedusaRouteMethods](types.md#medusaroutemethods) - -___ - -### MedusaRouteOptions - -Re-exports [MedusaRouteOptions](types.md#medusarouteoptions) - -___ - -### Middleware - -Re-exports [Middleware](decorators_components_decorator.md#middleware) - -___ - -### MiddlewareInjectionOptions - -Re-exports [MiddlewareInjectionOptions](types.md#middlewareinjectionoptions) - -___ - -### Migration - -Re-exports [Migration](decorators_components_decorator.md#migration) - -___ - -### MixinReturnType - -Re-exports [MixinReturnType](types.md#mixinreturntype) - -___ - -### Module - -Re-exports [Module](decorators_module_decorator.md#module) - -___ - -### OnMedusaEntityEvent - -Re-exports [OnMedusaEntityEvent](../classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md) - -___ - -### Repository - -Re-exports [Repository](decorators_components_decorator.md#repository) - -___ - -### RepositoryInjectableOptions - -Re-exports [RepositoryInjectableOptions](types.md#repositoryinjectableoptions) - -___ - -### Router - -Re-exports [Router](decorators_components_decorator.md#router) - -___ - -### RouterInjectionOptions - -Re-exports [RouterInjectionOptions](types.md#routerinjectionoptions) - -___ - -### RoutesInjectionRouterConfiguration - -Re-exports [RoutesInjectionRouterConfiguration](types.md#routesinjectionrouterconfiguration) - -___ - -### Service - -Re-exports [Service](decorators_components_decorator.md#service) - -___ - -### ServiceInjectableOptions - -Re-exports [ServiceInjectableOptions](types.md#serviceinjectableoptions) - -___ - -### Type - -Re-exports [Type](../interfaces/types.Type.md) - -___ - -### Validator - -Re-exports [Validator](decorators_components_decorator.md#validator) - -___ - -### ValidatorInjectionOptions - -Re-exports [ValidatorInjectionOptions](types.md#validatorinjectionoptions) - -___ - -### buildComponentDecorator - -Re-exports [buildComponentDecorator](decorators_utils.md#buildcomponentdecorator) diff --git a/docs/modules/decorators_components_decorator.md b/docs/modules/decorators_components_decorator.md deleted file mode 100644 index c25fdd3e..00000000 --- a/docs/modules/decorators_components_decorator.md +++ /dev/null @@ -1,373 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / decorators/components.decorator - -# Module: decorators/components.decorator - -## Table of contents - -### Functions - -- [Entity](decorators_components_decorator.md#entity) -- [Middleware](decorators_components_decorator.md#middleware) -- [Migration](decorators_components_decorator.md#migration) -- [Repository](decorators_components_decorator.md#repository) -- [Router](decorators_components_decorator.md#router) -- [Service](decorators_components_decorator.md#service) -- [Validator](decorators_components_decorator.md#validator) - -## Functions - -### Entity - -▸ **Entity**<`T`\>(`options`): `ClassDecorator` - -Mark a class as an entity to be used by the loader. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`EntityInjectableOptions`](types.md#entityinjectableoptions)<`T`\> | - -#### Returns - -`ClassDecorator` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/components.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/components.decorator.ts#L16) -======= -[src/decorators/components.decorator.ts:15](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/components.decorator.ts#L15) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/components.decorator.ts:15](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/components.decorator.ts#L15) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/components.decorator.ts:15](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/components.decorator.ts#L15) -======= -[src/decorators/components.decorator.ts:15](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/components.decorator.ts#L15) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/components.decorator.ts:15](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/components.decorator.ts#L15) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/components.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/components.decorator.ts#L16) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### Middleware - -▸ **Middleware**(`options`): `ClassDecorator` - -Mark a class as a middleware to be used by the loader. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`MiddlewareInjectionOptions`](types.md#middlewareinjectionoptions) | - -#### Returns - -`ClassDecorator` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/components.decorator.ts:43](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/components.decorator.ts#L43) -======= -[src/decorators/components.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/components.decorator.ts#L42) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/components.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/components.decorator.ts#L42) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/components.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/components.decorator.ts#L42) -======= -[src/decorators/components.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/components.decorator.ts#L42) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/components.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/components.decorator.ts#L42) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/components.decorator.ts:43](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/components.decorator.ts#L43) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### Migration - -▸ **Migration**(): `ClassDecorator` - -Mark a class as a migration to be used by the loader. - -#### Returns - -`ClassDecorator` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/components.decorator.ts:51](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/components.decorator.ts#L51) -======= -[src/decorators/components.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/components.decorator.ts#L50) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/components.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/components.decorator.ts#L50) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/components.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/components.decorator.ts#L50) -======= -[src/decorators/components.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/components.decorator.ts#L50) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/components.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/components.decorator.ts#L50) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/components.decorator.ts:51](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/components.decorator.ts#L51) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### Repository - -▸ **Repository**<`T`\>(`options`): `ClassDecorator` - -Mark a class as a repository to be used by the loader. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`RepositoryInjectableOptions`](types.md#repositoryinjectableoptions)<`T`\> | - -#### Returns - -`ClassDecorator` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/components.decorator.ts:34](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/components.decorator.ts#L34) -======= -[src/decorators/components.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/components.decorator.ts#L33) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/components.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/components.decorator.ts#L33) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/components.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/components.decorator.ts#L33) -======= -[src/decorators/components.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/components.decorator.ts#L33) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/components.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/components.decorator.ts#L33) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/components.decorator.ts:34](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/components.decorator.ts#L34) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### Router - -▸ **Router**(`options`): `ClassDecorator` - -Mark a class as a router to be used by the loader. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`RouterInjectionOptions`](types.md#routerinjectionoptions) | - -#### Returns - -`ClassDecorator` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/components.decorator.ts:60](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/components.decorator.ts#L60) -======= -[src/decorators/components.decorator.ts:59](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/components.decorator.ts#L59) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/components.decorator.ts:59](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/components.decorator.ts#L59) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/components.decorator.ts:59](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/components.decorator.ts#L59) -======= -[src/decorators/components.decorator.ts:59](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/components.decorator.ts#L59) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/components.decorator.ts:59](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/components.decorator.ts#L59) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/components.decorator.ts:60](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/components.decorator.ts#L60) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### Service - -▸ **Service**<`T`\>(`options`): `ClassDecorator` - -Mark a class as a service to be used by the loader. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`ServiceInjectableOptions`](types.md#serviceinjectableoptions)<`T`\> | - -#### Returns - -`ClassDecorator` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/components.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/components.decorator.ts#L25) -======= -[src/decorators/components.decorator.ts:24](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/components.decorator.ts#L24) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/components.decorator.ts:24](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/components.decorator.ts#L24) -======= -[src/decorators/components.decorator.ts:24](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/components.decorator.ts#L24) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/components.decorator.ts:24](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/components.decorator.ts#L24) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/components.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/components.decorator.ts#L25) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### Validator - -▸ **Validator**(`options`): `ClassDecorator` - -Mark a class as a validator to be used by the validator utility. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`ValidatorInjectionOptions`](types.md#validatorinjectionoptions)<`unknown`\> | - -#### Returns - -`ClassDecorator` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/components.decorator.ts:69](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/components.decorator.ts#L69) -======= -[src/decorators/components.decorator.ts:24](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/components.decorator.ts#L24) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/components.decorator.ts:68](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/components.decorator.ts#L68) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/components.decorator.ts:68](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/components.decorator.ts#L68) -======= -[src/decorators/components.decorator.ts:68](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/components.decorator.ts#L68) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/components.decorator.ts:68](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/components.decorator.ts#L68) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/components.decorator.ts:69](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/components.decorator.ts#L69) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/decorators_module_decorator.md b/docs/modules/decorators_module_decorator.md deleted file mode 100644 index 2130c2a5..00000000 --- a/docs/modules/decorators_module_decorator.md +++ /dev/null @@ -1,60 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / decorators/module.decorator - -# Module: decorators/module.decorator - -## Table of contents - -### Functions - -- [Module](decorators_module_decorator.md#module) - -## Functions - -### Module - -▸ **Module**(`imports`): `ClassDecorator` - -Mark a class as aa module and store all injectable on it. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `imports` | `Object` | The components to import | -| `imports.imports` | [`Type`](../interfaces/types.Type.md)<`unknown`\>[] | - | - -#### Returns - -`ClassDecorator` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/module.decorator.ts:9](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/module.decorator.ts#L9) -======= -[src/decorators/module.decorator.ts:9](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/module.decorator.ts#L9) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/module.decorator.ts:9](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/module.decorator.ts#L9) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/module.decorator.ts:9](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/module.decorator.ts#L9) -======= -[src/decorators/module.decorator.ts:9](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/module.decorator.ts#L9) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/module.decorator.ts:9](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/module.decorator.ts#L9) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/module.decorator.ts:9](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/module.decorator.ts#L9) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/decorators_onMedusaEntityEvent_decorator.md b/docs/modules/decorators_onMedusaEntityEvent_decorator.md deleted file mode 100644 index 85d8cdea..00000000 --- a/docs/modules/decorators_onMedusaEntityEvent_decorator.md +++ /dev/null @@ -1,261 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / decorators/onMedusaEntityEvent.decorator - -# Module: decorators/onMedusaEntityEvent.decorator - -## Table of contents - -### Classes - -- [OnMedusaEntityEvent](../classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md) - -### Type aliases - -- [EntityActions](decorators_onMedusaEntityEvent_decorator.md#entityactions) -- [EntityEventActionOptions](decorators_onMedusaEntityEvent_decorator.md#entityeventactionoptions) -- [EntityEventType](decorators_onMedusaEntityEvent_decorator.md#entityeventtype) -- [MedusaEventEmittedParams](decorators_onMedusaEntityEvent_decorator.md#medusaeventemittedparams) -- [MedusaEventHandlerParams](decorators_onMedusaEntityEvent_decorator.md#medusaeventhandlerparams) - -## Type aliases - -### EntityActions - -Ƭ **EntityActions**: ``"Insert"`` \| ``"Update"`` \| ``"Remove"`` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:11](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L11) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:11](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L11) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:11](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L11) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:11](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L11) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:11](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L11) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:11](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L11) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:11](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L11) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### EntityEventActionOptions - -Ƭ **EntityEventActionOptions**<`T`\>: `Object` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `async` | `boolean` | -| `metatype?` | [`Type`](../interfaces/types.Type.md)<`T`\> | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:6](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L6) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:6](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L6) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:6](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L6) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:6](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L6) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:6](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L6) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:6](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L6) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:6](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L6) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### EntityEventType - -Ƭ **EntityEventType**<`Entity`, `TEntityActions`\>: `TEntityActions` extends ``"Insert"`` ? `InsertEvent`<`Entity`\> : `TEntityActions` extends ``"Update"`` ? `UpdateEvent`<`Entity`\> : `RemoveEvent`<`Entity`\> - -Event types that can be emitted. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Entity` | `Entity` | -| `TEntityActions` | extends [`EntityActions`](decorators_onMedusaEntityEvent_decorator.md#entityactions) | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L16) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L16) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L16) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L16) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L16) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L16) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L16) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### MedusaEventEmittedParams - -Ƭ **MedusaEventEmittedParams**<`Entity`, `TEntityActions`\>: `Object` - -The arguments expected by the [OnMedusaEntityEvent](../classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md) decorator. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Entity` | `Entity` | -| `TEntityActions` | extends [`EntityActions`](decorators_onMedusaEntityEvent_decorator.md#entityactions) | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `values` | [`MedusaEventHandlerParams`](decorators_onMedusaEntityEvent_decorator.md#medusaeventhandlerparams)<`Entity`, `TEntityActions`\> | -| `resolveOrReject` | (`err?`: `Error`, `res?`: `unknown`) => `void` | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L25) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L25) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L25) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L25) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L25) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L25) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L25) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### MedusaEventHandlerParams - -Ƭ **MedusaEventHandlerParams**<`Entity`, `TEntityActions`\>: `Object` - -The arguments expected by the event handler. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `Entity` | `Entity` | -| `TEntityActions` | extends [`EntityActions`](decorators_onMedusaEntityEvent_decorator.md#entityactions) | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `event` | [`EntityEventType`](decorators_onMedusaEntityEvent_decorator.md#entityeventtype)<`Entity`, `TEntityActions`\> | -| `transactionalEntityManager?` | `EntityManager` | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/onMedusaEntityEvent.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/onMedusaEntityEvent.decorator.ts#L33) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/onMedusaEntityEvent.decorator.ts#L33) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L33) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/onMedusaEntityEvent.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/onMedusaEntityEvent.decorator.ts#L33) -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/onMedusaEntityEvent.decorator.ts#L33) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/onMedusaEntityEvent.decorator.ts#L33) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/onMedusaEntityEvent.decorator.ts:33](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/onMedusaEntityEvent.decorator.ts#L33) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/decorators_utils.md b/docs/modules/decorators_utils.md deleted file mode 100644 index 33732baa..00000000 --- a/docs/modules/decorators_utils.md +++ /dev/null @@ -1,63 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / decorators/utils - -# Module: decorators/utils - -## Table of contents - -### Functions - -- [buildComponentDecorator](decorators_utils.md#buildcomponentdecorator) - -## Functions - -### buildComponentDecorator - -▸ **buildComponentDecorator**<`T`\>(`options`): `ClassDecorator` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `options` | [`MiddlewareInjectionOptions`](types.md#middlewareinjectionoptions) & { `type`: [`InjectableComponentTypes`](types.md#injectablecomponenttypes) } & [`RouterInjectionOptions`](types.md#routerinjectionoptions) & { `type`: [`InjectableComponentTypes`](types.md#injectablecomponenttypes) } & [`EntityInjectableOptions`](types.md#entityinjectableoptions)<`T`\> & { `type`: [`InjectableComponentTypes`](types.md#injectablecomponenttypes) } & [`ServiceInjectableOptions`](types.md#serviceinjectableoptions)<`T`\> & { `type`: [`InjectableComponentTypes`](types.md#injectablecomponenttypes) } & [`RepositoryInjectableOptions`](types.md#repositoryinjectableoptions)<`T`\> & { `type`: [`InjectableComponentTypes`](types.md#injectablecomponenttypes) } & [`ValidatorInjectionOptions`](types.md#validatorinjectionoptions)<`T`\> & { `type`: [`InjectableComponentTypes`](types.md#injectablecomponenttypes) } | - -#### Returns - -`ClassDecorator` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/decorators/utils.ts:4](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/decorators/utils.ts#L4) -======= -[src/decorators/utils.ts:4](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/decorators/utils.ts#L4) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/decorators/utils.ts:4](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/utils.ts#L4) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/decorators/utils.ts:4](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/decorators/utils.ts#L4) -======= -[src/decorators/utils.ts:4](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/decorators/utils.ts#L4) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/decorators/utils.ts:4](https://github.com/adrien2p/medusa-extender/blob/0490090/src/decorators/utils.ts#L4) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/decorators/utils.ts:4](https://github.com/adrien2p/medusa-extender/blob/e820602/src/decorators/utils.ts#L4) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/event_emmiter.Internals.md b/docs/modules/event_emmiter.Internals.md deleted file mode 100644 index 550b4453..00000000 --- a/docs/modules/event_emmiter.Internals.md +++ /dev/null @@ -1,69 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / [event-emmiter](event_emmiter.md) / Internals - -# Namespace: Internals - -[event-emmiter](event_emmiter.md).Internals - -## Table of contents - -### Classes - -- [CustomEventEmmiter](../classes/event_emmiter.Internals.CustomEventEmmiter.md) - -### Type aliases - -- [ListenerDescriptor](event_emmiter.Internals.md#listenerdescriptor) - -## Type aliases - -### ListenerDescriptor - -Ƭ **ListenerDescriptor**<`T`\>: `Object` - -A listener descriptor. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `eventName` | `string` \| `symbol` | -| `metatype` | [`Type`](../interfaces/types.Type.md)<`T`\> | -| `propertyName` | `string` | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/event-emmiter.ts:9](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/event-emmiter.ts#L9) -======= -[src/event-emmiter.ts:9](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/event-emmiter.ts#L9) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/event-emmiter.ts:9](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/event-emmiter.ts#L9) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/event-emmiter.ts:9](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/event-emmiter.ts#L9) -======= -[src/event-emmiter.ts:9](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/event-emmiter.ts#L9) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/event-emmiter.ts:9](https://github.com/adrien2p/medusa-extender/blob/0490090/src/event-emmiter.ts#L9) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/event-emmiter.ts:9](https://github.com/adrien2p/medusa-extender/blob/e820602/src/event-emmiter.ts#L9) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/event_emmiter.md b/docs/modules/event_emmiter.md deleted file mode 100644 index 9ccda43a..00000000 --- a/docs/modules/event_emmiter.md +++ /dev/null @@ -1,54 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / event-emmiter - -# Module: event-emmiter - -## Table of contents - -### Namespaces - -- [Internals](event_emmiter.Internals.md) - -### Variables - -- [customEventEmitter](event_emmiter.md#customeventemitter) - -## Variables - -### customEventEmitter - -• **customEventEmitter**: [`CustomEventEmmiter`](../classes/event_emmiter.Internals.CustomEventEmmiter.md) - -**`internal`** -Export the instance of the event emmiter. - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/event-emmiter.ts:102](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/event-emmiter.ts#L102) -======= -[src/event-emmiter.ts:102](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/event-emmiter.ts#L102) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/event-emmiter.ts:102](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/event-emmiter.ts#L102) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/event-emmiter.ts:102](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/event-emmiter.ts#L102) -======= -[src/event-emmiter.ts:102](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/event-emmiter.ts#L102) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/event-emmiter.ts:102](https://github.com/adrien2p/medusa-extender/blob/0490090/src/event-emmiter.ts#L102) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/event-emmiter.ts:102](https://github.com/adrien2p/medusa-extender/blob/e820602/src/event-emmiter.ts#L102) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/index.md b/docs/modules/index.md deleted file mode 100644 index 47d58838..00000000 --- a/docs/modules/index.md +++ /dev/null @@ -1,316 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / index - -# Module: index - -## Table of contents - -### References - -- [Constructor](index.md#constructor) -- [Entity](index.md#entity) -- [EntityActions](index.md#entityactions) -- [EntityEventActionOptions](index.md#entityeventactionoptions) -- [EntityEventType](index.md#entityeventtype) -- [EntityInjectableOptions](index.md#entityinjectableoptions) -- [GetInjectableOption](index.md#getinjectableoption) -- [GetInjectableOptions](index.md#getinjectableoptions) -- [INJECTABLE\_OPTIONS\_KEY](index.md#injectable_options_key) -- [InjectableComponentTypes](index.md#injectablecomponenttypes) -- [InjectableOptions](index.md#injectableoptions) -- [MEDUSA\_RESOLVER\_KEYS](index.md#medusa_resolver_keys) -- [MODULE\_KEY](index.md#module_key) -- [Medusa](index.md#medusa) -- [MedusaAuthenticatedRequest](index.md#medusaauthenticatedrequest) -- [MedusaEventEmittedParams](index.md#medusaeventemittedparams) -- [MedusaEventHandlerParams](index.md#medusaeventhandlerparams) -- [MedusaMiddleware](index.md#medusamiddleware) -- [MedusaRequest](index.md#medusarequest) -- [MedusaRouteMethods](index.md#medusaroutemethods) -- [MedusaRouteOptions](index.md#medusarouteoptions) -- [Middleware](index.md#middleware) -- [MiddlewareInjectionOptions](index.md#middlewareinjectionoptions) -- [Migration](index.md#migration) -- [MixinReturnType](index.md#mixinreturntype) -- [Module](index.md#module) -- [OnMedusaEntityEvent](index.md#onmedusaentityevent) -- [Repository](index.md#repository) -- [RepositoryInjectableOptions](index.md#repositoryinjectableoptions) -- [Router](index.md#router) -- [RouterInjectionOptions](index.md#routerinjectionoptions) -- [RoutesInjectionRouterConfiguration](index.md#routesinjectionrouterconfiguration) -- [Service](index.md#service) -- [ServiceInjectableOptions](index.md#serviceinjectableoptions) -- [Type](index.md#type) -- [ValidatorInjectionOptions](index.md#validatorinjectionoptions) -- [eventEmitter](index.md#eventemitter) - -### Variables - -- [Utils](index.md#utils) - -## References - -### Constructor - -Re-exports [Constructor](types.md#constructor) - -___ - -### Entity - -Re-exports [Entity](decorators_components_decorator.md#entity) - -___ - -### EntityActions - -Re-exports [EntityActions](decorators_onMedusaEntityEvent_decorator.md#entityactions) - -___ - -### EntityEventActionOptions - -Re-exports [EntityEventActionOptions](decorators_onMedusaEntityEvent_decorator.md#entityeventactionoptions) - -___ - -### EntityEventType - -Re-exports [EntityEventType](decorators_onMedusaEntityEvent_decorator.md#entityeventtype) - -___ - -### EntityInjectableOptions - -Re-exports [EntityInjectableOptions](types.md#entityinjectableoptions) - -___ - -### GetInjectableOption - -Re-exports [GetInjectableOption](types.md#getinjectableoption) - -___ - -### GetInjectableOptions - -Re-exports [GetInjectableOptions](types.md#getinjectableoptions) - -___ - -### INJECTABLE\_OPTIONS\_KEY - -Re-exports [INJECTABLE_OPTIONS_KEY](constants.md#injectable_options_key) - -___ - -### InjectableComponentTypes - -Re-exports [InjectableComponentTypes](types.md#injectablecomponenttypes) - -___ - -### InjectableOptions - -Re-exports [InjectableOptions](types.md#injectableoptions) - -___ - -### MEDUSA\_RESOLVER\_KEYS - -Re-exports [MEDUSA_RESOLVER_KEYS](constants.md#medusa_resolver_keys) - -___ - -### MODULE\_KEY - -Re-exports [MODULE_KEY](constants.md#module_key) - -___ - -### Medusa - -Re-exports [Medusa](../classes/Medusa.Medusa-1.md) - -___ - -### MedusaAuthenticatedRequest - -Re-exports [MedusaAuthenticatedRequest](types.md#medusaauthenticatedrequest) - -___ - -### MedusaEventEmittedParams - -Re-exports [MedusaEventEmittedParams](decorators_onMedusaEntityEvent_decorator.md#medusaeventemittedparams) - -___ - -### MedusaEventHandlerParams - -Re-exports [MedusaEventHandlerParams](decorators_onMedusaEntityEvent_decorator.md#medusaeventhandlerparams) - -___ - -### MedusaMiddleware - -Re-exports [MedusaMiddleware](../interfaces/types.MedusaMiddleware.md) - -___ - -### MedusaRequest - -Re-exports [MedusaRequest](types.md#medusarequest) - -___ - -### MedusaRouteMethods - -Re-exports [MedusaRouteMethods](types.md#medusaroutemethods) - -___ - -### MedusaRouteOptions - -Re-exports [MedusaRouteOptions](types.md#medusarouteoptions) - -___ - -### Middleware - -Re-exports [Middleware](decorators_components_decorator.md#middleware) - -___ - -### MiddlewareInjectionOptions - -Re-exports [MiddlewareInjectionOptions](types.md#middlewareinjectionoptions) - -___ - -### Migration - -Re-exports [Migration](decorators_components_decorator.md#migration) - -___ - -### MixinReturnType - -Re-exports [MixinReturnType](types.md#mixinreturntype) - -___ - -### Module - -Re-exports [Module](decorators_module_decorator.md#module) - -___ - -### OnMedusaEntityEvent - -Re-exports [OnMedusaEntityEvent](../classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md) - -___ - -### Repository - -Re-exports [Repository](decorators_components_decorator.md#repository) - -___ - -### RepositoryInjectableOptions - -Re-exports [RepositoryInjectableOptions](types.md#repositoryinjectableoptions) - -___ - -### Router - -Re-exports [Router](decorators_components_decorator.md#router) - -___ - -### RouterInjectionOptions - -Re-exports [RouterInjectionOptions](types.md#routerinjectionoptions) - -___ - -### RoutesInjectionRouterConfiguration - -Re-exports [RoutesInjectionRouterConfiguration](types.md#routesinjectionrouterconfiguration) - -___ - -### Service - -Re-exports [Service](decorators_components_decorator.md#service) - -___ - -### ServiceInjectableOptions - -Re-exports [ServiceInjectableOptions](types.md#serviceinjectableoptions) - -___ - -### Type - -Re-exports [Type](../interfaces/types.Type.md) - -___ - -### ValidatorInjectionOptions - -Re-exports [ValidatorInjectionOptions](types.md#validatorinjectionoptions) - -___ - -### eventEmitter - -Renames and re-exports [customEventEmitter](event_emmiter.md#customeventemitter) - -## Variables - -### Utils - -• **Utils**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `attachOrReplaceEntitySubscriber` | (`connection`: `Connection`, `Subscriber`: `T`, `transactionalEntityManager?`: `EntityManager`) => `void` | -| `repositoryMixin` | (`source`: [`Constructor`](types.md#constructor)<`TSource`\>) => [`MixinReturnType`](types.md#mixinreturntype)<`Repository`<`TEntity`\>, `TSource`\> | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/index.ts:25](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/index.ts#L25) -======= -[src/index.ts:25](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/index.ts#L25) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/index.ts:25](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/index.ts#L25) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/index.ts:25](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/index.ts#L25) -======= -[src/index.ts:25](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/index.ts#L25) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/index.ts:25](https://github.com/adrien2p/medusa-extender/blob/0490090/src/index.ts#L25) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/index.ts:25](https://github.com/adrien2p/medusa-extender/blob/e820602/src/index.ts#L25) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/loaders.md b/docs/modules/loaders.md deleted file mode 100644 index 4e06871a..00000000 --- a/docs/modules/loaders.md +++ /dev/null @@ -1,274 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / loaders - -# Module: loaders - -## Table of contents - -### References - -- [Constructor](loaders.md#constructor) -- [EntityInjectableOptions](loaders.md#entityinjectableoptions) -- [GetInjectableOption](loaders.md#getinjectableoption) -- [GetInjectableOptions](loaders.md#getinjectableoptions) -- [InjectableComponentTypes](loaders.md#injectablecomponenttypes) -- [InjectableOptions](loaders.md#injectableoptions) -- [MedusaAuthenticatedRequest](loaders.md#medusaauthenticatedrequest) -- [MedusaMiddleware](loaders.md#medusamiddleware) -- [MedusaRequest](loaders.md#medusarequest) -- [MedusaRouteMethods](loaders.md#medusaroutemethods) -- [MedusaRouteOptions](loaders.md#medusarouteoptions) -- [MiddlewareInjectionOptions](loaders.md#middlewareinjectionoptions) -- [MixinReturnType](loaders.md#mixinreturntype) -- [RepositoryInjectableOptions](loaders.md#repositoryinjectableoptions) -- [RouterInjectionOptions](loaders.md#routerinjectionoptions) -- [RoutesInjectionRouterConfiguration](loaders.md#routesinjectionrouterconfiguration) -- [ServiceInjectableOptions](loaders.md#serviceinjectableoptions) -- [Type](loaders.md#type) -- [Utils](loaders.md#utils) -- [ValidatorInjectionOptions](loaders.md#validatorinjectionoptions) -- [apiLoader](loaders.md#apiloader) -- [authenticatedRoutesLoader](loaders.md#authenticatedroutesloader) -- [databaseLoader](loaders.md#databaseloader) -- [entitiesLoader](loaders.md#entitiesloader) -- [migrationsLoader](loaders.md#migrationsloader) -- [overrideEntitiesLoader](loaders.md#overrideentitiesloader) -- [overrideEntity](loaders.md#overrideentity) -- [overrideRepositoriesLoader](loaders.md#overriderepositoriesloader) -- [overrideRepository](loaders.md#overriderepository) -- [overrideService](loaders.md#overrideservice) -- [pluginsLoadersAndListeners](loaders.md#pluginsloadersandlisteners) -- [registerEntity](loaders.md#registerentity) -- [registerRepository](loaders.md#registerrepository) -- [registerService](loaders.md#registerservice) -- [repositoriesLoader](loaders.md#repositoriesloader) -- [servicesLoader](loaders.md#servicesloader) -- [unauthenticatedRoutesLoader](loaders.md#unauthenticatedroutesloader) -- [validatorsLoader](loaders.md#validatorsloader) - -## References - -### Constructor - -Re-exports [Constructor](types.md#constructor) - -___ - -### EntityInjectableOptions - -Re-exports [EntityInjectableOptions](types.md#entityinjectableoptions) - -___ - -### GetInjectableOption - -Re-exports [GetInjectableOption](types.md#getinjectableoption) - -___ - -### GetInjectableOptions - -Re-exports [GetInjectableOptions](types.md#getinjectableoptions) - -___ - -### InjectableComponentTypes - -Re-exports [InjectableComponentTypes](types.md#injectablecomponenttypes) - -___ - -### InjectableOptions - -Re-exports [InjectableOptions](types.md#injectableoptions) - -___ - -### MedusaAuthenticatedRequest - -Re-exports [MedusaAuthenticatedRequest](types.md#medusaauthenticatedrequest) - -___ - -### MedusaMiddleware - -Re-exports [MedusaMiddleware](../interfaces/types.MedusaMiddleware.md) - -___ - -### MedusaRequest - -Re-exports [MedusaRequest](types.md#medusarequest) - -___ - -### MedusaRouteMethods - -Re-exports [MedusaRouteMethods](types.md#medusaroutemethods) - -___ - -### MedusaRouteOptions - -Re-exports [MedusaRouteOptions](types.md#medusarouteoptions) - -___ - -### MiddlewareInjectionOptions - -Re-exports [MiddlewareInjectionOptions](types.md#middlewareinjectionoptions) - -___ - -### MixinReturnType - -Re-exports [MixinReturnType](types.md#mixinreturntype) - -___ - -### RepositoryInjectableOptions - -Re-exports [RepositoryInjectableOptions](types.md#repositoryinjectableoptions) - -___ - -### RouterInjectionOptions - -Re-exports [RouterInjectionOptions](types.md#routerinjectionoptions) - -___ - -### RoutesInjectionRouterConfiguration - -Re-exports [RoutesInjectionRouterConfiguration](types.md#routesinjectionrouterconfiguration) - -___ - -### ServiceInjectableOptions - -Re-exports [ServiceInjectableOptions](types.md#serviceinjectableoptions) - -___ - -### Type - -Re-exports [Type](../interfaces/types.Type.md) - -___ - -### Utils - -Re-exports [Utils](../classes/utils.Utils.md) - -___ - -### ValidatorInjectionOptions - -Re-exports [ValidatorInjectionOptions](types.md#validatorinjectionoptions) - -___ - -### apiLoader - -Re-exports [apiLoader](loaders_api_loader.md#apiloader) - -___ - -### authenticatedRoutesLoader - -Re-exports [authenticatedRoutesLoader](loaders_routes_loader.md#authenticatedroutesloader) - -___ - -### databaseLoader - -Re-exports [databaseLoader](loaders_database_loader.md#databaseloader) - -___ - -### entitiesLoader - -Re-exports [entitiesLoader](loaders_entities_loader.md#entitiesloader) - -___ - -### migrationsLoader - -Re-exports [migrationsLoader](loaders_migrations_loader.md#migrationsloader) - -___ - -### overrideEntitiesLoader - -Re-exports [overrideEntitiesLoader](loaders_entities_loader.md#overrideentitiesloader) - -___ - -### overrideEntity - -Re-exports [overrideEntity](loaders_entities_loader.md#overrideentity) - -___ - -### overrideRepositoriesLoader - -Re-exports [overrideRepositoriesLoader](loaders_repository_loader.md#overriderepositoriesloader) - -___ - -### overrideRepository - -Re-exports [overrideRepository](loaders_repository_loader.md#overriderepository) - -___ - -### overrideService - -Re-exports [overrideService](loaders_services_loader.md#overrideservice) - -___ - -### pluginsLoadersAndListeners - -Re-exports [pluginsLoadersAndListeners](loaders_plugins_loader.md#pluginsloadersandlisteners) - -___ - -### registerEntity - -Re-exports [registerEntity](loaders_entities_loader.md#registerentity) - -___ - -### registerRepository - -Re-exports [registerRepository](loaders_repository_loader.md#registerrepository) - -___ - -### registerService - -Re-exports [registerService](loaders_services_loader.md#registerservice) - -___ - -### repositoriesLoader - -Re-exports [repositoriesLoader](loaders_repository_loader.md#repositoriesloader) - -___ - -### servicesLoader - -Re-exports [servicesLoader](loaders_services_loader.md#servicesloader) - -___ - -### unauthenticatedRoutesLoader - -Re-exports [unauthenticatedRoutesLoader](loaders_routes_loader.md#unauthenticatedroutesloader) - -___ - -### validatorsLoader - -Re-exports [validatorsLoader](loaders_validators_loader.md#validatorsloader) diff --git a/docs/modules/loaders_api_loader.md b/docs/modules/loaders_api_loader.md deleted file mode 100644 index 9f67a757..00000000 --- a/docs/modules/loaders_api_loader.md +++ /dev/null @@ -1,61 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / loaders/api.loader - -# Module: loaders/api.loader - -## Table of contents - -### Functions - -- [apiLoader](loaders_api_loader.md#apiloader) - -## Functions - -### apiLoader - -▸ **apiLoader**(`app`, `middlewares`): `Promise`<`void`\> - -**`internal`** -Decorate the original api loader to apply our custom middleware first. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `app` | `Express` | Express app | -| `middlewares` | [`GetInjectableOptions`](types.md#getinjectableoptions)<``"middleware"``\> | | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/api.loader.ts:12](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/api.loader.ts#L12) -======= -[src/loaders/api.loader.ts:12](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/api.loader.ts#L12) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/api.loader.ts:12](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/api.loader.ts#L12) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/api.loader.ts:12](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/api.loader.ts#L12) -======= -[src/loaders/api.loader.ts:12](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/api.loader.ts#L12) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/api.loader.ts:12](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/api.loader.ts#L12) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/api.loader.ts:12](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/api.loader.ts#L12) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/loaders_database_loader.md b/docs/modules/loaders_database_loader.md deleted file mode 100644 index ce5a9011..00000000 --- a/docs/modules/loaders_database_loader.md +++ /dev/null @@ -1,58 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / loaders/database.loader - -# Module: loaders/database.loader - -## Table of contents - -### Functions - -- [databaseLoader](loaders_database_loader.md#databaseloader) - -## Functions - -### databaseLoader - -▸ **databaseLoader**(`entities`, `repositories`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `entities` | [`GetInjectableOptions`](types.md#getinjectableoptions)<``"entity"``\> | -| `repositories` | [`GetInjectableOptions`](types.md#getinjectableoptions)<``"repository"``\> | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/database.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/database.loader.ts#L5) -======= -[src/loaders/database.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/database.loader.ts#L5) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/database.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/database.loader.ts#L5) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/database.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/database.loader.ts#L5) -======= -[src/loaders/database.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/database.loader.ts#L5) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/database.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/database.loader.ts#L5) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/database.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/database.loader.ts#L5) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/loaders_entities_loader.md b/docs/modules/loaders_entities_loader.md deleted file mode 100644 index c010836e..00000000 --- a/docs/modules/loaders_entities_loader.md +++ /dev/null @@ -1,212 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / loaders/entities.loader - -# Module: loaders/entities.loader - -## Table of contents - -### Functions - -- [entitiesLoader](loaders_entities_loader.md#entitiesloader) -- [overrideEntitiesLoader](loaders_entities_loader.md#overrideentitiesloader) -- [overrideEntity](loaders_entities_loader.md#overrideentity) -- [registerEntity](loaders_entities_loader.md#registerentity) - -## Functions - -### entitiesLoader - -▸ **entitiesLoader**(`entities`, `container`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `entities` | [`GetInjectableOptions`](types.md#getinjectableoptions)<``"entity"``\> | -| `container` | `AwilixContainer`<`any`\> | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/entities.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/entities.loader.ts#L5) -======= -[src/loaders/entities.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/entities.loader.ts#L5) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/entities.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/entities.loader.ts#L5) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/entities.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/entities.loader.ts#L5) -======= -[src/loaders/entities.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/entities.loader.ts#L5) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/entities.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/entities.loader.ts#L5) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/entities.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/entities.loader.ts#L5) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### overrideEntitiesLoader - -▸ **overrideEntitiesLoader**(`entities`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `entities` | [`GetInjectableOptions`](types.md#getinjectableoptions)<``"entity"``\> | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/entities.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/entities.loader.ts#L16) -======= -[src/loaders/entities.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/entities.loader.ts#L16) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/entities.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/entities.loader.ts#L16) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/entities.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/entities.loader.ts#L16) -======= -[src/loaders/entities.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/entities.loader.ts#L16) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/entities.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/entities.loader.ts#L16) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/entities.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/entities.loader.ts#L16) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### overrideEntity - -▸ **overrideEntity**(`entityOptions`): `Promise`<`void`\> - -**`internal`** -Load custom entity and override existing ones. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `entityOptions` | [`GetInjectableOption`](types.md#getinjectableoption)<``"entity"``\> | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/entities.loader.ts:49](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/entities.loader.ts#L49) -======= -[src/loaders/entities.loader.ts:49](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/entities.loader.ts#L49) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/entities.loader.ts:49](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/entities.loader.ts#L49) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/entities.loader.ts:49](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/entities.loader.ts#L49) -======= -[src/loaders/entities.loader.ts:49](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/entities.loader.ts#L49) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/entities.loader.ts:49](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/entities.loader.ts#L49) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/entities.loader.ts:49](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/entities.loader.ts#L49) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### registerEntity - -▸ **registerEntity**(`container`, `entityOptions`): `void` - -**`internal`** -Load custom entity into the container. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `container` | `AwilixContainer`<`any`\> | -| `entityOptions` | [`GetInjectableOption`](types.md#getinjectableoption)<``"entity"``\> | - -#### Returns - -`void` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/entities.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/entities.loader.ts#L30) -======= -[src/loaders/entities.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/entities.loader.ts#L30) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/entities.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/entities.loader.ts#L30) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/entities.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/entities.loader.ts#L30) -======= -[src/loaders/entities.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/entities.loader.ts#L30) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/entities.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/entities.loader.ts#L30) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/entities.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/entities.loader.ts#L30) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/loaders_middlewares_loader.md b/docs/modules/loaders_middlewares_loader.md deleted file mode 100644 index fae72c5c..00000000 --- a/docs/modules/loaders_middlewares_loader.md +++ /dev/null @@ -1,62 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / loaders/middlewares.loader - -# Module: loaders/middlewares.loader - -## Table of contents - -### Functions - -- [middlewaresLoader](loaders_middlewares_loader.md#middlewaresloader) - -## Functions - -### middlewaresLoader - -▸ **middlewaresLoader**(`app`, `container`, `middlewares`): `void` - -**`internal`** -Register custom middlewares into the middlewareRegistery. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `app` | `Express` | -| `container` | `AwilixContainer`<`any`\> | -| `middlewares` | [`GetInjectableOptions`](types.md#getinjectableoptions)<``"middleware"``\> | - -#### Returns - -`void` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/middlewares.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/middlewares.loader.ts#L13) -======= -[src/loaders/middlewares.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/middlewares.loader.ts#L13) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/middlewares.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/middlewares.loader.ts#L13) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/middlewares.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/middlewares.loader.ts#L13) -======= -[src/loaders/middlewares.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/middlewares.loader.ts#L13) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/middlewares.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/middlewares.loader.ts#L13) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/middlewares.loader.ts:13](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/middlewares.loader.ts#L13) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/loaders_migrations_loader.md b/docs/modules/loaders_migrations_loader.md deleted file mode 100644 index 0dcd9142..00000000 --- a/docs/modules/loaders_migrations_loader.md +++ /dev/null @@ -1,61 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / loaders/migrations.loader - -# Module: loaders/migrations.loader - -## Table of contents - -### Functions - -- [migrationsLoader](loaders_migrations_loader.md#migrationsloader) - -## Functions - -### migrationsLoader - -▸ **migrationsLoader**(`migrationsOptions`, `dbConnection`): `Promise`<`void`\> - -**`internal`** -Run custom migrations that are find from the provided directory and stored in a `migrations` subdirectory. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `migrationsOptions` | [`GetInjectableOptions`](types.md#getinjectableoptions)<``"migration"``\> | Any custom migration that implements MigrationInterface | -| `dbConnection` | `Connection` | Database connection from medusa internal | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/migrations.loader.ts:10](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/migrations.loader.ts#L10) -======= -[src/loaders/migrations.loader.ts:10](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/migrations.loader.ts#L10) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/migrations.loader.ts:10](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/migrations.loader.ts#L10) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/migrations.loader.ts:10](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/migrations.loader.ts#L10) -======= -[src/loaders/migrations.loader.ts:10](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/migrations.loader.ts#L10) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/migrations.loader.ts:10](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/migrations.loader.ts#L10) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/migrations.loader.ts:10](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/migrations.loader.ts#L10) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/loaders_plugins_loader.md b/docs/modules/loaders_plugins_loader.md deleted file mode 100644 index 8beb922b..00000000 --- a/docs/modules/loaders_plugins_loader.md +++ /dev/null @@ -1,60 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / loaders/plugins.loader - -# Module: loaders/plugins.loader - -## Table of contents - -### Functions - -- [pluginsLoadersAndListeners](loaders_plugins_loader.md#pluginsloadersandlisteners) - -## Functions - -### pluginsLoadersAndListeners - -▸ **pluginsLoadersAndListeners**(`app`): `Promise`<`void`\> - -**`internal`** -Register all listeners before the plugins are loaded to be sure that the scope middleware has already been created. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `app` | `Express` | Express app | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/plugins.loader.ts:11](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/plugins.loader.ts#L11) -======= -[src/loaders/plugins.loader.ts:11](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/plugins.loader.ts#L11) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/plugins.loader.ts:11](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/plugins.loader.ts#L11) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/plugins.loader.ts:11](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/plugins.loader.ts#L11) -======= -[src/loaders/plugins.loader.ts:11](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/plugins.loader.ts#L11) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/plugins.loader.ts:11](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/plugins.loader.ts#L11) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/plugins.loader.ts:11](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/plugins.loader.ts#L11) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/loaders_repository_loader.md b/docs/modules/loaders_repository_loader.md deleted file mode 100644 index ed5f2d86..00000000 --- a/docs/modules/loaders_repository_loader.md +++ /dev/null @@ -1,212 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / loaders/repository.loader - -# Module: loaders/repository.loader - -## Table of contents - -### Functions - -- [overrideRepositoriesLoader](loaders_repository_loader.md#overriderepositoriesloader) -- [overrideRepository](loaders_repository_loader.md#overriderepository) -- [registerRepository](loaders_repository_loader.md#registerrepository) -- [repositoriesLoader](loaders_repository_loader.md#repositoriesloader) - -## Functions - -### overrideRepositoriesLoader - -▸ **overrideRepositoriesLoader**(`repositories`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `repositories` | [`GetInjectableOptions`](types.md#getinjectableoptions)<``"repository"``\> | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/repository.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/repository.loader.ts#L16) -======= -[src/loaders/repository.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/repository.loader.ts#L16) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/repository.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/repository.loader.ts#L16) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/repository.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/repository.loader.ts#L16) -======= -[src/loaders/repository.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/repository.loader.ts#L16) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/repository.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/repository.loader.ts#L16) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/repository.loader.ts:16](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/repository.loader.ts#L16) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### overrideRepository - -▸ **overrideRepository**(`repositoryOptions`): `Promise`<`void`\> - -**`internal`** -Load custom repositories and override existing ones. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `repositoryOptions` | [`GetInjectableOption`](types.md#getinjectableoption)<``"repository"``\> | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/repository.loader.ts:48](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/repository.loader.ts#L48) -======= -[src/loaders/repository.loader.ts:48](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/repository.loader.ts#L48) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/repository.loader.ts:48](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/repository.loader.ts#L48) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/repository.loader.ts:48](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/repository.loader.ts#L48) -======= -[src/loaders/repository.loader.ts:48](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/repository.loader.ts#L48) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/repository.loader.ts:48](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/repository.loader.ts#L48) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/repository.loader.ts:48](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/repository.loader.ts#L48) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### registerRepository - -▸ **registerRepository**(`container`, `repositoryOptions`): `void` - -**`internal`** -Load custom repository into the container. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `container` | `AwilixContainer`<`any`\> | -| `repositoryOptions` | [`GetInjectableOption`](types.md#getinjectableoption)<``"repository"``\> | - -#### Returns - -`void` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/repository.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/repository.loader.ts#L30) -======= -[src/loaders/repository.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/repository.loader.ts#L30) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/repository.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/repository.loader.ts#L30) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/repository.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/repository.loader.ts#L30) -======= -[src/loaders/repository.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/repository.loader.ts#L30) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/repository.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/repository.loader.ts#L30) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/repository.loader.ts:30](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/repository.loader.ts#L30) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### repositoriesLoader - -▸ **repositoriesLoader**(`repositories`, `container`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `repositories` | [`GetInjectableOptions`](types.md#getinjectableoptions)<``"repository"``\> | -| `container` | `AwilixContainer`<`any`\> | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/repository.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/repository.loader.ts#L5) -======= -[src/loaders/repository.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/repository.loader.ts#L5) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/repository.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/repository.loader.ts#L5) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/repository.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/repository.loader.ts#L5) -======= -[src/loaders/repository.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/repository.loader.ts#L5) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/repository.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/repository.loader.ts#L5) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/repository.loader.ts:5](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/repository.loader.ts#L5) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/loaders_routes_loader.md b/docs/modules/loaders_routes_loader.md deleted file mode 100644 index cd51e085..00000000 --- a/docs/modules/loaders_routes_loader.md +++ /dev/null @@ -1,108 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / loaders/routes.loader - -# Module: loaders/routes.loader - -## Table of contents - -### Functions - -- [authenticatedRoutesLoader](loaders_routes_loader.md#authenticatedroutesloader) -- [unauthenticatedRoutesLoader](loaders_routes_loader.md#unauthenticatedroutesloader) - -## Functions - -### authenticatedRoutesLoader - -▸ **authenticatedRoutesLoader**(`routesOptions`, `app`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `routesOptions` | [`GetInjectableOptions`](types.md#getinjectableoptions)<``"router"``\> | -| `app` | `Express` | - -#### Returns - -`void` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/routes.loader.ts:4](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/routes.loader.ts#L4) -======= -[src/loaders/routes.loader.ts:4](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/routes.loader.ts#L4) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/routes.loader.ts:4](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/routes.loader.ts#L4) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/routes.loader.ts:4](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/routes.loader.ts#L4) -======= -[src/loaders/routes.loader.ts:4](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/routes.loader.ts#L4) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/routes.loader.ts:4](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/routes.loader.ts#L4) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/routes.loader.ts:4](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/routes.loader.ts#L4) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### unauthenticatedRoutesLoader - -▸ **unauthenticatedRoutesLoader**(`routesOptions`, `app`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `routesOptions` | [`GetInjectableOptions`](types.md#getinjectableoptions)<``"router"``\> | -| `app` | `Express` | - -#### Returns - -`void` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/routes.loader.ts:14](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/routes.loader.ts#L14) -======= -[src/loaders/routes.loader.ts:14](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/routes.loader.ts#L14) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/routes.loader.ts:14](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/routes.loader.ts#L14) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/routes.loader.ts:14](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/routes.loader.ts#L14) -======= -[src/loaders/routes.loader.ts:14](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/routes.loader.ts#L14) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/routes.loader.ts:14](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/routes.loader.ts#L14) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/routes.loader.ts:14](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/routes.loader.ts#L14) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/loaders_services_loader.md b/docs/modules/loaders_services_loader.md deleted file mode 100644 index 2ef6e55f..00000000 --- a/docs/modules/loaders_services_loader.md +++ /dev/null @@ -1,168 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / loaders/services.loader - -# Module: loaders/services.loader - -## Table of contents - -### Functions - -- [overrideService](loaders_services_loader.md#overrideservice) -- [registerService](loaders_services_loader.md#registerservice) -- [servicesLoader](loaders_services_loader.md#servicesloader) - -## Functions - -### overrideService - -▸ **overrideService**(`container`, `serviceOptions`, `configModule`): `void` - -**`internal`** -Load custom service and override existing ones. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `container` | `AwilixContainer`<`any`\> | -| `serviceOptions` | [`GetInjectableOption`](types.md#getinjectableoption)<``"service"``\> | -| `configModule` | `Record`<`string`, `unknown`\> | - -#### Returns - -`void` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/services.loader.ts:55](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/services.loader.ts#L55) -======= -[src/loaders/services.loader.ts:55](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/services.loader.ts#L55) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/services.loader.ts:55](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/services.loader.ts#L55) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/services.loader.ts:55](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/services.loader.ts#L55) -======= -[src/loaders/services.loader.ts:55](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/services.loader.ts#L55) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/services.loader.ts:55](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/services.loader.ts#L55) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/services.loader.ts:55](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/services.loader.ts#L55) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### registerService - -▸ **registerService**(`container`, `serviceOptions`, `configModule`): `void` - -**`internal`** -Load custom service into the container. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `container` | `AwilixContainer`<`any`\> | -| `serviceOptions` | [`GetInjectableOption`](types.md#getinjectableoption)<``"service"``\> | -| `configModule` | `Record`<`string`, `unknown`\> | - -#### Returns - -`void` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/services.loader.ts:31](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/services.loader.ts#L31) -======= -[src/loaders/services.loader.ts:31](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/services.loader.ts#L31) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/services.loader.ts:31](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/services.loader.ts#L31) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/services.loader.ts:31](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/services.loader.ts#L31) -======= -[src/loaders/services.loader.ts:31](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/services.loader.ts#L31) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/services.loader.ts:31](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/services.loader.ts#L31) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/services.loader.ts:31](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/services.loader.ts#L31) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### servicesLoader - -▸ **servicesLoader**(`services`): `Promise`<`void`\> - -**`internal`** -Load custom services from the rootDir. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `services` | [`GetInjectableOptions`](types.md#getinjectableoptions)<``"service"``\> | Any custom service that implements MedusaService | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/loaders/services.loader.ts:9](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/loaders/services.loader.ts#L9) -======= -[src/loaders/services.loader.ts:9](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/loaders/services.loader.ts#L9) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/loaders/services.loader.ts:9](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/services.loader.ts#L9) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/loaders/services.loader.ts:9](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/loaders/services.loader.ts#L9) -======= -[src/loaders/services.loader.ts:9](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/loaders/services.loader.ts#L9) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/loaders/services.loader.ts:9](https://github.com/adrien2p/medusa-extender/blob/0490090/src/loaders/services.loader.ts#L9) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/loaders/services.loader.ts:9](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/services.loader.ts#L9) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/loaders_validators_loader.md b/docs/modules/loaders_validators_loader.md deleted file mode 100644 index f3574419..00000000 --- a/docs/modules/loaders_validators_loader.md +++ /dev/null @@ -1,29 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / loaders/validators.loader - -# Module: loaders/validators.loader - -## Table of contents - -### Functions - -- [validatorsLoader](loaders_validators_loader.md#validatorsloader) - -## Functions - -### validatorsLoader - -▸ **validatorsLoader**(`validatorsOptions`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `validatorsOptions` | [`GetInjectableOptions`](types.md#getinjectableoptions)<``"validator"``\> | - -#### Returns - -`Promise`<`void`\> - -#### Defined in - -[src/loaders/validators.loader.ts:4](https://github.com/adrien2p/medusa-extender/blob/e820602/src/loaders/validators.loader.ts#L4) diff --git a/docs/modules/metadata_reader.Internals.md b/docs/modules/metadata_reader.Internals.md deleted file mode 100644 index 9d229fd1..00000000 --- a/docs/modules/metadata_reader.Internals.md +++ /dev/null @@ -1,11 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / [metadata-reader](metadata_reader.md) / Internals - -# Namespace: Internals - -[metadata-reader](metadata_reader.md).Internals - -## Table of contents - -### Classes - -- [CustomMap](../classes/metadata_reader.Internals.CustomMap.md) diff --git a/docs/modules/metadata_reader.md b/docs/modules/metadata_reader.md deleted file mode 100644 index c6785d36..00000000 --- a/docs/modules/metadata_reader.md +++ /dev/null @@ -1,121 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / metadata-reader - -# Module: metadata-reader - -## Table of contents - -### Namespaces - -- [Internals](metadata_reader.Internals.md) - -### Functions - -- [componentsMetadataReader](metadata_reader.md#componentsmetadatareader) -- [metadataReader](metadata_reader.md#metadatareader) - -## Functions - -### componentsMetadataReader - -▸ **componentsMetadataReader**<`TComponentType`\>(`component`): [`InjectableOptions`](types.md#injectableoptions)<`TComponentType`\> & { `type`: [`InjectableComponentTypes`](types.md#injectablecomponenttypes) } - -**`internal`** -Return the options from components. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TComponentType` | `unknown` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `component` | [`Type`](../interfaces/types.Type.md)<`unknown`\> | - -#### Returns - -[`InjectableOptions`](types.md#injectableoptions)<`TComponentType`\> & { `type`: [`InjectableComponentTypes`](types.md#injectablecomponenttypes) } - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/metadata-reader.ts:36](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/metadata-reader.ts#L36) -======= -[src/metadata-reader.ts:36](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/metadata-reader.ts#L36) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/metadata-reader.ts:36](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/metadata-reader.ts#L36) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/metadata-reader.ts:36](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/metadata-reader.ts#L36) -======= -[src/metadata-reader.ts:36](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/metadata-reader.ts#L36) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/metadata-reader.ts:36](https://github.com/adrien2p/medusa-extender/blob/0490090/src/metadata-reader.ts#L36) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/metadata-reader.ts:36](https://github.com/adrien2p/medusa-extender/blob/e820602/src/metadata-reader.ts#L36) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### metadataReader - -▸ **metadataReader**(`modules`): [`CustomMap`](../classes/metadata_reader.Internals.CustomMap.md) - -Read all metadata from the imported modules and extract components that will be stored by there type. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `modules` | [`Type`](../interfaces/types.Type.md)<`unknown`\>[] | The modules from which the metadata are read. | - -#### Returns - -[`CustomMap`](../classes/metadata_reader.Internals.CustomMap.md) - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/metadata-reader.ts:14](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/metadata-reader.ts#L14) -======= -[src/metadata-reader.ts:14](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/metadata-reader.ts#L14) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/metadata-reader.ts:14](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/metadata-reader.ts#L14) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/metadata-reader.ts:14](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/metadata-reader.ts#L14) -======= -[src/metadata-reader.ts:14](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/metadata-reader.ts#L14) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/metadata-reader.ts:14](https://github.com/adrien2p/medusa-extender/blob/0490090/src/metadata-reader.ts#L14) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/metadata-reader.ts:14](https://github.com/adrien2p/medusa-extender/blob/e820602/src/metadata-reader.ts#L14) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/types.md b/docs/modules/types.md deleted file mode 100644 index dcb3b730..00000000 --- a/docs/modules/types.md +++ /dev/null @@ -1,831 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / types - -# Module: types - -## Table of contents - -### Interfaces - -- [MedusaMiddleware](../interfaces/types.MedusaMiddleware.md) -- [Type](../interfaces/types.Type.md) - -### Type aliases - -- [Constructor](types.md#constructor) -- [EntityInjectableOptions](types.md#entityinjectableoptions) -- [GetInjectableOption](types.md#getinjectableoption) -- [GetInjectableOptions](types.md#getinjectableoptions) -- [InjectableComponentTypes](types.md#injectablecomponenttypes) -- [InjectableOptions](types.md#injectableoptions) -- [MedusaAuthenticatedRequest](types.md#medusaauthenticatedrequest) -- [MedusaRequest](types.md#medusarequest) -- [MedusaRouteMethods](types.md#medusaroutemethods) -- [MedusaRouteOptions](types.md#medusarouteoptions) -- [MiddlewareInjectionOptions](types.md#middlewareinjectionoptions) -- [MixinReturnType](types.md#mixinreturntype) -- [RepositoryInjectableOptions](types.md#repositoryinjectableoptions) -- [RouterInjectionOptions](types.md#routerinjectionoptions) -- [RoutesInjectionRouterConfiguration](types.md#routesinjectionrouterconfiguration) -- [ServiceInjectableOptions](types.md#serviceinjectableoptions) -- [ValidatorInjectionOptions](types.md#validatorinjectionoptions) - -## Type aliases - -### Constructor - -Ƭ **Constructor**<`T`\>: (...`args`: `unknown`[]) => `T` - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Type declaration - -• (...`args`) - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `...args` | `unknown`[] | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:9](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L9) -======= -[src/types.ts:9](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L9) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:9](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L9) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:9](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L9) -======= -[src/types.ts:9](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L9) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:9](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L9) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:9](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L9) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### EntityInjectableOptions - -Ƭ **EntityInjectableOptions**<`TOverride`\>: `Object` - -Defines the injection options for entities. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TOverride` | `unknown` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `override?` | [`Type`](../interfaces/types.Type.md)<`TOverride`\> | -| `resolutionKey?` | `string` | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:26](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L26) -======= -[src/types.ts:19](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L19) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:19](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L19) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:19](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L19) -======= -[src/types.ts:19](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L19) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:19](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L19) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:26](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L26) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### GetInjectableOption - -Ƭ **GetInjectableOption**<`TComponentType`\>: `TComponentType` extends `Extract`<[`InjectableComponentTypes`](types.md#injectablecomponenttypes), ``"entity"``\> ? [`EntityInjectableOptions`](types.md#entityinjectableoptions) : `TComponentType` extends `Extract`<[`InjectableComponentTypes`](types.md#injectablecomponenttypes), ``"service"``\> ? [`ServiceInjectableOptions`](types.md#serviceinjectableoptions) : `TComponentType` extends `Extract`<[`InjectableComponentTypes`](types.md#injectablecomponenttypes), ``"repository"``\> ? [`RepositoryInjectableOptions`](types.md#repositoryinjectableoptions) : `TComponentType` extends `Extract`<[`InjectableComponentTypes`](types.md#injectablecomponenttypes), ``"migration"``\> ? { `metatype`: [`Type`](../interfaces/types.Type.md)<`MigrationInterface`\> } : `TComponentType` extends `Extract`<[`InjectableComponentTypes`](types.md#injectablecomponenttypes), ``"router"``\> ? [`RouterInjectionOptions`](types.md#routerinjectionoptions) : `TComponentType` extends `Extract`<[`InjectableComponentTypes`](types.md#injectablecomponenttypes), ``"middleware"``\> ? [`MiddlewareInjectionOptions`](types.md#middlewareinjectionoptions) : `TComponentType` extends `Extract`<[`InjectableComponentTypes`](types.md#injectablecomponenttypes), ``"validator"``\> ? [`ValidatorInjectionOptions`](types.md#validatorinjectionoptions) : `never` & { `metatype`: `TComponentType` extends ``"middleware"`` ? [`Type`](../interfaces/types.Type.md)<[`MedusaMiddleware`](../interfaces/types.MedusaMiddleware.md)\> : [`Type`](../interfaces/types.Type.md) ; `type`: [`InjectableComponentTypes`](types.md#injectablecomponenttypes) } - -Determine which options type it actually is depending on the component type. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TComponentType` | extends [`InjectableComponentTypes`](types.md#injectablecomponenttypes) = [`InjectableComponentTypes`](types.md#injectablecomponenttypes) | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:94](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L94) -======= -[src/types.ts:79](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L79) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:87](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L87) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:87](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L87) -======= -[src/types.ts:87](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L87) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:87](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L87) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:94](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L94) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### GetInjectableOptions - -Ƭ **GetInjectableOptions**<`TComponentType`\>: [`GetInjectableOption`](types.md#getinjectableoption)<`TComponentType`\>[] - -Determine which options type it actually is depending on the component type. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TComponentType` | extends [`InjectableComponentTypes`](types.md#injectablecomponenttypes) = [`InjectableComponentTypes`](types.md#injectablecomponenttypes) | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:117](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L117) -======= -[src/types.ts:100](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L100) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:110](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L110) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:110](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L110) -======= -[src/types.ts:110](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L110) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:110](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L110) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:117](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L117) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### InjectableComponentTypes - -Ƭ **InjectableComponentTypes**: ``"validator"`` \| ``"entity"`` \| ``"repository"`` \| ``"service"`` \| ``"migration"`` \| ``"router"`` \| ``"middleware"`` - -Components that does not required any other options that Type. - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:14](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L14) -======= -[src/types.ts:14](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L14) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:14](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L14) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:14](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L14) -======= -[src/types.ts:14](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L14) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:14](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L14) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:14](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L14) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### InjectableOptions - -Ƭ **InjectableOptions**<`T`\>: [`EntityInjectableOptions`](types.md#entityinjectableoptions)<`T`\> \| [`ServiceInjectableOptions`](types.md#serviceinjectableoptions)<`T`\> \| [`RepositoryInjectableOptions`](types.md#repositoryinjectableoptions)<`T`\> \| [`MiddlewareInjectionOptions`](types.md#middlewareinjectionoptions) \| [`RouterInjectionOptions`](types.md#routerinjectionoptions) \| [`ValidatorInjectionOptions`](types.md#validatorinjectionoptions)<`T`\> - -Union of all options type possible for injectable. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `unknown` | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:83](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L83) -======= -[src/types.ts:69](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L69) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:76](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L76) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:76](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L76) -======= -[src/types.ts:76](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L76) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:76](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L76) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:83](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L83) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### MedusaAuthenticatedRequest - -Ƭ **MedusaAuthenticatedRequest**: `Request` & [`MedusaRequest`](types.md#medusarequest) & { `session`: { `jwt`: `string` } ; `user?`: { `id?`: `string` ; `userId`: `string` } ; `userId`: `string` } - -Describe the expected request from a middleware [MedusaMiddleware](../interfaces/types.MedusaMiddleware.md). - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:130](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L130) -======= -[src/types.ts:113](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L113) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:123](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L123) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:123](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L123) -======= -[src/types.ts:123](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L123) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:123](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L123) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:130](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L130) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### MedusaRequest - -Ƭ **MedusaRequest**<`T`, `Cradle`\>: `Request` & { `scope`: `AwilixContainer`<`Cradle` & `T`\> } - -Medusa request extended. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | -| `Cradle` | extends `object` = `any` | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:123](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L123) -======= -[src/types.ts:106](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L106) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:116](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L116) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:116](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L116) -======= -[src/types.ts:116](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L116) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:116](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L116) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:123](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L123) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### MedusaRouteMethods - -Ƭ **MedusaRouteMethods**: ``"all"`` \| ``"get"`` \| ``"post"`` \| ``"put"`` \| ``"delete"`` \| ``"patch"`` \| ``"options"`` \| ``"head"`` - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:137](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L137) -======= -[src/types.ts:120](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L120) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:130](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L130) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:130](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L130) -======= -[src/types.ts:130](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L130) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:130](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L130) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:137](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L137) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### MedusaRouteOptions - -Ƭ **MedusaRouteOptions**: `Object` - -Describe all the available options for the Route [MedusaMiddleware](../interfaces/types.MedusaMiddleware.md). - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `method` | [`MedusaRouteMethods`](types.md#medusaroutemethods) | -| `path` | `string` | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:142](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L142) -======= -[src/types.ts:125](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L125) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:135](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L135) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:135](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L135) -======= -[src/types.ts:135](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L135) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:135](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L135) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:142](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L142) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### MiddlewareInjectionOptions - -Ƭ **MiddlewareInjectionOptions**: `Object` - -Defines the injection options for middlewares. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `requireAuth` | `boolean` | -| `routerOptions` | [`MedusaRouteOptions`](types.md#medusarouteoptions)[] | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:68](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L68) -======= -[src/types.ts:61](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L61) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:61](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L61) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:61](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L61) -======= -[src/types.ts:61](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L61) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:61](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L61) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:68](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L68) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### MixinReturnType - -Ƭ **MixinReturnType**<`T1`, `T2`\>: [`Constructor`](types.md#constructor)<`T1` & `T2`\> - -Mix the return type of two objects. - -#### Type parameters - -| Name | -| :------ | -| `T1` | -| `T2` | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:160](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L160) -======= -[src/types.ts:143](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L143) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:153](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L153) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:153](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L153) -======= -[src/types.ts:153](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L153) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:153](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L153) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:160](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L160) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### RepositoryInjectableOptions - -Ƭ **RepositoryInjectableOptions**<`TOverride`\>: `Object` - -Defines the injection options for services, entities, repositories. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TOverride` | `unknown` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `override?` | [`Type`](../interfaces/types.Type.md)<`TOverride`\> | -| `resolutionKey?` | `string` | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:43](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L43) -======= -[src/types.ts:36](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L36) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:36](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L36) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:36](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L36) -======= -[src/types.ts:36](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L36) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:36](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L36) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:43](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L43) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### RouterInjectionOptions - -Ƭ **RouterInjectionOptions**: `Object` - -Defines the injection options for routes. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `router` | [`RoutesInjectionRouterConfiguration`](types.md#routesinjectionrouterconfiguration)[] | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:61](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L61) -======= -[src/types.ts:54](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L54) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:54](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L54) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:54](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L54) -======= -[src/types.ts:54](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L54) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:54](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L54) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:61](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L61) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### RoutesInjectionRouterConfiguration - -Ƭ **RoutesInjectionRouterConfiguration**: `Object` - -Define a router and its configuration. - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `method` | `string` | -| `path` | `string` | -| `requiredAuth` | `boolean` | -| `handler` | (...`args`: `unknown`[]) => `void` | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:51](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L51) -======= -[src/types.ts:44](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L44) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:44](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L44) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:44](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L44) -======= -[src/types.ts:44](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L44) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:44](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L44) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:51](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L51) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### ServiceInjectableOptions - -Ƭ **ServiceInjectableOptions**<`TOverride`\>: `Object` - -Defines the injection options for service. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TOverride` | `unknown` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `override?` | [`Type`](../interfaces/types.Type.md)<`TOverride`\> | -| `resolutionKey?` | `string` | -| `scope?` | `LifetimeType` | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:34](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L34) -======= -[src/types.ts:27](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L27) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:27](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L27) -======= -[src/types.ts:27](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L27) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:27](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L27) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:34](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L34) ->>>>>>> 4c3e573... Feat() Update doc - -___ - -### ValidatorInjectionOptions - -Ƭ **ValidatorInjectionOptions**<`TOverride`\>: `Object` - -Defines the injection options for routes. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `TOverride` | `unknown` | - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `override?` | [`Type`](../interfaces/types.Type.md)<`TOverride`\> | - -#### Defined in - -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -<<<<<<< HEAD -[src/types.ts:76](https://github.com/adrien2p/medusa-extender/blob/7e89c01/src/types.ts#L76) -======= -[src/types.ts:27](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L27) ->>>>>>> 26ad56d... Feat() Update README decorators section -======= -[src/types.ts:69](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L69) ->>>>>>> b652414... Feat() Add support to extends validator -======= -======= ->>>>>>> d802ff5... [BOT] BUILD DOC -[src/types.ts:69](https://github.com/adrien2p/medusa-extender/blob/834fee1/src/types.ts#L69) -======= -[src/types.ts:69](https://github.com/adrien2p/medusa-extender/blob/23cd201/src/types.ts#L69) ->>>>>>> 366e7bd... [BOT] BUILD DOC -<<<<<<< HEAD ->>>>>>> 4c2e6c1... [BOT] BUILD DOC -======= -======= -[src/types.ts:69](https://github.com/adrien2p/medusa-extender/blob/0490090/src/types.ts#L69) ->>>>>>> 1f752f6... [BOT] BUILD DOC ->>>>>>> d802ff5... [BOT] BUILD DOC -======= -[src/types.ts:76](https://github.com/adrien2p/medusa-extender/blob/e820602/src/types.ts#L76) ->>>>>>> 4c3e573... Feat() Update doc diff --git a/docs/modules/utils.md b/docs/modules/utils.md deleted file mode 100644 index 660c8810..00000000 --- a/docs/modules/utils.md +++ /dev/null @@ -1,9 +0,0 @@ -[medusa-extender](../README.md) / [Exports](../modules.md) / utils - -# Module: utils - -## Table of contents - -### Classes - -- [Utils](../classes/utils.Utils.md)