Skip to content

Commit 3a4eeb4

Browse files
authored
Merge pull request #73 from BrennenRocks/patch-1
A little English cleanup for Eden's overview.md
2 parents 0cf1de6 + 2741dc4 commit 3a4eeb4

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/plugins/eden/overview.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@ head:
77

88
- - meta
99
- name: 'og:description'
10-
content: Eden is an fetch client for an Elysia server with **end-to-end type safety** using only TypeScript's type inference instead of code generation. Allowing you to sync client and server types effortlessly. Eden is consists of 3 modules, "Eden Treaty", a simplified object-like client for communicating with Elysia server. "Eden Fn", call server function on frontend with auto-completion and full-type support. and "Eden Fetch", Fetch-like client for instant type-inference.
10+
content: Eden is a fetch client for an Elysia server with **end-to-end type safety** using only TypeScript's type inference instead of code generation. Allowing you to sync client and server types effortlessly. Eden consists of 3 modules, "Eden Treaty", a simplified object-like client for communicating with Elysia server. "Eden Fn", call server function on frontend with auto-completion and full-type support, and "Eden Fetch", a Fetch-like client for instant type-inference.
1111

1212
- - meta
1313
- name: 'og:description'
14-
content: Eden is an fetch client for an Elysia server with **end-to-end type safety** using only TypeScript's type inference instead of code generation. Allowing you to sync client and server types effortlessly. Eden is consists of 3 modules, "Eden Treaty", a simplified object-like client for communicating with Elysia server. "Eden Fn", call server function on frontend with auto-completion and full-type support. and "Eden Fetch", Fetch-like client for instant type-inference.
14+
content: Eden is a fetch client for an Elysia server with **end-to-end type safety** using only TypeScript's type inference instead of code generation. Allowing you to sync client and server types effortlessly. Eden consists of 3 modules, "Eden Treaty", a simplified object-like client for communicating with Elysia server. "Eden Fn", call server function on frontend with auto-completion and full-type support, and "Eden Fetch", a Fetch-like client for instant type-inference.
1515
---
1616

1717
# Eden
18-
Eden is an fetch client for an Elysia server with **end-to-end type safety** using only TypeScript's type inference instead of code generation.
18+
Eden is a fetch client for an Elysia server with **end-to-end type safety** using only TypeScript's type inference instead of code generation.
1919

20-
Allowing you to sync client and server types effortlessly, weight less than 2KB.
20+
Allowing you to sync client and server types effortlessly, weighing less than 2KB.
2121

2222
Eden is consists of 3 modules:
2323
- Eden Treaty: Simplified object-like client for communicating with Elysia server.
@@ -28,9 +28,9 @@ Eden is consists of 3 modules:
2828
Below is an overview, use-case and comparison for each module.
2929

3030
## Eden Treaty (Recommended)
31-
Eden Treaty is a object-like representation of an Elysia server, providing an end-to-end type safety, and significantly improved developer experience.
31+
Eden Treaty is an object-like representation of an Elysia server providing end-to-end type safety and a significantly improved developer experience.
3232

33-
With Eden Treaty, you can effortlessly connect Elysia server with full-type support and auto-completion, being confident code is free from type-error.
33+
With Eden Treaty you can effortlessly connect Elysia server with full-type support and auto-completion, being confident that code is free from type-error.
3434

3535
Example usage of Eden Treaty:
3636
```typescript
@@ -50,7 +50,7 @@ const { data: nendoroid, error } = await app.nendoroid.id['1895'].post({
5050
```
5151

5252
## Eden Fn
53-
Eden Fn allow you to expose backend functions to run on the frontend with end-to-end type-safety, autocompletion, original JsDoc comment, and "click-to-definition", allowing you to speed up your development cycle.
53+
Eden Fn allows you to expose backend functions to run on the frontend with end-to-end type-safety, autocompletion, original JsDoc comment, and "click-to-definition", allowing you to speed up your development cycle.
5454

5555
```typescript
5656
import { edenFn } from '@elysiajs/eden'
@@ -66,7 +66,7 @@ const data = await fn.prisma.user.create({
6666
})
6767
```
6868

69-
As for security concern, you can set allow or deny scopes, or check for authorization header to limit access to functions programatically.
69+
As for security concern, you can set allow or deny scopes or check for authorization header to limit access to functions programatically.
7070

7171
## Eden Fetch
7272
A fetch-like alternative to Eden Treaty with faster type inference.
@@ -88,7 +88,7 @@ const data = await fetch('/name/:name', {
8888
})
8989
```
9090

91-
Using Eden Treaty with complex type and lot of routes (more than 500 routes per server) on a low-end development device can lead to slow type inference and auto-completion.
91+
Using Eden Treaty with a complex type and lot of routes (more than 500 routes per server) on a low-end development device can lead to slow type inference and auto-completion.
9292

9393
Eden Fetch is an alternative and solution for fastest type inference possible while providing full type support like Eden Treaty.
9494

0 commit comments

Comments
 (0)