Skip to content

Commit

Permalink
docs: Update links
Browse files Browse the repository at this point in the history
  • Loading branch information
@adrien2p
adrien2p committed Mar 20, 2022
1 parent f7e05f2 commit ab76711
Show file tree
Hide file tree
Showing 60 changed files with 238 additions and 210 deletions.
34 changes: 31 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,43 @@

* [Introduction](#introduction)
* [Getting started :rocket:](#getting-started-rocket)
* [CLI `medex`](#cli-medex)
* [Existing medusa project](#existing-medusa-project)
* [From server starter](#from-server-starter)
* [Features :monocle_face:](#features-monocle_face)
* [Non exhaustive list](#non-exhaustive-list)
* [Directory Architecture](#directory-architecture)
* [Documentation](https://adrien2p.github.io/medusa-extender/)
* [Internal modules (Optional)](https://adrien2p.github.io/medusa-extender/#/?id=internal-modules)
* [CLI `medex`](#cli-medex)
* [Commands references](https://adrien2p.github.io/medusa-extender/#/?id=commands-references)
* [Command `generate` reference](https://adrien2p.github.io/medusa-extender/#/?id=command-generate-reference)
* [Usage](https://adrien2p.github.io/medusa-extender/#/?id=usage)
* [Options](https://adrien2p.github.io/medusa-extender/#/?id=options)
* [Examples](https://adrien2p.github.io/medusa-extender/#/?id=examples)
* [Command `migrate` reference](https://adrien2p.github.io/medusa-extender/#/?id=command-migrate-reference)
* [Usage](https://adrien2p.github.io/medusa-extender/#/?id=usage-1)
* [Options](https://adrien2p.github.io/medusa-extender/#/?id=options-1)
* [Full code API :mag:](https://adrien2p.github.io/medusa-extender/#/?id=full-code-api-mag)
* [API documentation :bulb:](https://adrien2p.github.io/medusa-extender/#/?id=api-documentation-bulb)
* [Decorators](https://adrien2p.github.io/medusa-extender/#/?id=decorators)
* [@Entity](https://adrien2p.github.io/medusa-extender/#/?id=entity)
* [@Repository](https://adrien2p.github.io/medusa-extender/#/?id=repository)
* [@Migration](https://adrien2p.github.io/medusa-extender/#/?id=migration)
* [@Service](https://adrien2p.github.io/medusa-extender/#/?id=service)
* [@Middleware](https://adrien2p.github.io/medusa-extender/#/?id=middleware)
* [@Router](https://adrien2p.github.io/medusa-extender/#/?id=router)
* [@Validator](https://adrien2p.github.io/medusa-extender/#/?id=validator)
* [@Module](https://adrien2p.github.io/medusa-extender/#/?id=module)
* [@Module (Dynamic module)](https://adrien2p.github.io/medusa-extender/#/?id=module-dynamic-module)
* [@OnMedusaEntityEvent](https://adrien2p.github.io/medusa-extender/#/?id=onmedusaentityevent)
* [Utilities :wrench:](https://adrien2p.github.io/medusa-extender/#/?id=utilities-wrench)
* [attachOrReplaceEntitySubscriber](https://adrien2p.github.io/medusa-extender/#/?id=attachorreplaceentitysubscriber)
* [repositoryMixin](https://adrien2p.github.io/medusa-extender/#/?id=repositorymixin)
* [Omit](https://adrien2p.github.io/medusa-extender/#/?id=omit)
* [Starters](https://adrien2p.github.io/medusa-extender/#/?id=starters)
* [Internal modules (Optional)](https://adrien2p.github.io/medusa-extender/#/?id=internal-modules-optional)
* [Monitoring](https://adrien2p.github.io/medusa-extender/#/?id=monitoring)
* [Multi-tenancy](https://adrien2p.github.io/medusa-extender/#/?id=multi-tenancy)
* [Resources](#resources)
* [Marketplace tutorial](#marketplace-tutorial)
* [Discussions](#discussions)
* [Like my work? :heartbeat:](#like-my-work-heartbeat)
* [Contribute](#contribute)
Expand Down
32 changes: 16 additions & 16 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,22 +156,22 @@ That's it, your server is now up and running :rocket:

Here is a list of the features that you can find in that package

- [Create or extend an entity](https://adrien2p.github.io/medusa-extender/#/?id=decorators)
- [Create or extend a repository](https://adrien2p.github.io/medusa-extender/#/?id=decorators)
- [Create or extend a service](https://adrien2p.github.io/medusa-extender/#/?id=decorators)
- [Create middleware before or after medusa authentication strategy](https://adrien2p.github.io/medusa-extender/#/?id=decorators)
- [Create new migrations](https://adrien2p.github.io/medusa-extender/#/?id=decorators)
- [Create new router handler](https://adrien2p.github.io/medusa-extender/#/?id=decorators)
- [Extend validators from medusa to includes custom fields](https://adrien2p.github.io/medusa-extender/#/?id=decorators)
- [Emit entity subscribers events](https://adrien2p.github.io/medusa-extender/#/?id=decorators)
- [Group your component by module](https://adrien2p.github.io/medusa-extender/#/?id=module)
- [Register component dynamically with dynamic module](https://adrien2p.github.io/medusa-extender/#/?id=module-dynamic-module)
- [Listen to entity subscribers and handle them wherever you want](https://adrien2p.github.io/medusa-extender/#/?id=decorators)
- [CLI](https://adrien2p.github.io/medusa-extender/#/?id=cli-medex)
- [Generate new components](https://adrien2p.github.io/medusa-extender/#/?id=cli-medex)
- [Migrate your data](https://adrien2p.github.io/medusa-extender/#/?id=cli-medex)
- [Monitoring `(Optional module)`](https://adrien2p.github.io/medusa-extender/#/?id=monitoring)
- [Multi-tenancy architecture `(Optional module)`](#https://adrien2p.github.io/medusa-extender/#/?id=multi-tenancy)
- [Create or extend an entity](#decorators)
- [Create or extend a repository](#decorators)
- [Create or extend a service](#decorators)
- [Create middleware before or after medusa authentication strategy](#decorators)
- [Create new migrations](#decorators)
- [Create new router handler](#decorators)
- [Extend validators from medusa to includes custom fields](#decorators)
- [Emit entity subscribers events](#decorators)
- [Group your component by module](#module)
- [Register component dynamically with dynamic module](#module-dynamic-module)
- [Listen to entity subscribers and handle them wherever you want](#decorators)
- [CLI](#cli-medex)
- [Generate new components](#cli-medex)
- [Migrate your data](#cli-medex)
- [Monitoring `(Optional module)`](#monitoring)
- [Multi-tenancy architecture `(Optional module)`](#multi-tenancy)

All those features aims to help you build what you want such as

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

#### Defined in

[src/Medusa.ts:39](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/Medusa.ts#L39)
[src/Medusa.ts:39](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/Medusa.ts#L39)

## Properties

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

#### Defined in

[src/Medusa.ts:32](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/Medusa.ts#L32)
[src/Medusa.ts:32](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/Medusa.ts#L32)

___

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

#### Defined in

[src/Medusa.ts:33](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/Medusa.ts#L33)
[src/Medusa.ts:33](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/Medusa.ts#L33)

## Methods

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

#### Defined in

[src/Medusa.ts:47](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/Medusa.ts#L47)
[src/Medusa.ts:47](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/Medusa.ts#L47)
2 changes: 1 addition & 1 deletion docs/classes/core_componentMap.ComponentMap.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ Map.get

#### Defined in

[src/core/componentMap.ts:4](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/componentMap.ts#L4)
[src/core/componentMap.ts:4](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/componentMap.ts#L4)
12 changes: 6 additions & 6 deletions docs/classes/core_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/core/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/event-emmiter.ts#L21)
[src/core/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/event-emmiter.ts#L21)

## Properties

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

#### Defined in

[src/core/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/event-emmiter.ts#L19)
[src/core/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/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/core/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/event-emmiter.ts#L80)
[src/core/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/event-emmiter.ts#L80)

___

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

#### Defined in

[src/core/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/event-emmiter.ts#L31)
[src/core/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/event-emmiter.ts#L31)

___

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

#### Defined in

[src/core/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/event-emmiter.ts#L43)
[src/core/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/event-emmiter.ts#L43)

___

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

#### Defined in

[src/core/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/event-emmiter.ts#L68)
[src/core/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/event-emmiter.ts#L68)
26 changes: 13 additions & 13 deletions docs/classes/core_logger.Logger.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Internal logger to display information about the build.

#### Defined in

[src/core/logger.ts:20](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/logger.ts#L20)
[src/core/logger.ts:20](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/logger.ts#L20)

## Properties

Expand All @@ -59,7 +59,7 @@ Internal logger to display information about the build.

#### Defined in

[src/core/logger.ts:10](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/logger.ts#L10)
[src/core/logger.ts:10](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/logger.ts#L10)

___

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

#### Defined in

[src/core/logger.ts:9](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/logger.ts#L9)
[src/core/logger.ts:9](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/logger.ts#L9)

___

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

#### Defined in

[src/core/logger.ts:8](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/logger.ts#L8)
[src/core/logger.ts:8](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/logger.ts#L8)

## Accessors

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

#### Defined in

[src/core/logger.ts:16](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/logger.ts#L16)
[src/core/logger.ts:16](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/logger.ts#L16)

___

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

#### Defined in

[src/core/logger.ts:12](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/logger.ts#L12)
[src/core/logger.ts:12](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/logger.ts#L12)

## Methods

Expand All @@ -131,7 +131,7 @@ Build logs taking in count the level color

#### Defined in

[src/core/logger.ts:89](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/logger.ts#L89)
[src/core/logger.ts:89](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/logger.ts#L89)

___

Expand All @@ -154,7 +154,7 @@ Display error logs in red immediately

#### Defined in

[src/core/logger.ts:66](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/logger.ts#L66)
[src/core/logger.ts:66](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/logger.ts#L66)

___

Expand All @@ -170,7 +170,7 @@ display all queues logs and then reset the queue.

#### Defined in

[src/core/logger.ts:73](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/logger.ts#L73)
[src/core/logger.ts:73](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/logger.ts#L73)

___

Expand All @@ -193,7 +193,7 @@ Display log immediately.

#### Defined in

[src/core/logger.ts:48](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/logger.ts#L48)
[src/core/logger.ts:48](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/logger.ts#L48)

___

Expand All @@ -216,7 +216,7 @@ Push new logs to queue and then show them later on.

#### Defined in

[src/core/logger.ts:34](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/logger.ts#L34)
[src/core/logger.ts:34](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/logger.ts#L34)

___

Expand All @@ -239,7 +239,7 @@ Display warning immediately.

#### Defined in

[src/core/logger.ts:57](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/logger.ts#L57)
[src/core/logger.ts:57](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/logger.ts#L57)

___

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

#### Defined in

[src/core/logger.ts:25](https://github.com/adrien2p/medusa-extender/blob/45a826d/src/core/logger.ts#L25)
[src/core/logger.ts:25](https://github.com/adrien2p/medusa-extender/blob/f7e05f2/src/core/logger.ts#L25)
Loading

0 comments on commit ab76711

Please sign in to comment.