Skip to content

Commit

Permalink
feat: Update README decorators section
Browse files Browse the repository at this point in the history
feat: Update doc
  • Loading branch information
adrien2p committed Feb 9, 2022
1 parent 11ea970 commit bbc3786
Show file tree
Hide file tree
Showing 28 changed files with 245 additions and 82 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,8 @@ Here is the list of the provided decorators.
| `@Service(/*...*/)` | Decorate a service | `{ scope?: LifetimeType; resolutionKey?: string; override?: Type<TOverride>; };`
| `@Middleware(/*...*/)` | Decorate a middleware | `{ requireAuth: boolean; string; routerOptions: MedusaRouteOptions[]; };`
| `@Router(/*...*/)` | Decorate a router | `{ router: RoutesInjectionRouterConfiguration[]; };`
| `@Migration(/*...*/)` | Decorate a migration |
| `@Migration(/*...*/)` | Decorate a migration |
| `@Validator(/*...*/)` | Decorate a validator | `{ override: Type<TOverride>; };`
| `@OnMedusaEntityEvent.\*.\*(/*...*/)`| Can be used to send the right event type or register handler to an event |


Expand Down
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,8 @@ Here is the list of the provided decorators.
| `@Service(/*...*/)` | Decorate a service | `{ scope?: LifetimeType; resolutionKey?: string; override?: Type<TOverride>; };`
| `@Middleware(/*...*/)` | Decorate a middleware | `{ requireAuth: boolean; string; routerOptions: MedusaRouteOptions[]; };`
| `@Router(/*...*/)` | Decorate a router | `{ router: RoutesInjectionRouterConfiguration[]; };`
| `@Migration(/*...*/)` | Decorate a migration |
| `@Migration(/*...*/)` | Decorate a migration |
| `@Validator(/*...*/)` | Decorate a validator | `{ override: Type<TOverride>; };`
| `@OnMedusaEntityEvent.\*.\*(/*...*/)`| Can be used to send the right event type or register handler to an event |

## Entity event handling
Expand Down
80 changes: 80 additions & 0 deletions docs/classes/Medusa.Medusa-1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
[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

[src/Medusa.ts:36](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/Medusa.ts#L36)

## Properties

### #express

`Private` `Readonly` **#express**: `Express`

#### Defined in

[src/Medusa.ts:29](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/Medusa.ts#L29)

___

### #rootDir

`Private` `Readonly` **#rootDir**: `string`

#### Defined in

[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/Medusa.ts#L30)

## Methods

### load

**load**(`modules`): `Promise`<`AwilixContainer`<`any`\>\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `modules` | [`Constructor`](../modules/types.md#constructor)<`unknown`\>[] |

#### Returns

`Promise`<`AwilixContainer`<`any`\>\>

#### Defined in

[src/Medusa.ts:44](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/Medusa.ts#L44)
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/c048da3/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)

## Properties

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/c048da3/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)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/c048da3/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)

## Accessors

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/c048da3/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)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/c048da3/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)

## Methods

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/c048da3/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)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/c048da3/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)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/c048da3/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)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/c048da3/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)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/c048da3/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)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/c048da3/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)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/c048da3/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)

___

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

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/c048da3/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)
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/c048da3/src/event-emmiter.ts#L21)
[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/89f7223/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/c048da3/src/event-emmiter.ts#L19)
[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/89f7223/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/c048da3/src/event-emmiter.ts#L80)
[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/89f7223/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/c048da3/src/event-emmiter.ts#L31)
[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/89f7223/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/c048da3/src/event-emmiter.ts#L43)
[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/89f7223/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/c048da3/src/event-emmiter.ts#L68)
[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/89f7223/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/c048da3/src/metadata-reader.ts#L5)
[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/89f7223/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:38](https://github.com/adrien2p/medusa-extender/blob/c048da3/src/utils.ts#L38)
[src/utils.ts:38](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/utils.ts#L38)

___

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

#### Defined in

[src/utils.ts:69](https://github.com/adrien2p/medusa-extender/blob/c048da3/src/utils.ts#L69)
[src/utils.ts:69](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/utils.ts#L69)

___

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

#### Defined in

[src/utils.ts:59](https://github.com/adrien2p/medusa-extender/blob/c048da3/src/utils.ts#L59)
[src/utils.ts:59](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/utils.ts#L59)

___

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

#### Defined in

[src/utils.ts:83](https://github.com/adrien2p/medusa-extender/blob/c048da3/src/utils.ts#L83)
[src/utils.ts:83](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/utils.ts#L83)

___

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:16](https://github.com/adrien2p/medusa-extender/blob/c048da3/src/utils.ts#L16)
[src/utils.ts:16](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/utils.ts#L16)

___

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

#### Defined in

[src/utils.ts:103](https://github.com/adrien2p/medusa-extender/blob/c048da3/src/utils.ts#L103)
[src/utils.ts:103](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/utils.ts#L103)
2 changes: 1 addition & 1 deletion docs/interfaces/types.MedusaMiddleware.md
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:135](https://github.com/adrien2p/medusa-extender/blob/c048da3/src/types.ts#L135)
[src/types.ts:135](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L135)
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/c048da3/src/types.ts#L6)
[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/89f7223/src/types.ts#L6)
Loading

0 comments on commit bbc3786

Please sign in to comment.