Skip to content

Commit

Permalink
Feat() Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@adrien2p
adrien2p committed Jan 27, 2022
1 parent 15c1462 commit ca112d2
Show file tree
Hide file tree
Showing 29 changed files with 102 additions and 88 deletions.
8 changes: 4 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ We will then create a new repository to reflect our custom entity.
import { ProductRepository as MedusaProductRepository } from '@medusa/medusa/dist/repositories/product';
import { EntityRepository, Repository } from "typeorm";
import { Injectable, Utils } from "medusa-extender";
import { Product } from "../entities/product.entity";
import { Product } from "./product.entity";
//...

@Injectable({ type: 'repository', override: MedusaProductRepository })
Expand Down Expand Up @@ -186,9 +186,9 @@ And to wrap everything properly here is the module.
// modules/products/myModule.module.ts

import { Module } from 'medusa-extender';
import { Product } from './entities/product.entity';
import ProductRepository from './repositories/product.repository';
import ProductService from './services/product.service';
import { Product } from './product.entity';
import ProductRepository from './product.repository';
import ProductService from './product.service';

@Module({
imports: [
Expand Down
8 changes: 4 additions & 4 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ We will then create a new repository to reflect our custom entity.
import { ProductRepository as MedusaProductRepository } from '@medusa/medusa/dist/repositories/product';
import { EntityRepository, Repository } from "typeorm";
import { Injectable, Utils } from "medusa-extender";
import { Product } from "../entities/product.entity";
import { Product } from "./product.entity";
//...

@Injectable({ type: 'repository', override: MedusaProductRepository })
Expand Down Expand Up @@ -188,9 +188,9 @@ And to wrap everything properly here is the module.
// modules/products/myModule.module.ts

import { Module } from 'medusa-extender';
import { Product } from './entities/product.entity';
import ProductRepository from './repositories/product.repository';
import ProductService from './services/product.service';
import { Product } from './product.entity';
import ProductRepository from './product.repository';
import ProductService from './product.service';

@Module({
imports: [
Expand Down
26 changes: 13 additions & 13 deletions docs/classes/decorators_onMedusaEvent_decorator.OnMedusaEvent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:41](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L41)
[src/decorators/onMedusaEvent.decorator.ts:41](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L41)

## Properties

Expand All @@ -55,7 +55,7 @@

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L39)
[src/decorators/onMedusaEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L39)

___

Expand All @@ -65,7 +65,7 @@ ___

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:38](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L38)
[src/decorators/onMedusaEvent.decorator.ts:38](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L38)

## Accessors

Expand All @@ -79,7 +79,7 @@ ___

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:49](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L49)
[src/decorators/onMedusaEvent.decorator.ts:49](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L49)

___

Expand All @@ -93,7 +93,7 @@ ___

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:45](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L45)
[src/decorators/onMedusaEvent.decorator.ts:45](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L45)

## Methods

Expand All @@ -120,7 +120,7 @@ ___

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:69](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L69)
[src/decorators/onMedusaEvent.decorator.ts:69](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L69)

___

Expand All @@ -146,7 +146,7 @@ ___

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:57](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L57)
[src/decorators/onMedusaEvent.decorator.ts:57](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L57)

___

Expand All @@ -173,7 +173,7 @@ ___

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:83](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L83)
[src/decorators/onMedusaEvent.decorator.ts:83](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L83)

___

Expand All @@ -199,7 +199,7 @@ ___

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:65](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L65)
[src/decorators/onMedusaEvent.decorator.ts:65](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L65)

___

Expand All @@ -226,7 +226,7 @@ ___

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:76](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L76)
[src/decorators/onMedusaEvent.decorator.ts:76](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L76)

___

Expand All @@ -252,7 +252,7 @@ ___

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:61](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L61)
[src/decorators/onMedusaEvent.decorator.ts:61](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L61)

___

Expand Down Expand Up @@ -280,7 +280,7 @@ ___

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:90](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L90)
[src/decorators/onMedusaEvent.decorator.ts:90](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L90)

___

Expand All @@ -300,4 +300,4 @@ ___

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:53](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L53)
[src/decorators/onMedusaEvent.decorator.ts:53](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L53)
12 changes: 6 additions & 6 deletions docs/classes/event_emmiter.Internals.CustomEventEmmiter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ EventEmitter.constructor

#### Defined in

[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/event-emmiter.ts#L21)
[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/event-emmiter.ts#L21)

## Properties

Expand All @@ -51,7 +51,7 @@ EventEmitter.constructor

#### Defined in

[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/event-emmiter.ts#L19)
[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/event-emmiter.ts#L19)

## Methods

Expand All @@ -74,7 +74,7 @@ Emit an asynchrone event entity based and wait for the result.

#### Defined in

[src/event-emmiter.ts:81](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/event-emmiter.ts#L81)
[src/event-emmiter.ts:81](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/event-emmiter.ts#L81)

___

Expand Down Expand Up @@ -104,7 +104,7 @@ Register a new event handler.

#### Defined in

[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/event-emmiter.ts#L31)
[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/event-emmiter.ts#L31)

___

Expand All @@ -126,7 +126,7 @@ Apply all event handlers hold by the `listenerDescriptor`.

#### Defined in

[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/event-emmiter.ts#L43)
[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/event-emmiter.ts#L43)

___

Expand All @@ -140,4 +140,4 @@ ___

#### Defined in

[src/event-emmiter.ts:69](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/event-emmiter.ts#L69)
[src/event-emmiter.ts:69](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/event-emmiter.ts#L69)
2 changes: 1 addition & 1 deletion docs/classes/loader.Loader.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ internal container and database connection.

#### Defined in

[src/loader.ts:35](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/loader.ts#L35)
[src/loader.ts:35](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/loader.ts#L35)
8 changes: 4 additions & 4 deletions docs/classes/medusa.Medusa.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Register steps that must be executed before/after medusa is load.

#### Defined in

[src/medusa.ts:15](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/medusa.ts#L15)
[src/medusa.ts:15](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/medusa.ts#L15)

## Properties

Expand All @@ -46,7 +46,7 @@ Register steps that must be executed before/after medusa is load.

#### Defined in

[src/medusa.ts:8](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/medusa.ts#L8)
[src/medusa.ts:8](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/medusa.ts#L8)

___

Expand All @@ -56,7 +56,7 @@ ___

#### Defined in

[src/medusa.ts:9](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/medusa.ts#L9)
[src/medusa.ts:9](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/medusa.ts#L9)

## Methods

Expand All @@ -78,4 +78,4 @@ Launch all the steps before/after medusa according to the `stepOptions`.

#### Defined in

[src/medusa.ts:23](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/medusa.ts#L23)
[src/medusa.ts:23](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/medusa.ts#L23)
2 changes: 1 addition & 1 deletion docs/classes/modules_metadata_reader.Internals.CustomMap.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ Map.get

#### Defined in

[src/modules-metadata-reader.ts:6](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/modules-metadata-reader.ts#L6)
[src/modules-metadata-reader.ts:6](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/modules-metadata-reader.ts#L6)
12 changes: 6 additions & 6 deletions docs/classes/utils.Utils.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Attach a new subscriber to a specific entities.

#### Defined in

[src/utils.ts:40](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/utils.ts#L40)
[src/utils.ts:40](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/utils.ts#L40)

___

Expand All @@ -78,7 +78,7 @@ Log all the routes from the express instance.

#### Defined in

[src/utils.ts:61](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/utils.ts#L61)
[src/utils.ts:61](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/utils.ts#L61)

___

Expand All @@ -101,7 +101,7 @@ Prepare the log to be shown to be consistent everywhere.

#### Defined in

[src/utils.ts:70](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/utils.ts#L70)
[src/utils.ts:70](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/utils.ts#L70)

___

Expand All @@ -122,7 +122,7 @@ ___

#### Defined in

[src/utils.ts:81](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/utils.ts#L81)
[src/utils.ts:81](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/utils.ts#L81)

___

Expand Down Expand Up @@ -153,7 +153,7 @@ Since it is not possible to use multiple extend, you can use that utilities to a

#### Defined in

[src/utils.ts:17](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/utils.ts#L17)
[src/utils.ts:17](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/utils.ts#L17)

___

Expand All @@ -173,4 +173,4 @@ ___

#### Defined in

[src/utils.ts:101](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/utils.ts#L101)
[src/utils.ts:101](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/utils.ts#L101)
2 changes: 1 addition & 1 deletion docs/interfaces/types.MedusaMiddleware.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ Describe a custom middleware instance.

#### Defined in

[src/types.ts:126](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/types.ts#L126)
[src/types.ts:126](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/types.ts#L126)
2 changes: 1 addition & 1 deletion docs/interfaces/types.Type.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ Function.constructor

#### Defined in

[src/types.ts:5](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/types.ts#L5)
[src/types.ts:5](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/types.ts#L5)
Binary file modified docs/media/medusa-extender.jpeg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/modules/contants.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Metadata key to store config from decorated injectables.

#### Defined in

[src/contants.ts:9](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/contants.ts#L9)
[src/contants.ts:9](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/contants.ts#L9)

___

Expand Down Expand Up @@ -66,7 +66,7 @@ Hold the name of the medusa services registered into the container for later on

#### Defined in

[src/contants.ts:14](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/contants.ts#L14)
[src/contants.ts:14](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/contants.ts#L14)

___

Expand All @@ -78,4 +78,4 @@ Metadata key to store config from decorated injectables.

#### Defined in

[src/contants.ts:4](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/contants.ts#L4)
[src/contants.ts:4](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/contants.ts#L4)
2 changes: 1 addition & 1 deletion docs/modules/decorators_injectable_decorator.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ Mark a class as an injectable to be used by the loader.

#### Defined in

[src/decorators/injectable.decorator.ts:10](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/injectable.decorator.ts#L10)
[src/decorators/injectable.decorator.ts:10](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/injectable.decorator.ts#L10)
2 changes: 1 addition & 1 deletion docs/modules/decorators_module_decorator.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ Mark a class as aa module and store all injectable on it.

#### Defined in

[src/decorators/module.decorator.ts:10](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/module.decorator.ts#L10)
[src/decorators/module.decorator.ts:10](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/module.decorator.ts#L10)
10 changes: 5 additions & 5 deletions docs/modules/decorators_onMedusaEvent_decorator.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:10](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L10)
[src/decorators/onMedusaEvent.decorator.ts:10](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L10)

___

Expand All @@ -47,7 +47,7 @@ ___

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:5](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L5)
[src/decorators/onMedusaEvent.decorator.ts:5](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L5)

___

Expand All @@ -66,7 +66,7 @@ Event types that can be emitted.

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:15](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L15)
[src/decorators/onMedusaEvent.decorator.ts:15](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L15)

___

Expand All @@ -92,7 +92,7 @@ The arguments expected by the [OnMedusaEvent](../classes/decorators_onMedusaEven

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:24](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L24)
[src/decorators/onMedusaEvent.decorator.ts:24](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L24)

___

Expand All @@ -118,4 +118,4 @@ The arguments expected by the event handler.

#### Defined in

[src/decorators/onMedusaEvent.decorator.ts:32](https://github.com/adrien2p/medusa-extender/blob/bedfabe/src/decorators/onMedusaEvent.decorator.ts#L32)
[src/decorators/onMedusaEvent.decorator.ts:32](https://github.com/adrien2p/medusa-extender/blob/15c1462/src/decorators/onMedusaEvent.decorator.ts#L32)
Loading

0 comments on commit ca112d2

Please sign in to comment.