Skip to content

Commit c57bfdb

Browse files
committed
docs: remove reflect-metadata step
1 parent c4b2724 commit c57bfdb

File tree

5 files changed

+15
-49
lines changed

5 files changed

+15
-49
lines changed

README.MD

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ NPM ecosystem got a bad rep by encouraging intricate third-party dependencies fo
119119
120120
Reflet modules fully **own** their codebase. No direct third-party dependencies, only peer ones.
121121
122-
_e.g. [Reflet/express](./express) only asks for the necessary **peer** dependencies: `express`, `@types/express`, `@reflet/http`, `reflect-metadata`._
122+
_e.g. [Reflet/express](./express) only asks for the necessary **peer** dependencies: `express`, `@types/express`, `@reflet/http`._
123123
124124
### Integration-tested
125125

express/MIGRATION.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,5 @@
4040
Use the signature `(myMapper, [{ handler: myMiddleware, dedupe: true }])` instead of `(myMapper, myMiddleware, true)`.
4141

4242
* "@reflet/http" is now a required peer dependency.
43+
44+
* "reflect-metadata" is no longer needed as a peer dependency.

express/README.MD

Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -21,30 +21,11 @@ The **best** decorators for [Express](https://expressjs.com/). Have a look at [R
2121

2222
## Getting started
2323

24-
1. <details>
25-
<summary>Make sure you have decorators enabled. (click for details)</summary>
26-
<p>
24+
1. Enable experimental decorators in TypeScript compiler options.<br>_No need to install "reflect-metadata"._
2725

28-
* Enable them in your TypeScript compiler options.
29-
30-
```json
31-
"experimentalDecorators": true,
32-
```
33-
34-
* Install `reflect-metadata` shim.
35-
36-
```sh
37-
npm i reflect-metadata
38-
```
39-
40-
* Import the shim in your program before everything else.
41-
42-
```ts
43-
import 'reflect-metadata'
44-
```
45-
46-
</p>
47-
</details>
26+
```json
27+
"experimentalDecorators": true,
28+
```
4829

4930
2. Install the package along with peer dependencies.
5031

@@ -85,7 +66,6 @@ The **best** decorators for [Express](https://expressjs.com/). Have a look at [R
8566

8667
```ts
8768
// server.ts
88-
import 'reflect-metadata'
8969
import express from 'express'
9070
import { register } from '@reflet/express'
9171
import { ThingRouter } from './thing.router.ts'

mongoose/MIGRATION.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,7 @@
1010
* `PopulateVirtual` decorator has been renamed to `Virtual.Populate`.
1111
Its generics' order have also been switched: `Virtual.Populate<Local, Foreign>` instead of `Virtual.Populate<Foreign, Local>`
1212

13-
* Static methods of `Model.I` and `Model.interface` no longer have callback signatures.
13+
* Static methods of `Model.I` and `Model.interface` no longer have callback signatures.
14+
15+
* "reflect-metadata" is no longer needed as a peer dependency.
16+

mongoose/README.MD

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -24,30 +24,11 @@ The **best** decorators for [Mongoose](https://mongoosejs.com/). Have a look at
2424

2525
## Getting started
2626

27-
1. <details>
28-
<summary>Make sure you have decorators enabled. (click for details)</summary>
29-
<p>
27+
1. Enable experimental decorators in TypeScript compiler options.<br>_No need to install "reflect-metadata"._
3028

31-
* Enable them in your TypeScript compiler options.
32-
33-
```json
34-
"experimentalDecorators": true,
35-
```
36-
37-
* Install `reflect-metadata` shim.
38-
39-
```sh
40-
npm i reflect-metadata
41-
```
42-
43-
* Import the shim in your program before everything else.
44-
45-
```ts
46-
import 'reflect-metadata'
47-
```
48-
49-
</p>
50-
</details>
29+
```json
30+
"experimentalDecorators": true,
31+
```
5132

5233
2. Install the package along with peer dependencies.
5334

0 commit comments

Comments
 (0)