Skip to content

Commit cb2ba8c

Browse files
committed
docs: update README
1 parent 510f3c3 commit cb2ba8c

File tree

2 files changed

+7
-37
lines changed

2 files changed

+7
-37
lines changed

README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
# MidwayJS & DataLoader
22

3-
Guidance on DataLoader integration with MidwayJS.
3+
Guidance on [DataLoader](https://github.com/graphql/dataloader) integration with [MidwayJS](https://github.com/midwayjs/midway).
44

5-
> Note: All examples are created upon TypeGraphQL, for TypeGraphQL usage in MidwayJS application, see [midway-examples](https://github.com/midwayjs/midway-examples/tree/master/v2/demo-graphql).
5+
> **Note: All examples are created upon [TypeGraphQL](https://typegraphql.com/), for information about TypeGraphQL + MidwayJS, see [midway-examples: graphql](https://github.com/midwayjs/midway-examples/tree/master/v2/demo-graphql).**
66
>
7-
> Note: If you're also using Prisma2 in your application, then no extra DataLoader setup is needed because since Prisma 2 a [built-in DataLoader implemention](https://github.com/prisma/prisma/blob/2.21.x/src/packages/client/src/runtime/Dataloader.ts) was included.
7+
> **Note: If you're also using Prisma2 in your application, no extra DataLoader setup is needed because since Prisma2, a [built-in DataLoader implemention](https://github.com/prisma/prisma/blob/2.24.x/src/packages/client/src/runtime/Dataloader.ts) was included.**
88
99
## Implementions
1010

11-
> TODO: AD/DISAD VANTAGES on each implemen
11+
- [x] Register DataLoader instances with **Batch Loader Functions** by TypeGraphQL middleware, manually.
12+
- [x] Register DataLoader instances with **Service(like TypeORM findByIds)** by TypeGraphQL middleware, manually.
13+
- Check [register-batchloader-manually](./src/lib/register-batchloader-manually.ts) for more details.
1214

13-
- [x] Register DataLoader instances with **Plain Functions** by TypeGraphQL middleware, manually.
14-
- [x] Register DataLoader instances with **Service(TypeORM findByIds)** by TypeGraphQL middleware, manually.
1515
- [x] Register DataLoader instances with **TypeORM Relation Metadata** by TypeGraphQL middleware, automatically.
16-
- [x] Register DataLoader instances with **Provided batchLoadFn** by MidwayJS interceptors, with custom decorator.
17-
- [ ] Register DataLoader instances with **TypeORM Relation Metadata** by TypeGraphQL middleware, automatically.
16+
- [x] Register DataLoader instances with **TypeORM Relation Metadata** by TypeGraphQL middleware, automatically. ([type-graphql-dataloader](type-graphql-dataloader) under the hood.)

README.zh-CN.md

-29
This file was deleted.

0 commit comments

Comments
 (0)