Skip to content

Commit

Permalink
docs: Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@adrien2p
adrien2p committed Feb 23, 2022
1 parent 737355b commit 82c8d53
Show file tree
Hide file tree
Showing 30 changed files with 122 additions and 119 deletions.
23 changes: 13 additions & 10 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,9 @@ export default class ProductService extends MedusaProductService {
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 a request scoped subscribers.

Every middleware decorated with the `@Middleware` decorator will be applied globally on the specified route
before/after medusa authentication. Otherwise, to apply a middleware directly to a route you can have a look to the `@Router` decorator.

<details>
<summary>Click to see the example!</summary>

Expand Down Expand Up @@ -596,16 +599,16 @@ npm run start

Here is the list of the provided decorators.

| Decorator | Description | Option |
| ---------------------- | ---------------------- | ----------------------
| `@Entity(/*...*/)` | Decorate an entity | `{ resolutionKey?: string; override?: Type<TOverride>; };`
| `@Repository(/*...*/)` | Decorate a repository | `{ resolutionKey?: string; override?: Type<TOverride>; };`
| `@Service(/*...*/)` | Decorate a service | `{ scope?: LifetimeType; resolutionKey?: string; override?: Type<TOverride>; };`
| `@Middleware(/*...*/)` | Decorate a middleware | `{ requireAuth: boolean; string; routes: MedusaRouteOptions[]; };`
| `@Router(/*...*/)` | Decorate a router | `{ router: RoutesInjectionRouterConfiguration[]; };`
| `@Validator(/*...*/)` | Decorate a validator | `{ override: Type<TOverride>; };`
| `@Migration(/*...*/)` | Decorate a migration |
| `@OnMedusaEntityEvent.\*.\*(/*...*/)`| Can be used to send the right event type or register the handler to an event| `(entity: TEntity, { async? boolean; metatype?: Type<unknown> })`
| Decorator | Description | Option |
| ---------------------- | ---------------------- | ----------------------
| `@Entity(/*...*/)` | Decorate an entity | `{ resolutionKey?: string; override?: Type<TOverride>; };`
| `@Repository(/*...*/)` | Decorate a repository | `{ resolutionKey?: string; override?: Type<TOverride>; };`
| `@Service(/*...*/)` | Decorate a service | `{ scope?: LifetimeType; resolutionKey?: string; override?: Type<TOverride>; };`
| `@Middleware(/*...*/)` | Decorate a middleware | `{ requireAuth: boolean; string; routes: MedusaRouteOptions[]; };`
| `@Router(/*...*/)` | Decorate a router, can provide a list of handlers that can include route related middleware| `{ router: RoutesInjectionRouterConfiguration[]; };`
| `@Validator(/*...*/)` | Decorate a validator | `{ override: Type<TOverride>; };`
| `@Migration(/*...*/)` | Decorate a migration |
| `@OnMedusaEntityEvent.\*.\*(/*...*/)`| Can be used to send the right event type or register the handler to an event | `(entity: TEntity, { async? boolean; metatype?: Type<unknown> })`

# Monitoring

Expand Down
10 changes: 5 additions & 5 deletions docs/classes/Medusa.Medusa-1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Load medusa and apply all components

#### Defined in

[src/Medusa.ts:38](https://github.com/adrien2p/medusa-extender/blob/b811430/src/Medusa.ts#L38)
[src/Medusa.ts:38](https://github.com/adrien2p/medusa-extender/blob/737355b/src/Medusa.ts#L38)

## Properties

Expand All @@ -47,7 +47,7 @@ Load medusa and apply all components

#### Defined in

[src/Medusa.ts:31](https://github.com/adrien2p/medusa-extender/blob/b811430/src/Medusa.ts#L31)
[src/Medusa.ts:31](https://github.com/adrien2p/medusa-extender/blob/737355b/src/Medusa.ts#L31)

___

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

#### Defined in

[src/Medusa.ts:32](https://github.com/adrien2p/medusa-extender/blob/b811430/src/Medusa.ts#L32)
[src/Medusa.ts:32](https://github.com/adrien2p/medusa-extender/blob/737355b/src/Medusa.ts#L32)

## Methods

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

#### Defined in

[src/Medusa.ts:46](https://github.com/adrien2p/medusa-extender/blob/b811430/src/Medusa.ts#L46)
[src/Medusa.ts:46](https://github.com/adrien2p/medusa-extender/blob/737355b/src/Medusa.ts#L46)

___

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

#### Defined in

[src/Medusa.ts:76](https://github.com/adrien2p/medusa-extender/blob/b811430/src/Medusa.ts#L76)
[src/Medusa.ts:76](https://github.com/adrien2p/medusa-extender/blob/737355b/src/Medusa.ts#L76)
26 changes: 13 additions & 13 deletions docs/classes/decorators_onMedusaEntityEvent_decorator.OnMedusaEntityEvent.md
View file
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/b811430/src/decorators/onMedusaEntityEvent.decorator.ts#L42)
[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/decorators/onMedusaEntityEvent.decorator.ts#L40)
[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/decorators/onMedusaEntityEvent.decorator.ts#L39)
[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/decorators/onMedusaEntityEvent.decorator.ts#L50)
[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/decorators/onMedusaEntityEvent.decorator.ts#L46)
[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/decorators/onMedusaEntityEvent.decorator.ts#L70)
[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/decorators/onMedusaEntityEvent.decorator.ts#L58)
[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/decorators/onMedusaEntityEvent.decorator.ts#L84)
[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/decorators/onMedusaEntityEvent.decorator.ts#L66)
[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/decorators/onMedusaEntityEvent.decorator.ts#L77)
[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/decorators/onMedusaEntityEvent.decorator.ts#L62)
[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/decorators/onMedusaEntityEvent.decorator.ts#L91)
[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/decorators/onMedusaEntityEvent.decorator.ts#L54)
[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/737355b/src/decorators/onMedusaEntityEvent.decorator.ts#L54)
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/b811430/src/event-emmiter.ts#L21)
[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/event-emmiter.ts#L19)
[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/event-emmiter.ts#L80)
[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/event-emmiter.ts#L31)
[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/event-emmiter.ts#L43)
[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/event-emmiter.ts#L68)
[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/737355b/src/event-emmiter.ts#L68)
2 changes: 1 addition & 1 deletion docs/classes/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/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/b811430/src/metadata-reader.ts#L5)
[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/737355b/src/metadata-reader.ts#L5)
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:37](https://github.com/adrien2p/medusa-extender/blob/b811430/src/utils.ts#L37)
[src/utils.ts:37](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/utils.ts#L68)
[src/utils.ts:68](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/utils.ts#L58)
[src/utils.ts:58](https://github.com/adrien2p/medusa-extender/blob/737355b/src/utils.ts#L58)

___

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

#### Defined in

[src/utils.ts:82](https://github.com/adrien2p/medusa-extender/blob/b811430/src/utils.ts#L82)
[src/utils.ts:82](https://github.com/adrien2p/medusa-extender/blob/737355b/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/b811430/src/utils.ts#L17)
[src/utils.ts:17](https://github.com/adrien2p/medusa-extender/blob/737355b/src/utils.ts#L17)

___

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

#### Defined in

[src/utils.ts:102](https://github.com/adrien2p/medusa-extender/blob/b811430/src/utils.ts#L102)
[src/utils.ts:102](https://github.com/adrien2p/medusa-extender/blob/737355b/src/utils.ts#L102)
Loading

0 comments on commit 82c8d53

Please sign in to comment.