Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fix documentations wrong API #32

Merged
merged 1 commit into from
Feb 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ import {
} from 'medusa-extender';
import UserSubscriber from './product.subscriber';

@Middleware({ requireAuth: true, routerOptions: [{ method: 'post', path: '/admin/products/' }] })
@Middleware({ requireAuth: true, routes: [{ method: 'post', path: '/admin/products/' }] })
export default class AttachProductSubscribersMiddleware implements MedusaMiddleware {
public consume(req: MedusaAuthenticatedRequest | Request, res: Response, next: NextFunction): void | Promise<void> {
MedusaUtils.attachOrReplaceEntitySubscriber(connection, UserSubscriber);
Expand Down Expand Up @@ -596,11 +596,11 @@ Here is the list of the provided decorators.
| `@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; routerOptions: MedusaRouteOptions[]; };`
| `@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> })
| `@OnMedusaEntityEvent.\*.\*(/*...*/)`| Can be used to send the right event type or register the handler to an event| `(entity: TEntity, { async? boolean; metatype?: Type<unknown> })`

# Contribute :ballot_box:

Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,7 @@ import {
} from 'medusa-extender';
import UserSubscriber from './product.subscriber';

@Middleware({ requireAuth: true, routerOptions: [{ method: 'post', path: '/admin/products/' }] })
@Middleware({ requireAuth: true, routes: [{ method: 'post', path: '/admin/products/' }] })
export default class AttachProductSubscribersMiddleware implements MedusaMiddleware {
public consume(req: MedusaAuthenticatedRequest | Request, res: Response, next: NextFunction): void | Promise<void> {
MedusaUtils.attachOrReplaceEntitySubscriber(connection, UserSubscriber);
Expand Down Expand Up @@ -598,11 +598,11 @@ Here is the list of the provided decorators.
| `@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; routerOptions: MedusaRouteOptions[]; };`
| `@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> })
| `@OnMedusaEntityEvent.\*.\*(/*...*/)`| Can be used to send the right event type or register the handler to an event| `(entity: TEntity, { async? boolean; metatype?: Type<unknown> })`

# Contribute :ballot_box:

Expand Down
11 changes: 5 additions & 6 deletions docs/classes/Medusa.Medusa-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@

[Medusa](../modules/Medusa.md).Medusa

Load medusa and apply all middlewares and migrations before registering the medusa
internal container and database connection.
Load medusa and apply all components

## Table of contents

Expand Down Expand Up @@ -37,7 +36,7 @@ internal container and database connection.

#### Defined in

[src/Medusa.ts:37](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/Medusa.ts#L37)
[src/Medusa.ts:36](https://github.com/adrien2p/medusa-extender/blob/56af3a5/src/Medusa.ts#L36)

## Properties

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

#### Defined in

[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/Medusa.ts#L30)
[src/Medusa.ts:29](https://github.com/adrien2p/medusa-extender/blob/56af3a5/src/Medusa.ts#L29)

___

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

#### Defined in

[src/Medusa.ts:31](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/Medusa.ts#L31)
[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/56af3a5/src/Medusa.ts#L30)

## Methods

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

#### Defined in

[src/Medusa.ts:45](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/Medusa.ts#L45)
[src/Medusa.ts:44](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L42)
[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L40)
[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L39)
[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L50)
[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L46)
[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L70)
[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L58)
[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L84)
[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L66)
[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L77)
[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L62)
[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L91)
[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/decorators/onMedusaEntityEvent.decorator.ts#L54)
[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/event-emmiter.ts#L21)
[src/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/event-emmiter.ts#L19)
[src/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/event-emmiter.ts#L80)
[src/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/event-emmiter.ts#L31)
[src/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/event-emmiter.ts#L43)
[src/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/event-emmiter.ts#L68)
[src/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/metadata-reader.ts#L5)
[src/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/utils.ts#L37)
[src/utils.ts:37](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/utils.ts#L68)
[src/utils.ts:68](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/utils.ts#L58)
[src/utils.ts:58](https://github.com/adrien2p/medusa-extender/blob/56af3a5/src/utils.ts#L58)

___

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

#### Defined in

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

___

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

#### Defined in

[src/utils.ts:102](https://github.com/adrien2p/medusa-extender/blob/ad977cf/src/utils.ts#L102)
[src/utils.ts:102](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/types.ts#L152)
[src/types.ts:152](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/types.ts#L6)
[src/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/constants.ts#L9)
[src/constants.ts:9](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/constants.ts#L14)
[src/constants.ts:14](https://github.com/adrien2p/medusa-extender/blob/56af3a5/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/ad977cf/src/constants.ts#L4)
[src/constants.ts:4](https://github.com/adrien2p/medusa-extender/blob/56af3a5/src/constants.ts#L4)
Loading