Skip to content

Commit 716b6b4

Browse files
committed
docs: correct grammatical errors
1 parent 477195f commit 716b6b4

File tree

15 files changed

+54
-54
lines changed

15 files changed

+54
-54
lines changed

docs/at-glance.md

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

88
- - meta
99
- name: 'description'
10-
content: Designed with ergonomic design, extensive support for TypeScript, modern JavaScript API, optimized for Bun. Offers a unique experience unified type, and end-to-end type safety while maintaining excellent performance.
10+
content: Designed with ergonomic design, extensive support for TypeScript, modern JavaScript API, optimized for Bun. Offers a unique experience with unified types, and end-to-end type safety while maintaining excellent performance.
1111

1212
- - meta
1313
- property: 'og:description'
14-
content: Designed with ergonomic design, extensive support for TypeScript, modern JavaScript API, optimized for Bun. Offers a unique experience unified type, and end-to-end type safety while maintaining excellent performance.
14+
content: Designed with ergonomic design, extensive support for TypeScript, modern JavaScript API, optimized for Bun. Offers a unique experience with unified types, and end-to-end type safety while maintaining excellent performance.
1515
---
1616

1717
<script setup>

docs/eden/overview.md

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

88
- - meta
99
- name: 'description'
10-
content: Elysia supports end-to-end type safety with Elysia Eden since start. End-to-end type-safety refers to a system in which every component of the system is checked for type consistency, meaning that data is passed between components only if the types of the data are compatible.
10+
content: Elysia supports end-to-end type safety with Elysia Eden from the start. End-to-end type-safety refers to a system in which every component of the system is checked for type consistency, meaning that data is passed between components only if the types of the data are compatible.
1111

1212
- - meta
1313
- property: 'og:description'
14-
content: Elysia supports end-to-end type safety with Elysia Eden since start. End-to-end type-safety refers to a system in which every component of the system is checked for type consistency, meaning that data is passed between components only if the types of the data are compatible.
14+
content: Elysia supports end-to-end type safety with Elysia Eden from the start. End-to-end type-safety refers to a system in which every component of the system is checked for type consistency, meaning that data is passed between components only if the types of the data are compatible.
1515
---
1616

1717
# End-to-End Type Safety
@@ -23,14 +23,14 @@ End-to-end type safety is like making sure all the pieces of the track match up
2323

2424
For a framework to have end-to-end type safety means you can connect client and server in a type-safe manner.
2525

26-
Elysia provide end-to-end type safety **without code generation** out of the box with RPC-like connector, **Eden**
26+
Elysia provides end-to-end type safety **without code generation** out of the box with an RPC-like connector, **Eden**
2727

2828
<video mute controls>
2929
<source src="/eden/eden-treaty.mp4" type="video/mp4" />
3030
Something went wrong trying to load video
3131
</video>
3232

33-
Others framework that support e2e type safety:
33+
Other frameworks that support e2e type safety:
3434
- tRPC
3535
- Remix
3636
- SvelteKit
@@ -52,20 +52,20 @@ Hover over variable and function to see type definition.
5252
Elysia allows you to change the type on the server and it will be instantly reflected on the client, helping with auto-completion and type-enforcement.
5353

5454
## Eden
55-
Eden is a RPC-like client to connect Elysia **end-to-end type safety** using only TypeScript's type inference instead of code generation.
55+
Eden is an RPC-like client to connect Elysia with **end-to-end type safety** using only TypeScript's type inference instead of code generation.
5656

57-
Allowing you to sync client and server types effortlessly, weighing less than 2KB.
57+
It allows you to sync client and server types effortlessly, weighing less than 2KB.
5858

59-
Eden is consists of 2 modules:
59+
Eden consists of 2 modules:
6060
1. Eden Treaty **(recommended)**: an improved version RFC version of Eden Treaty
61-
2. Eden Fetch: Fetch-like client with type safety.
61+
2. Eden Fetch: Fetch-like client with type safety
6262

6363
Below is an overview, use-case and comparison for each module.
6464

6565
## Eden Treaty (Recommended)
6666
Eden Treaty is an object-like representation of an Elysia server providing end-to-end type safety and a significantly improved developer experience.
6767

68-
With Eden Treaty we can connect interact Elysia server with full-type support and auto-completion, error handling with type narrowing, and creating type safe unit test.
68+
With Eden Treaty we can interact with an Elysia server with full-type support and auto-completion, error handling with type narrowing, and create type-safe unit tests.
6969

7070
Example usage of Eden Treaty:
7171
```typescript twoslash
@@ -131,5 +131,5 @@ const { data } = await fetch('/name/:name', {
131131
```
132132

133133
::: tip NOTE
134-
Unlike Eden Treaty, Eden Fetch doesn't provide Web Socket implementation for Elysia server
134+
Unlike Eden Treaty, Eden Fetch doesn't provide Web Socket implementation for Elysia server.
135135
:::

docs/essential/handler.md

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

88
- - meta
99
- name: 'description'
10-
content: handler is a function that responds to the request for each route. Accepting request information and returning a response to the client. Handler can be registered through Elysia.get / Elysia.post
10+
content: A handler is a function that responds to the request for each route. Accepting request information and returning a response to the client. Handler can be registered through Elysia.get / Elysia.post
1111

1212
- - meta
1313
- property: 'og:description'
14-
content: handler is a function that responds to the request for each route. Accepting request information and returning a response to the client. Handler can be registered through Elysia.get / Elysia.post
14+
content: A handler is a function that responds to the request for each route. Accepting request information and returning a response to the client. Handler can be registered through Elysia.get / Elysia.post
1515
---
1616

1717
<script setup>
@@ -87,11 +87,11 @@ const demo7 = new Elysia()
8787

8888
# Handler
8989

90-
Handler is a function that responds to the request for each route.
90+
A handler is a function that responds to the request for each route.
9191

9292
Accepting request information and returning a response to the client.
9393

94-
Altenatively, handler is also known as a **Controller** in other frameworks.
94+
Alternatively, a handler is also known as a **Controller** in other frameworks.
9595

9696
```typescript
9797
import { Elysia } from 'elysia'

docs/essential/life-cycle.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,13 @@ const demo = new Elysia()
3737

3838
# Lifecycle
3939

40-
Life Cycle allows us to intercept an important event at the predefined point allowing us to customize the behavior of our server as needed.
40+
Life Cycle allows us to intercept important events at predefined points, allowing us to customize the behavior of our server as needed.
4141

4242
Elysia's Life Cycle event can be illustrated as the following.
4343
![Elysia Life Cycle Graph](/assets/lifecycle-chart.svg)
4444
> Click on image to enlarge
4545
46-
Below are the request life cycle available in Elysia:
46+
Below are the request life cycles available in Elysia:
4747

4848
<Deck>
4949
<Card title="Request" href="#request">

docs/essential/validation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ TypeBox is a very fast, lightweight, and type-safe runtime validation library fo
9191
We believe that validation should be handled by the framework natively, rather than relying on the user to set up a custom type for every project.
9292

9393
### TypeScript
94-
We can get a type definitions of every Elysia/TypeBox's type by accessing `static` property as follows:
94+
We can get type definitions of every Elysia/TypeBox's type by accessing the `static` property as follows:
9595

9696
```ts twoslash
9797
import { t } from 'elysia'

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ head:
99

1010
- - meta
1111
- name: 'description'
12-
content: Elysia is an ergonomic framework for Humans. With end-to-end type safety and great developer experience. Elysia is familiar, fast, and first class TypeScript support with well-thought integration between services whether it's tRPC, Swagger or WebSocket. Elysia got you covered, start building next generation TypeScript web servers today.
12+
content: Elysia is an ergonomic framework for Humans. With end-to-end type safety and great developer experience. Elysia is familiar, fast, and has first-class TypeScript support with well-thought integration between services whether it's tRPC, Swagger or WebSocket. Elysia has got you covered, start building next generation TypeScript web servers today.
1313

1414
- - meta
1515
- property: 'og:description'
16-
content: Elysia is an ergonomic framework for Humans. With end-to-end type safety and great developer experience. Elysia is familiar, fast, and first class TypeScript support with well-thought integration between services whether it's tRPC, Swagger or WebSocket. Elysia got you covered, start building next generation TypeScript web servers today.
16+
content: Elysia is an ergonomic framework for Humans. With end-to-end type safety and great developer experience. Elysia is familiar, fast, and has first-class TypeScript support with well-thought integration between services whether it's tRPC, Swagger or WebSocket. Elysia has got you covered, start building next generation TypeScript web servers today.
1717
---
1818

1919
<script setup>

docs/integrations/nextjs.md

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

88
- - meta
99
- name: 'description'
10-
content: With Nextjs App Router, you can run Elysia on Nextjs route. Elysia will work normally as expected because of WinterCG compliance.
10+
content: With Next.js App Router, you can run Elysia on Next.js routes. Elysia will work normally as expected because of WinterCG compliance.
1111

1212
- - meta
1313
- property: 'og:description'
14-
content: With Nextjs App Router, you can run Elysia on Nextjs route. Elysia will work normally as expected because of WinterCG compliance.
14+
content: With Next.js App Router, you can run Elysia on Next.js routes. Elysia will work normally as expected because of WinterCG compliance.
1515
---
1616

17-
# Integration with Nextjs
17+
# Integration with Next.js
1818

19-
With Nextjs App Router, we can run Elysia on Nextjs route.
19+
With Next.js App Router, we can run Elysia on Next.js routes.
2020

2121
1. Create **api/[[...slugs]]/route.ts** inside app router
2222
2. In **route.ts**, create or import an existing Elysia server
@@ -38,13 +38,13 @@ export const GET = app.handle // [!code ++]
3838
export const POST = app.handle // [!code ++]
3939
```
4040

41-
Elysia will work normally as expected because of WinterCG compliance, however, some plugins like **Elysia Static** may not work if you are running Nextjs on Node.
41+
Elysia will work normally as expected because of WinterCG compliance, however, some plugins like **Elysia Static** may not work if you are running Next.js on Node.
4242

43-
You can treat the Elysia server as a normal Nextjs API route.
43+
You can treat the Elysia server as a normal Next.js API route.
4444

4545
With this approach, you can have co-location of both frontend and backend in a single repository and have [End-to-end type safety with Eden](https://elysiajs.com/eden/overview.html) with both client-side and server action
4646

47-
Please refer to [Nextjs Route Handlers](https://nextjs.org/docs/app/building-your-application/routing/route-handlers#static-route-handlers) for more information.
47+
Please refer to [Next.js Route Handlers](https://nextjs.org/docs/app/building-your-application/routing/route-handlers#static-route-handlers) for more information.
4848

4949
## Prefix
5050

docs/integrations/openapi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ const app = new Elysia()
3333
.use(swagger())
3434
```
3535

36-
By default, Elysia use OpenAPI V3 schema and [Scalar UI](http://scalar.com) by default
36+
By default, Elysia uses OpenAPI V3 schema and [Scalar UI](http://scalar.com)
3737

3838
For Swagger plugin configuration, see the [Swagger plugin page](/plugins/swagger).
3939

4040
## Route definitions
4141
We add route information by providing a schema type.
4242

43-
However, sometime defining a type only isn't clear what the route might work. You can use `schema.detail` fields to explictly define what the route is all about.
43+
However, sometimes defining only a type does not make it clear about what the route might do. You can use `schema.detail` fields to explicitly define what the route is all about.
4444

4545
```typescript
4646
import { Elysia, t } from 'elysia'
@@ -77,7 +77,7 @@ Detail is then passed to Swagger to put the description to Swagger route.
7777

7878
The detail field is an object that can be use to describe information about the route for API documentation.
7979

80-
Which may contains the following fields:
80+
It may contain the following fields:
8181

8282
### tags
8383
An array of tags for the operation. Tags can be used for logical grouping of operations by resources or any other qualifier.

docs/key-concept.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Although Elysia is a simple library, it has some key concepts that you need to u
2121
This page covers most important concepts of Elysia that you should know.
2222

2323
::: tip
24-
We __highly recommend__ you to read this page before learn more about Elysia.
24+
We __highly recommend__ you to read this page before learning more about Elysia.
2525
:::
2626

2727
## Everything is a component

docs/migrate/from-express.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ head:
1313

1414
- - meta
1515
- name: 'description'
16-
content: This guide is for Express users who want to see a differences from Express including syntax, and how to migrate your application from Express to Elysia by example.
16+
content: This guide is for Express users who want to see the differences from Express including syntax, and how to migrate your application from Express to Elysia by example.
1717

1818
- - meta
1919
- property: 'og:description'
20-
content: This guide is for Express users who want to see a differences from Express including syntax, and how to migrate your application from Express to Elysia by example.
20+
content: This guide is for Express users who want to see the differences from Express including syntax, and how to migrate your application from Express to Elysia by example.
2121
---
2222

2323
<script setup>
@@ -30,11 +30,11 @@ import Benchmark from '../components/fern/benchmark-express.vue'
3030

3131
# From Express to Elysia
3232

33-
This guide is for Express users who want to see a differences from Express including syntax, and how to migrate your application from Express to Elysia by example.
33+
This guide is for Express users who want to see the differences from Express including syntax, and how to migrate your application from Express to Elysia by example.
3434

3535
**Express** is a popular web framework for Node.js, and widely used for building web applications and APIs. It is known for its simplicity and flexibility.
3636

37-
**Elysia** is an ergonomic web framework for Bun, Node.js, and runtime that support Web Standard API. Designed to be ergonomic and developer-friendly with a focus on **sounds type safety** and performance.
37+
**Elysia** is an ergonomic web framework for Bun, Node.js, and runtimes that support Web Standard API. Designed to be ergonomic and developer-friendly with a focus on **sound type safety** and performance.
3838

3939
## Performance
4040
Elysia has significant performance improvements over Express thanks to native Bun implementation, and static code analysis.
@@ -43,7 +43,7 @@ Elysia has significant performance improvements over Express thanks to native Bu
4343

4444
## Routing
4545

46-
Express and Elysia has similar routing syntax, using `app.get()` and `app.post()` methods to define routes and similar path parameters syntax.
46+
Express and Elysia have similar routing syntax, using `app.get()` and `app.post()` methods to define routes and similar path parameter syntax.
4747

4848
<Compare>
4949

0 commit comments

Comments
 (0)