Skip to content

Commit

Permalink
docs: Re-build docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adrien2p committed Feb 14, 2022
1 parent 16c7f70 commit ad977cf
Show file tree
Hide file tree
Showing 28 changed files with 96 additions and 91 deletions.
5 changes: 5 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ medusa-extender / [Exports](modules.md)
- [Full documentation including API](https://adrien2p.github.io/medusa-extender/#/)
- [Code base overview](#code-base-overview)
- [Features](#features)
- [Demo: Products scoped per store (Marketplace)](#demo-products-scoped-per-store-marketplace)
- 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)
Expand Down Expand Up @@ -131,6 +132,10 @@ npm i medusa-extender

> Build a module, export it and share it with the community.
# Demo: Products scoped per store (Marketplace)

[![Video demo: scoped products per store](https://github.com/adrien2p/medusa-extender/blob/assets/assets/readme/store_scoped_demo_thumbnail.png?raw=true)](https://streamable.com/e/oel4vl)

# Usage

For the purpose of the examples that will follow in the next sections,
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/Medusa.Medusa-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ internal container and database connection.

#### Defined in

[src/Medusa.ts:37](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/Medusa.ts#L37)
[src/Medusa.ts:37](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/Medusa.ts#L37)

## Properties

Expand All @@ -47,7 +47,7 @@ internal container and database connection.

#### Defined in

[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/Medusa.ts#L30)
[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/Medusa.ts#L30)

___

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

#### Defined in

[src/Medusa.ts:31](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/Medusa.ts#L31)
[src/Medusa.ts:31](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/Medusa.ts#L31)

## Methods

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

#### Defined in

[src/Medusa.ts:45](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/Medusa.ts#L45)
[src/Medusa.ts:45](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/Medusa.ts#L45)
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/onMedusaEntityEvent.decorator.ts#L42)
[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L42)

## Properties

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/onMedusaEntityEvent.decorator.ts#L40)
[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L40)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/onMedusaEntityEvent.decorator.ts#L39)
[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L39)

## Accessors

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/onMedusaEntityEvent.decorator.ts#L50)
[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L50)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/onMedusaEntityEvent.decorator.ts#L46)
[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L46)

## Methods

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/onMedusaEntityEvent.decorator.ts#L70)
[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L70)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/onMedusaEntityEvent.decorator.ts#L58)
[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L58)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/onMedusaEntityEvent.decorator.ts#L84)
[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L84)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/onMedusaEntityEvent.decorator.ts#L66)
[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L66)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/onMedusaEntityEvent.decorator.ts#L77)
[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L77)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/onMedusaEntityEvent.decorator.ts#L62)
[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L62)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/onMedusaEntityEvent.decorator.ts#L91)
[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L91)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/onMedusaEntityEvent.decorator.ts#L54)
[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/onMedusaEntityEvent.decorator.ts#L54)
12 changes: 6 additions & 6 deletions docs/classes/event_emmiter.Internals.CustomEventEmmiter.md
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/2e5723a/src/event-emmiter.ts#L21)
[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/16c7f70/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/2e5723a/src/event-emmiter.ts#L19)
[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/event-emmiter.ts#L19)

## Methods

Expand Down Expand Up @@ -80,7 +80,7 @@ Emit an asynchrone event entity based and wait for the result.

#### Defined in

[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/event-emmiter.ts#L80)
[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/event-emmiter.ts#L80)

___

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

#### Defined in

[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/event-emmiter.ts#L31)
[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/event-emmiter.ts#L31)

___

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

#### Defined in

[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/event-emmiter.ts#L43)
[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/event-emmiter.ts#L43)

___

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

#### Defined in

[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/event-emmiter.ts#L68)
[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/event-emmiter.ts#L68)
2 changes: 1 addition & 1 deletion docs/classes/metadata_reader.Internals.CustomMap.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ Map.get

#### Defined in

[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/metadata-reader.ts#L5)
[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/metadata-reader.ts#L5)
12 changes: 6 additions & 6 deletions docs/classes/utils.Utils.md
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:37](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/utils.ts#L37)
[src/utils.ts:37](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/utils.ts#L37)

___

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

#### Defined in

[src/utils.ts:68](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/utils.ts#L68)
[src/utils.ts:68](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/utils.ts#L68)

___

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

#### Defined in

[src/utils.ts:58](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/utils.ts#L58)
[src/utils.ts:58](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/utils.ts#L58)

___

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

#### Defined in

[src/utils.ts:82](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/utils.ts#L82)
[src/utils.ts:82](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/utils.ts#L82)

___

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/2e5723a/src/utils.ts#L17)
[src/utils.ts:17](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/utils.ts#L17)

___

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

#### Defined in

[src/utils.ts:102](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/utils.ts#L102)
[src/utils.ts:102](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/utils.ts#L102)
2 changes: 1 addition & 1 deletion docs/interfaces/types.MedusaMiddleware.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ Describe a custom middleware instance.

#### Defined in

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

#### Defined in

[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/types.ts#L6)
[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/types.ts#L6)
6 changes: 3 additions & 3 deletions docs/modules/constants.md
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/constants.ts:9](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/constants.ts#L9)
[src/constants.ts:9](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/constants.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/constants.ts:14](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/constants.ts#L14)
[src/constants.ts:14](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/constants.ts#L14)

___

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

#### Defined in

[src/constants.ts:4](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/constants.ts#L4)
[src/constants.ts:4](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/constants.ts#L4)
14 changes: 7 additions & 7 deletions docs/modules/decorators_components_decorator.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Mark a class as an entity to be used by the loader.

#### Defined in

[src/decorators/components.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/components.decorator.ts#L16)
[src/decorators/components.decorator.ts:16](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/components.decorator.ts#L16)

___

Expand All @@ -62,7 +62,7 @@ Mark a class as a middleware to be used by the loader.

#### Defined in

[src/decorators/components.decorator.ts:43](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/components.decorator.ts#L43)
[src/decorators/components.decorator.ts:43](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/components.decorator.ts#L43)

___

Expand All @@ -78,7 +78,7 @@ Mark a class as a migration to be used by the loader.

#### Defined in

[src/decorators/components.decorator.ts:51](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/components.decorator.ts#L51)
[src/decorators/components.decorator.ts:51](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/components.decorator.ts#L51)

___

Expand Down Expand Up @@ -106,7 +106,7 @@ Mark a class as a repository to be used by the loader.

#### Defined in

[src/decorators/components.decorator.ts:34](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/components.decorator.ts#L34)
[src/decorators/components.decorator.ts:34](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/components.decorator.ts#L34)

___

Expand All @@ -128,7 +128,7 @@ Mark a class as a router to be used by the loader.

#### Defined in

[src/decorators/components.decorator.ts:60](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/components.decorator.ts#L60)
[src/decorators/components.decorator.ts:60](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/components.decorator.ts#L60)

___

Expand Down Expand Up @@ -156,7 +156,7 @@ Mark a class as a service to be used by the loader.

#### Defined in

[src/decorators/components.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/components.decorator.ts#L25)
[src/decorators/components.decorator.ts:25](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/components.decorator.ts#L25)

___

Expand All @@ -178,4 +178,4 @@ Mark a class as a validator to be used by the validator utility.

#### Defined in

[src/decorators/components.decorator.ts:69](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/components.decorator.ts#L69)
[src/decorators/components.decorator.ts:69](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/components.decorator.ts#L69)
2 changes: 1 addition & 1 deletion docs/modules/decorators_module_decorator.md
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:9](https://github.com/adrien2p/medusa-extender/blob/2e5723a/src/decorators/module.decorator.ts#L9)
[src/decorators/module.decorator.ts:9](https://github.com/adrien2p/medusa-extender/blob/16c7f70/src/decorators/module.decorator.ts#L9)
Loading

0 comments on commit ad977cf

Please sign in to comment.